Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface OffscreenCanvas

Hierarchy

  • EventTarget
    • OffscreenCanvas

Index

Properties

Methods

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

oncontextlost

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

oncontextrestored

oncontextrestored: null | ((this: internal.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).

Methods

addEventListener

  • addEventListener<K>(type: K, listener: ((this: internal.OffscreenCanvas, ev: OffscreenCanvasEventMap[K]) => any), options?: boolean | AddEventListenerOptions): void
  • addEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void

dispatchEvent

  • dispatchEvent(event: 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

    • event: Event

    Returns boolean

getContext

  • 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

    Returns null | OffscreenRenderingContext

removeEventListener

  • removeEventListener<K>(type: K, listener: ((this: internal.OffscreenCanvas, ev: OffscreenCanvasEventMap[K]) => any), options?: boolean | EventListenerOptions): void
  • removeEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void

transferToImageBitmap

  • 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 internal.ImageBitmap

Generated using TypeDoc