WorkerGlobalScope: createImageBitmap() method

Baseline Widely available *

This feature is well established and works across many devices and browser versions. It’s been available across browsers since September 2021.

* Some parts of this feature may have varying levels of support.

Note: This feature is only available inWeb Workers.

ThecreateImageBitmap() method of theWorkerGlobalScope interface creates a bitmap from a given source, optionally cropped to contain only a portion of that source.It accepts a variety of different image sources, and returns aPromise which resolves to anImageBitmap.

Syntax

createImageBitmap(image)createImageBitmap(image, options)createImageBitmap(image, sx, sy, sw, sh)createImageBitmap(image, sx, sy, sw, sh, options)

Parameters

image

An image source, which can be any one of the following:

sx

The x coordinate of the reference point of the rectangle from which theImageBitmap will be extracted.

sy

The y coordinate of the reference point of the rectangle from which theImageBitmap will be extracted.

sw

The width of the rectangle from which theImageBitmap will be extracted.This value can be negative.

sh

The height of the rectangle from which theImageBitmap will be extracted. This value can be negative.

optionsOptional

An object that sets options for the image's extraction.The available options are:

imageOrientation

Specifies how the bitmap image should be oriented.

from-image: Image oriented according to EXIF orientation metadata, if present (default).
flipY: Image oriented according to EXIF orientation metadata, if present, and then flipped vertically.
none: Image oriented according to image encoding, ignoring any metadata about the orientation (such as EXIF metadata, that might be added to an image to indicate that the camera was turned sideways to capture the image in portrait mode).

premultiplyAlpha

Specifies whether the bitmap's color channels should be premultiplied by the alpha channel.One ofnone,premultiply, ordefault (default).

colorSpaceConversion

Specifies whether the image should be decoded using color space conversion.Eithernone ordefault (default).The valuedefault indicates that implementation-specific behavior is used.

resizeWidth