ImageBitmapRenderingContext: transferFromImageBitmap() method
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
js
transferFromImageBitmap(bitmap)
Parameters
bitmap
-
An
ImageBitmap
object to transfer.
Return value
None (undefined
).
Examples
HTML
html
<canvas id="htmlCanvas"></canvas>
JavaScript
js
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
Specification |
---|
HTML Standard # dom-imagebitmaprenderingcontext-transferfromimagebitmap-dev |
Browser compatibility
BCD tables only load in the browser
See also
- The interface defining this method,
ImageBitmapRenderingContext
OffscreenCanvas
OffscreenCanvas.transferToImageBitmap()