ImageBitmapRenderingContext: transferFromImageBitmap() method

Available in 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, or null. If the value is null, the canvas is reset to blank.

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

Browser compatibility

See also

• The interface defining this method, ImageBitmapRenderingContext
• OffscreenCanvas
• transferToImageBitmap()