dom / latest / imagebitmaprenderingcontext / transferfromimagebitmap.html /

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

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
HTML Standard
# dom-imagebitmaprenderingcontext-transferfromimagebitmap-dev

Browser compatibility

Desktop Mobile
Chrome Edge Firefox Internet Explorer Opera Safari WebView Android Chrome Android Firefox for Android Opera Android Safari on IOS Samsung Internet
transferFromImageBitmap
56
79
52
46-52
No
43
15
56
56
52
46-52
43
15
6.0

See also

© 2005–2021 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/ImageBitmapRenderingContext/transferFromImageBitmap

Name Web APIs
Version
Badge
Last Updated 2022-04-27T09:33:08Z