Interface OffscreenCanvas
Hierarchy
- EventTarget
- OffscreenCanvas
Index
Properties
heightSearch playground for height
oncontextlostSearch playground for oncontextlost
oncontextrestoredSearch playground for oncontextrestored
widthSearch playground for width
Methods
add
Type Parameters
K extends keyof OffscreenCanvasEventMap
Parameters
type: K
listener: ((this: OffscreenCanvas, ev: OffscreenCanvasEventMap[K]) => any)
Parameters
this: OffscreenCanvas
ev: OffscreenCanvasEventMap[K]
Returns any
Optional options: boolean | AddEventListenerOptions
Returns void
Parameters
type: string
listener: EventListenerOrEventListenerObject
Optional options: boolean | AddEventListenerOptions
Returns void
convert
Parameters
Optional options: any
Returns Promise<Blob>
get
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"
Optional options: any
Returns null | OffscreenCanvasRenderingContext2D
Parameters
contextId: "bitmaprenderer"
Optional options: any
Returns null | ImageBitmapRenderingContext
Parameters
contextId: "webgl"
Optional options: any
Returns null | WebGLRenderingContext
Parameters
contextId: "webgl2"
Optional options: any
Returns null | WebGL2RenderingContext
Parameters
contextId: OffscreenRenderingContextId
Optional options: any
Returns any
remove
Type Parameters
K extends keyof OffscreenCanvasEventMap
Parameters
type: K
listener: ((this: OffscreenCanvas, ev: OffscreenCanvasEventMap[K]) => any)
Parameters
this: OffscreenCanvas
ev: OffscreenCanvasEventMap[K]
Returns any
Optional options: boolean | EventListenerOptions
Returns void
Parameters
type: string
listener: EventListenerOrEventListenerObject
Optional options: boolean | EventListenerOptions
Returns void
transfer
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
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.