ImageBitmapRenderingContext.transferFromImageBitmap()

This is an experimental technology
Because this technology's specification has not stabilized, check the compatibility table for usage in various browsers. Also note that the syntax and behavior of an experimental technology is subject to change in future versions of browsers as the specification changes.

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

Currently drafted as a proposal: OffscreenCanvas.

Browser compatibility

Feature Chrome Firefox (Gecko) Internet Explorer Opera Safari
Basic support 55.0 46 (46) No support 42 No support
transferImageBitmap() ->
transferFromImageBitmap()
? 52 (52) No support ? No support
Feature Android Firefox Mobile (Gecko) IE Mobile Opera Mobile Safari Mobile
Basic support 55.0 46.0 (46) No support 42 55.0
transferImageBitmap() ->
transferFromImageBitmap()
? 52.0 (52) No support ? ?

See also

Document Tags and Contributors

 Contributors to this page: chrisdavidmills, fscholz
 Last updated by: chrisdavidmills,