ImageBitmapRenderingContext.transferImageBitmap()

This is an experimental technology
Because this technology's specification has not stabilized, check the compatibility table for the proper prefixes to use 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 spec changes.

The ImageBitmapRenderingContext.transferImageBitmap() 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.

Syntax

JavaScript
void ImageBitmapRenderingContext.transferImageBitmap(bitmap)

Parameters

bitmap
An ImageBitmap object to transfer.

Examples

HTML

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

JavaScript

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.transferImageBitmap(bitmap);

Specifications

Currently drafted as a proposal: OffscreenCanvas.

Browser compatibility

Feature Chrome Firefox (Gecko) Internet Explorer Opera Safari
Basic support Not supported 46 (46) Not supported Not supported Not supported
Feature Android Firefox Mobile (Gecko) IE Mobile Opera Mobile Safari Mobile
Basic support Not supported 46.0 (46) Not supported Not supported Not supported

See also

License

© 2016 Mozilla Contributors
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-us/docs/web/api/imagebitmaprenderingcontext/transferimagebitmap

API Experimental ImageBitmapRenderingContext Method OffscreenCanvas Reference