OffscreenCanvas | Babylon.js API documentation

Interface OffscreenCanvas

interface OffscreenCanvas {
    height: number;
    oncontextlost: null | (this: OffscreenCanvas, ev: Event) => any;
    oncontextrestored: null | (this: OffscreenCanvas, ev: Event) => any;
    width: number;
    addEventListener<K extends keyof OffscreenCanvasEventMap>(
        type: K,
        listener: (this: OffscreenCanvas, ev: OffscreenCanvasEventMap[K]) => any,
        options?: boolean | AddEventListenerOptions,
    ): void;
    addEventListener(
        type: string,
        listener: EventListenerOrEventListenerObject,
        options?: boolean | AddEventListenerOptions,
    ): void;
    addEventListener<K extends keyof OffscreenCanvasEventMap>(
        type: K,
        listener: (this: OffscreenCanvas, ev: OffscreenCanvasEventMap[K]) => any,
        options?: boolean | AddEventListenerOptions,
    ): void;
    addEventListener(
        type: string,
        listener: EventListenerOrEventListenerObject,
        options?: boolean | AddEventListenerOptions,
    ): void;
    convertToBlob(options?: ImageEncodeOptions): Promise<Blob>;
    convertToBlob(options?: ImageEncodeOptions): Promise<Blob>;
    getContext(
        contextId: "2d",
        options?: any,
    ): null | OffscreenCanvasRenderingContext2D;
    getContext(
        contextId: "bitmaprenderer",
        options?: any,
    ): null | ImageBitmapRenderingContext;
    getContext(contextId: "webgl", options?: any): null | WebGLRenderingContext;
    getContext(
        contextId: "webgl2",
        options?: any,
    ): null | WebGL2RenderingContext;
    getContext(
        contextId: OffscreenRenderingContextId,
        options?: any,
    ): null | OffscreenRenderingContext;
    getContext(
        contextId: "2d",
        options?: any,
    ): null | OffscreenCanvasRenderingContext2D;
    getContext(
        contextId: "bitmaprenderer",
        options?: any,
    ): null | ImageBitmapRenderingContext;
    getContext(contextId: "webgl", options?: any): null | WebGLRenderingContext;
    getContext(
        contextId: "webgl2",
        options?: any,
    ): null | WebGL2RenderingContext;
    getContext(
        contextId: OffscreenRenderingContextIdBJS,
        options?: any,
    ): null | OffscreenRenderingContextBJS;
    removeEventListener<K extends keyof OffscreenCanvasEventMap>(
        type: K,
        listener: (this: OffscreenCanvas, ev: OffscreenCanvasEventMap[K]) => any,
        options?: boolean | EventListenerOptions,
    ): void;
    removeEventListener(
        type: string,
        listener: EventListenerOrEventListenerObject,
        options?: boolean | EventListenerOptions,
    ): void;
    removeEventListener<K extends keyof OffscreenCanvasEventMap>(
        type: K,
        listener: (this: OffscreenCanvas, ev: OffscreenCanvasEventMap[K]) => any,
        options?: boolean | EventListenerOptions,
    ): void;
    removeEventListener(
        type: string,
        listener: EventListenerOrEventListenerObject,
        options?: boolean | EventListenerOptions,
    ): void;
    transferToImageBitmap(): ImageBitmap;
    transferToImageBitmap(): ImageBitmap;
}

Hierarchy

EventTarget
- OffscreenCanvas

Index

Properties

height oncontextlost oncontextrestored width

Methods

addEventListener convertToBlob 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).

MDN Reference

oncontextlost

oncontextlost: null | (this: OffscreenCanvas, ev: Event) => any

oncontextrestored

oncontextrestored: null | (this: OffscreenCanvas, ev: Event) => any

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).

MDN Reference

Methods

addEventListener

addEventListener<K extends keyof OffscreenCanvasEventMap>(
    type: K,
    listener: (this: OffscreenCanvas, ev: OffscreenCanvasEventMap[K]) => any,
    options?: boolean | AddEventListenerOptions,
): void
Appends an event listener for events whose type attribute value is type. The callback argument sets the callback that will be invoked when the event is dispatched.

The options argument sets listener-specific options. For compatibility this can be a boolean, in which case the method behaves exactly as if the value was specified as options's capture.

When set to true, options's capture prevents callback from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE. When false (or not present), callback will not be invoked when event's eventPhase attribute value is CAPTURING_PHASE. Either way, callback will be invoked if event's eventPhase attribute value is AT_TARGET.

When set to true, options's passive indicates that the callback will not cancel the event by invoking preventDefault(). This is used to enable performance optimizations described in § 2.8 Observing event listeners.

When set to true, options's once indicates that the callback will only be invoked once after which the event listener will be removed.

If an AbortSignal is passed for options's signal, then the event listener will be removed when signal is aborted.

The event listener is appended to target's event listener list and is not appended if it has the same type, callback, and capture.

MDN Reference
Type Parameters
- K extends keyof OffscreenCanvasEventMap
Parameters
- type: K
- listener: (this: OffscreenCanvas, ev: OffscreenCanvasEventMap[K]) => any
- Optionaloptions: boolean | AddEventListenerOptions
Returns void
Inherited from EventTarget.addEventListener
- Defined in node_modules/typescript/lib/lib.dom.d.ts:16619
addEventListener(
    type: string,
    listener: EventListenerOrEventListenerObject,
    options?: boolean | AddEventListenerOptions,
): void
Appends an event listener for events whose type attribute value is type. The callback argument sets the callback that will be invoked when the event is dispatched.

The options argument sets listener-specific options. For compatibility this can be a boolean, in which case the method behaves exactly as if the value was specified as options's capture.

When set to true, options's capture prevents callback from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE. When false (or not present), callback will not be invoked when event's eventPhase attribute value is CAPTURING_PHASE. Either way, callback will be invoked if event's eventPhase attribute value is AT_TARGET.

When set to true, options's passive indicates that the callback will not cancel the event by invoking preventDefault(). This is used to enable performance optimizations described in § 2.8 Observing event listeners.

When set to true, options's once indicates that the callback will only be invoked once after which the event listener will be removed.

If an AbortSignal is passed for options's signal, then the event listener will be removed when signal is aborted.

The event listener is appended to target's event listener list and is not appended if it has the same type, callback, and capture.

MDN Reference
Parameters
- type: string
- listener: EventListenerOrEventListenerObject
- Optionaloptions: boolean | AddEventListenerOptions
Returns void
Inherited from EventTarget.addEventListener
- Defined in node_modules/typescript/lib/lib.dom.d.ts:16620
addEventListener<K extends keyof OffscreenCanvasEventMap>(
    type: K,
    listener: (this: OffscreenCanvas, ev: OffscreenCanvasEventMap[K]) => any,
    options?: boolean | AddEventListenerOptions,
): void
Appends an event listener for events whose type attribute value is type. The callback argument sets the callback that will be invoked when the event is dispatched.

The options argument sets listener-specific options. For compatibility this can be a boolean, in which case the method behaves exactly as if the value was specified as options's capture.

When set to true, options's capture prevents callback from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE. When false (or not present), callback will not be invoked when event's eventPhase attribute value is CAPTURING_PHASE. Either way, callback will be invoked if event's eventPhase attribute value is AT_TARGET.

When set to true, options's passive indicates that the callback will not cancel the event by invoking preventDefault(). This is used to enable performance optimizations described in § 2.8 Observing event listeners.

When set to true, options's once indicates that the callback will only be invoked once after which the event listener will be removed.

If an AbortSignal is passed for options's signal, then the event listener will be removed when signal is aborted.

The event listener is appended to target's event listener list and is not appended if it has the same type, callback, and capture.

MDN Reference
Type Parameters
- K extends keyof OffscreenCanvasEventMap
Parameters
- type: K
- listener: (this: OffscreenCanvas, ev: OffscreenCanvasEventMap[K]) => any
- Optionaloptions: boolean | AddEventListenerOptions
Returns void
Inherited from EventTarget.addEventListener
- Defined in .temp/typedoc/docdirectory/doc.d.ts:143405
addEventListener(
    type: string,
    listener: EventListenerOrEventListenerObject,
    options?: boolean | AddEventListenerOptions,
): void
Appends an event listener for events whose type attribute value is type. The callback argument sets the callback that will be invoked when the event is dispatched.

The options argument sets listener-specific options. For compatibility this can be a boolean, in which case the method behaves exactly as if the value was specified as options's capture.

When set to true, options's capture prevents callback from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE. When false (or not present), callback will not be invoked when event's eventPhase attribute value is CAPTURING_PHASE. Either way, callback will be invoked if event's eventPhase attribute value is AT_TARGET.

When set to true, options's passive indicates that the callback will not cancel the event by invoking preventDefault(). This is used to enable performance optimizations described in § 2.8 Observing event listeners.

When set to true, options's once indicates that the callback will only be invoked once after which the event listener will be removed.

If an AbortSignal is passed for options's signal, then the event listener will be removed when signal is aborted.

The event listener is appended to target's event listener list and is not appended if it has the same type, callback, and capture.

MDN Reference
Parameters
- type: string
- listener: EventListenerOrEventListenerObject
- Optionaloptions: boolean | AddEventListenerOptions
Returns void
Inherited from EventTarget.addEventListener
- Defined in .temp/typedoc/docdirectory/doc.d.ts:143410

convertToBlob

convertToBlob(options?: ImageEncodeOptions): Promise<Blob>
Returns a promise that will fulfill with a new Blob object representing a file containing the image in the OffscreenCanvas object.

The argument, if provided, is a dictionary that controls the encoding options of the image file to be created. The type field specifies the file format and has a default value of "image/png"; that type is also used if the requested type isn't supported. If the image format supports variable quality (such as "image/jpeg"), then the quality field is a number in the range 0.0 to 1.0 inclusive indicating the desired quality level for the resulting image.

MDN Reference
Parameters
- Optionaloptions: ImageEncodeOptions
Returns Promise<Blob>
- Defined in node_modules/typescript/lib/lib.dom.d.ts:16598
convertToBlob(options?: ImageEncodeOptions): Promise<Blob>
Returns a promise that will fulfill with a new Blob object representing a file containing the image in the OffscreenCanvas object.

The argument, if provided, is a dictionary that controls the encoding options of the image file to be created. The type field specifies the file format and has a default value of "image/png"; that type is also used if the requested type isn't supported. If the image format supports variable quality (such as "image/jpeg"), then the quality field is a number in the range 0.0 to 1.0 inclusive indicating the desired quality level for the resulting image.
Parameters
- Optionaloptions: ImageEncodeOptions
Returns Promise<Blob>
- Defined in .temp/typedoc/docdirectory/doc.d.ts:143390

getContext

getContext(
contextId: "2d",
options?: any,
): null | OffscreenCanvasRenderingContext2D
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).

MDN Reference
Parameters
- contextId: "2d"
- Optionaloptions: any
Returns null | OffscreenCanvasRenderingContext2D
- Defined in node_modules/typescript/lib/lib.dom.d.ts:16608
getContext(
contextId: "bitmaprenderer",
options?: any,
): null | ImageBitmapRenderingContext
Parameters
- contextId: "bitmaprenderer"
- Optionaloptions: any
Returns null | ImageBitmapRenderingContext
- Defined in node_modules/typescript/lib/lib.dom.d.ts:16609
getContext(contextId: "webgl", options?: any): null | WebGLRenderingContext
Parameters
- contextId: "webgl"
- Optionaloptions: any
Returns null | WebGLRenderingContext
- Defined in node_modules/typescript/lib/lib.dom.d.ts:16610
getContext(contextId: "webgl2", options?: any): null | WebGL2RenderingContext
Parameters
- contextId: "webgl2"
- Optionaloptions: any
Returns null | WebGL2RenderingContext
- Defined in node_modules/typescript/lib/lib.dom.d.ts:16611
getContext(
contextId: OffscreenRenderingContextId,
options?: any,
): null | OffscreenRenderingContext
Parameters
- contextId: OffscreenRenderingContextId
- Optionaloptions: any
Returns null | OffscreenRenderingContext
- Defined in node_modules/typescript/lib/lib.dom.d.ts:16612
getContext(
contextId: "2d",
options?: any,
): null | OffscreenCanvasRenderingContext2D
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
- contextId: "2d"
- Optionaloptions: any
Returns null | OffscreenCanvasRenderingContext2D
- Defined in .temp/typedoc/docdirectory/doc.d.ts:143398
getContext(
contextId: "bitmaprenderer",
options?: any,
): null | ImageBitmapRenderingContext
Parameters
- contextId: "bitmaprenderer"
- Optionaloptions: any
Returns null | ImageBitmapRenderingContext
- Defined in .temp/typedoc/docdirectory/doc.d.ts:143399
getContext(contextId: "webgl", options?: any): null | WebGLRenderingContext
Parameters
- contextId: "webgl"
- Optionaloptions: any
Returns null | WebGLRenderingContext
- Defined in .temp/typedoc/docdirectory/doc.d.ts:143400
getContext(contextId: "webgl2", options?: any): null | WebGL2RenderingContext
Parameters
- contextId: "webgl2"
- Optionaloptions: any
Returns null | WebGL2RenderingContext
- Defined in .temp/typedoc/docdirectory/doc.d.ts:143401
getContext(
contextId: OffscreenRenderingContextIdBJS,
options?: any,
): null | OffscreenRenderingContextBJS
Parameters
- contextId: OffscreenRenderingContextIdBJS
- Optionaloptions: any
Returns null | OffscreenRenderingContextBJS
- Defined in .temp/typedoc/docdirectory/doc.d.ts:143402

removeEventListener

removeEventListener<K extends keyof OffscreenCanvasEventMap>(
    type: K,
    listener: (this: OffscreenCanvas, ev: OffscreenCanvasEventMap[K]) => any,
    options?: boolean | EventListenerOptions,
): void
Removes the event listener in target's event listener list with the same type, callback, and options.

MDN Reference
Type Parameters
- K extends keyof OffscreenCanvasEventMap
Parameters
- type: K
- listener: (this: OffscreenCanvas, ev: OffscreenCanvasEventMap[K]) => any
- Optionaloptions: boolean | EventListenerOptions
Returns void
Inherited from EventTarget.removeEventListener
- Defined in node_modules/typescript/lib/lib.dom.d.ts:16621
removeEventListener(
    type: string,
    listener: EventListenerOrEventListenerObject,
    options?: boolean | EventListenerOptions,
): void
Removes the event listener in target's event listener list with the same type, callback, and options.

MDN Reference
Parameters
- type: string
- listener: EventListenerOrEventListenerObject
- Optionaloptions: boolean | EventListenerOptions
Returns void
Inherited from EventTarget.removeEventListener
- Defined in node_modules/typescript/lib/lib.dom.d.ts:16622
removeEventListener<K extends keyof OffscreenCanvasEventMap>(
    type: K,
    listener: (this: OffscreenCanvas, ev: OffscreenCanvasEventMap[K]) => any,
    options?: boolean | EventListenerOptions,
): void
Removes the event listener in target's event listener list with the same type, callback, and options.

MDN Reference
Type Parameters
- K extends keyof OffscreenCanvasEventMap
Parameters
- type: K
- listener: (this: OffscreenCanvas, ev: OffscreenCanvasEventMap[K]) => any
- Optionaloptions: boolean | EventListenerOptions
Returns void
Inherited from EventTarget.removeEventListener
- Defined in .temp/typedoc/docdirectory/doc.d.ts:143411
removeEventListener(
    type: string,
    listener: EventListenerOrEventListenerObject,
    options?: boolean | EventListenerOptions,
): void
Removes the event listener in target's event listener list with the same type, callback, and options.

MDN Reference
Parameters
- type: string
- listener: EventListenerOrEventListenerObject
- Optionaloptions: boolean | EventListenerOptions
Returns void
Inherited from EventTarget.removeEventListener
- Defined in .temp/typedoc/docdirectory/doc.d.ts:143416

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.

MDN Reference

Returns ImageBitmap
- Defined in node_modules/typescript/lib/lib.dom.d.ts:16618
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
- Defined in .temp/typedoc/docdirectory/doc.d.ts:143404

Interface OffscreenCanvas

Hierarchy

Index

Properties

Methods

Properties

height

oncontextlost

oncontextrestored

width

Methods

addEventListener

Type Parameters

Parameters

Returns void

Parameters

Returns void

Type Parameters

Parameters

Returns void

Parameters

Returns void

convertToBlob

Parameters

Returns Promise<Blob>

Parameters

Returns Promise<Blob>

getContext

Parameters

Returns null | OffscreenCanvasRenderingContext2D

Parameters

Returns null | ImageBitmapRenderingContext

Parameters

Returns null | WebGLRenderingContext

Parameters

Returns null | WebGL2RenderingContext

Parameters

Returns null | OffscreenRenderingContext

Parameters

Returns null | OffscreenCanvasRenderingContext2D

Parameters

Returns null | ImageBitmapRenderingContext

Parameters

Returns null | WebGLRenderingContext

Parameters

Returns null | WebGL2RenderingContext

Parameters

Returns null | OffscreenRenderingContextBJS

removeEventListener

Type Parameters

Parameters

Returns void

Parameters

Returns void

Type Parameters

Parameters

Returns void

Parameters

Returns void

transferToImageBitmap

Returns ImageBitmap

Returns ImageBitmap

Settings

On This Page