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
void ImageBitmapRenderingContext.transferImageBitmap(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.transferImageBitmap(bitmap);
Specifications
Currently drafted as a proposal: OffscreenCanvas.
Browser compatibility
See also
- The interface defining this method,
ImageBitmapRenderingContext
OffscreenCanvas
OffscreenCanvas.transferToImageBitmap()