W3cubDocs

/Web APIs

ImageBitmapRenderingContext: transferFromImageBitmap() method

Baseline Widely available

This feature is well established and works across many devices and browser versions. It’s been available across browsers since ⁨January 2020⁩.

Note: This feature is available in Web Workers.

The ImageBitmapRenderingContext.transferFromImageBitmap() method displays the given ImageBitmap in the canvas associated with this rendering context. The ownership of the ImageBitmap is transferred to the canvas as well.

This method was previously named transferImageBitmap(), but was renamed in a spec change. The old name is being kept as an alias to avoid code breakage.

Syntax

transferFromImageBitmap(bitmap)

Parameters

bitmap: An ImageBitmap object to transfer.

Return value

None (undefined).

Examples

HTML

<canvas id="htmlCanvas"></canvas>

JavaScript

const htmlCanvas = document
  .getElementById("htmlCanvas")
  .getContext("bitmaprenderer");

// Draw a WebGL scene offscreen
const offscreen = new OffscreenCanvas(256, 256);
const gl = offscreen.getContext("webgl");

// Perform some drawing using the gl context

// Transfer the current frame to the visible canvas
const bitmap = offscreen.transferToImageBitmap();
htmlCanvas.transferFromImageBitmap(bitmap);

Specifications

Specification
HTML> # dom-imagebitmaprenderingcontext-transferfromimagebitmap-dev>

Browser compatibility

	Desktop					Mobile
	Chrome	Edge	Firefox	Opera	Safari	Chrome Android	Firefox for Android	Opera Android	Safari on IOS	Samsung Internet	WebView Android	WebView on iOS
`transferFromImageBitmap`	66	79	5046–52	53	11.1	66	5046–52	47	11.3	9.0	66	11.3