HTMLCanvasElement: transferControlToOffscreen() method

Baseline 2023
Newly available

Since March 2023, this feature works across the latest devices and browser versions. This feature might not work in older devices or browsers.

The HTMLCanvasElement.transferControlToOffscreen() method transfers control to an OffscreenCanvas object, either on the main thread or on a worker.

Syntax

js
transferControlToOffscreen()

Parameters

None.

Return value

An OffscreenCanvas object.

Exceptions

InvalidStateError DOMException

Throws if:

Examples

The following example shows how to transfer control to an OffscreenCanvas object on the main thread.

js
const htmlCanvas = document.createElement("canvas");
const offscreen = htmlCanvas.transferControlToOffscreen();
const gl = offscreen.getContext("webgl");

// Some drawing using the gl context…

The following example shows how to transfer control to an OffscreenCanvas object on a worker.

js
const offscreen = document.querySelector("canvas").transferControlToOffscreen();
const worker = new Worker("my-worker-url.js");
worker.postMessage({ canvas: offscreen }, [offscreen]);

Specifications

Specification
HTML
# dom-canvas-transfercontroltooffscreen-dev

Browser compatibility

Report problems with this compatibility data on GitHub
desktopmobile
Chrome
Edge
Firefox
Opera
Safari
Chrome Android
Firefox for Android
Opera Android
Safari on iOS
Samsung Internet
WebView Android
WebView on iOS
transferControlToOffscreen

Legend

Tip: you can click/tap on a cell for more information.

Full support
Full support

See also