ImageBitmapRenderingContext.transferFromImageBitmap()

Experimental

This is an experimental technology
Check the Browser compatibility table carefully before using this in production.

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

void ImageBitmapRenderingContext.transferFromImageBitmap(bitmap)

Parameters

bitmap
An ImageBitmap object to transfer.

Examples

HTML

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

JavaScript

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

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

// ... some drawing using the gl context ...

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

Specifications

Specification Status Comment
HTML Living Standard
The definition of 'transferFromImageBitmap()' in that specification.
Living Standard

Browser compatibility

BCD tables only load in the browser

See also