kotlin-browser/web.canvas/OffscreenCanvas

OffscreenCanvas

open class OffscreenCanvas(var width: UInt53, var height: UInt53) : EventTarget, CanvasImageSource, TexImageSource, GPUCopyExternalImageSource, Transferable(source)

When using the

Constructors

OffscreenCanvas

constructor(width: UInt53, height: UInt53)

Properties

external var height: UInt53

The height property returns and sets the height of an OffscreenCanvas object.

external var oncontextlost: EventHandler<Event, OffscreenCanvas, OffscreenCanvas>?

oncontextrestored

external var oncontextrestored: EventHandler<Event, OffscreenCanvas, OffscreenCanvas>?

external var width: UInt53

The width property returns and sets the width of an OffscreenCanvas object.

Functions

inline suspend fun OffscreenCanvas.convertToBlob(): Blob

inline suspend fun OffscreenCanvas.convertToBlob(options: ImageEncodeOptions): Blob

The OffscreenCanvas.convertToBlob() method creates a Blob object representing the image contained in the canvas.

convertToBlobAsync

external fun convertToBlobAsync(options: ImageEncodeOptions = definedExternally): Promise<Blob>

The OffscreenCanvas.convertToBlob() method creates a Blob object representing the image contained in the canvas.

open external fun dispatchEvent(event: Event): Boolean

external fun <T : OffscreenRenderingContext, O : JsAny?> getContext(contextId: RenderingContextId<T, O>, options: O? = definedExternally): T?

The OffscreenCanvas.getContext() method returns a drawing context for an offscreen canvas, or null if the context identifier is not supported, or the offscreen canvas has already been set to a different context mode.

transferToImageBitmap

external fun transferToImageBitmap(): ImageBitmap

The transferToImageBitmap() method of the OffscreenCanvas interface creates an ImageBitmap object from the most recently rendered image of the OffscreenCanvas. The image in the OffscreenCanvas is replaced with a new blank image for subsequent rendering.

external fun <T : Event> when(type: EventType<T>, options: ObservableEventListenerOptions?): Observable<T>