OffscreenCanvas
See
https://developer.mozilla.org/docs/Web/API/OffscreenCanvas
Extends
Implements
Omit
<globalThis.OffscreenCanvas
,"getContext"
>
Constructors
new OffscreenCanvas()
new OffscreenCanvas(width
, height
): OffscreenCanvas
Parameters
Parameter | Type | Description |
---|---|---|
width | number | The width of the offscreen canvas. |
height | number | The height of the offscreen canvas. |
Returns
Overrides
Properties
Property | Type | Default value | Description |
---|---|---|---|
height | number | undefined | Specifies the height (in pixels) of the canvas. See https://developer.mozilla.org/docs/Web/API/OffscreenCanvas/height |
oncontextlost | null | null | - |
oncontextrestored | null | null | - |
width | number | undefined | Specifies the width (in pixels) of the canvas. See https://developer.mozilla.org/docs/Web/API/OffscreenCanvas/height |
Methods
addEventListener()
addEventListener(type
, callback
, options
?): 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.
Parameters
Parameter | Type |
---|---|
type | string |
callback | null | EventListenerOrEventListenerObject <any > |
options ? | boolean | AddEventListenerOptions |
Returns
void
Implementation of
Omit.addEventListener
Inherited from
See
https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener
convertToBlob()
Parameters
Parameter | Type |
---|---|
options ? | ImageEncodeOptions |
Returns
Implementation of
Omit.convertToBlob
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
Parameter | Type |
---|---|
event | Event |
Returns
boolean
Implementation of
Omit.dispatchEvent
Inherited from
See
https://developer.mozilla.org/docs/Web/API/EventTarget/dispatchEvent
getContext()
getContext(contextId
, options
?): OffscreenCanvasRenderingContext2D
Parameters
Parameter | Type |
---|---|
contextId | "2d" |
options ? | any |
Returns
OffscreenCanvasRenderingContext2D
removeEventListener()
removeEventListener(type
, callback
, options
?): void
Removes the event listener in target's event listener list with the same type, callback, and options.
Parameters
Parameter | Type |
---|---|
type | string |
callback | null | EventListenerOrEventListenerObject <any > |
options ? | boolean | EventListenerOptions |
Returns
void
Implementation of
Omit.removeEventListener
Inherited from
EventTarget
.removeEventListener
See
https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener
transferToImageBitmap()
transferToImageBitmap(): ImageBitmap
Returns
Implementation of
Omit.transferToImageBitmap