OffscreenCanvas.toBlob()

This is an experimental technology
Check the Browser compatibility table carefully before using this in production.

The OffscreenCanvas.toBlob() method creates a Blob object representing the image contained in the canvas.

Syntax

Promise<Blob> OffscreenCanvas.toBlob(type, encoderOptions);

Parameters

type Optional
A DOMString indicating the image format. The default type is image/png.
encoderOptions Optional
A Number between 0 and 1 indicating image quality if the requested type is image/jpeg or image/webp. If this argument is anything else, the default value for image quality is used. Other arguments are ignored.

Return value

A Promise returning a Blob object representing the image contained in the canvas.

Examples

var offscreen = new OffscreenCanvas(256, 256);
var gl = offscreen.getContext("webgl");

// ... some drawing using the gl context ...

offscreen.toBlob().then(function(blob) {
  console.log(blob);
});

// Blob { size: 334, type: "image/png" }

Specifications

Currently drafted as a proposal: OffscreenCanvas.

Browser compatibility

Update compatibility data on GitHub
DesktopMobile
ChromeEdgeFirefoxInternet ExplorerOperaSafariAndroid webviewChrome for AndroidEdge MobileFirefox for AndroidOpera for AndroidiOS SafariSamsung Internet
Basic support
Experimental
Chrome Full support 69Edge ? Firefox Full support 46
Disabled
Full support 46
Disabled
Disabled From version 46: this feature is behind the gfx.offscreencanvas.enabled preference. To change preferences in Firefox, visit about:config.
IE No support NoOpera Full support 56Safari No support NoWebView Android No support NoChrome Android Full support 69Edge Mobile ? Firefox Android Full support 46
Disabled
Full support 46
Disabled
Disabled From version 46: this feature is behind the gfx.offscreencanvas.enabled preference. To change preferences in Firefox, visit about:config.
Opera Android Full support YesSafari iOS No support NoSamsung Internet Android No support No

Legend

Full support  
Full support
No support  
No support
Compatibility unknown  
Compatibility unknown
Experimental. Expect behavior to change in the future.
Experimental. Expect behavior to change in the future.
User must explicitly enable this feature.
User must explicitly enable this feature.

 

See also

Document Tags and Contributors

Contributors to this page: some-body, fscholz
Last updated by: some-body,