kotlin-browser/web.canvas/OffscreenCanvas

OffscreenCanvas

open external class OffscreenCanvas(width: JsLong, height: JsLong) : EventTarget, CanvasImageSource, TexImageSource, Transferable(source)

Constructors

OffscreenCanvas

constructor(width: JsLong, height: JsLong)

Properties

contextLostEvent

val contextLostEvent: EventInstance<Event, OffscreenCanvas, OffscreenCanvas>

contextRestoredEvent

val contextRestoredEvent: EventInstance<Event, OffscreenCanvas, OffscreenCanvas>

var height: JsLong

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

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

oncontextrestored

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

var width: JsLong

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

Functions

suspend fun convertToBlob(options: ImageEncodeOptions = definedExternally): Blob

Returns a promise that will fulfill with a new Blob object representing a file containing the image in the OffscreenCanvas object.

convertToBlobAsync

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

fun dispatchEvent(event: Event): Boolean

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

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.

transferToImageBitmap

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