Interface OffscreenCanvas

interface OffscreenCanvas {
    height: number;
    oncontextlost: ((this, ev) => any);
    oncontextrestored: ((this, ev) => any);
    width: number;
    addEventListener<K>(type, listener, options?): void;
    addEventListener(type, listener, options?): void;
    dispatchEvent(event): boolean;
    getContext(contextId, options?): OffscreenRenderingContext;
    removeEventListener<K>(type, listener, options?): void;
    removeEventListener(type, listener, options?): void;
    transferToImageBitmap(): ImageBitmap;
}

Hierarchy

  • EventTarget
    • OffscreenCanvas

Properties

height oncontextlost oncontextrestored width

Methods

addEventListener dispatchEvent getContext removeEventListener transferToImageBitmap

Properties

height

height: number

These attributes return the dimensions of the OffscreenCanvas object's bitmap.

They can be set, to replace the bitmap with a new, transparent black bitmap of the specified dimensions (effectively resizing it).

oncontextlost

oncontextlost: ((this, ev) => any)

Type declaration

oncontextrestored

oncontextrestored: ((this, ev) => any)

Type declaration

width

width: number

These attributes return the dimensions of the OffscreenCanvas object's bitmap.

They can be set, to replace the bitmap with a new, transparent black bitmap of the specified dimensions (effectively resizing it).

Methods

addEventListener

  • addEventListener<K>(type, listener, options?): void

  • Type Parameters

    Parameters

    Returns void

  • addEventListener(type, listener, options?): void

  • Parameters

    Returns void

dispatchEvent

  • dispatchEvent(event): boolean

  • Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

    Parameters

    • event: Event

    Returns boolean

getContext

  • getContext(contextId, options?): OffscreenRenderingContext

  • Returns an object that exposes an API for drawing on the OffscreenCanvas object. contextId specifies the desired API: "2d", "bitmaprenderer", "webgl", or "webgl2". options is handled by that API.

    This specification defines the "2d" context below, which is similar but distinct from the "2d" context that is created from a canvas element. The WebGL specifications define the "webgl" and "webgl2" contexts. [WEBGL]

    Returns null if the canvas has already been initialized with another context type (e.g., trying to get a "2d" context after getting a "webgl" context).

    Parameters

    Returns OffscreenRenderingContext

removeEventListener

  • removeEventListener<K>(type, listener, options?): void

  • Type Parameters

    Parameters

    Returns void

  • removeEventListener(type, listener, options?): void

  • Parameters

    Returns void

transferToImageBitmap

  • transferToImageBitmap(): ImageBitmap

  • Returns a newly created ImageBitmap object with the image in the OffscreenCanvas object. The image in the OffscreenCanvas object is replaced with a new blank image.

    Returns ImageBitmap

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc