Interface ICanvasMediaStaticProps

Static properties for the CanvasMedia class.

interface ICanvasMediaStaticProps {
    __staticProp?: true;
    append?: boolean;
    autoRenderVideo?: boolean;
    container?: null | HTMLElement;
    media:
        | HTMLImageElement
        | HTMLCanvasElement
        | HTMLVideoElement
        | Canvas<
            ICanvasCallbacksMap<ICanvasMutableProps>,
            ICanvasStaticProps,
            ICanvasMutableProps,
        >
        | SVGImageElement;
    resizeDebounce?: number;
    resizeOnInit?: boolean;
    resizeOnRuntime?: boolean;
    viewportTarget?: keyof IViewportCallbacksMap;
}

Hierarchy (View Summary)

Properties

__staticProp? append? autoRenderVideo? container? media resizeDebounce? resizeOnInit? resizeOnRuntime? viewportTarget?

Properties

Optional__staticProp

__staticProp?: true

Optionalappend

append?: boolean

If true, appends the canvas to the container. Ignored if container is null.

Default

true

OptionalautoRenderVideo

autoRenderVideo?: boolean

If true, video elements will automatically render on each frame update.

Default

true

Optionalcontainer

container?: null | HTMLElement

Parent element used to determine canvas size. If null, it uses the viewport.

Default

null

media

media:
    | HTMLImageElement
    | HTMLCanvasElement
    | HTMLVideoElement
    | Canvas<
        ICanvasCallbacksMap<ICanvasMutableProps>,
        ICanvasStaticProps,
        ICanvasMutableProps,
    >
    | SVGImageElement

The media element to be rendered. Accepts a Canvas instance or common media elements like images and videos.

OptionalresizeDebounce

resizeDebounce?: number

Debounce time (ms) for resize handling.

Default

0

OptionalresizeOnInit

resizeOnInit?: boolean

Automatically adjusts canvas size on initialization.

Default

true

OptionalresizeOnRuntime

resizeOnRuntime?: boolean

Enables dynamic resizing based on viewport or container changes.

Default

false

OptionalviewportTarget

viewportTarget?: keyof IViewportCallbacksMap

Defines which dimension(s) should trigger a resize.

Default

'any'

Settings

Member Visibility

On This Page

Properties