# new Float16Image(width, height, colorspaceopt)
Creates a new Float16Image instance.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
width |
number
|
The width of the image in pixels. |
|
height |
number
|
The height of the image in pixels. |
|
colorspace |
string
|
<optional> |
The color space to use for the image. Defaults to |
Classes
Members
# COLORSPACES
A mapping of predefined HDR color space names to their corresponding colorjs.io string representations.
# COLORSPACES
A mapping of predefined HDR color space names to their corresponding colorjs.io string representations.
# DEFAULT_COLORSPACE
The default color space for new images, set to "rec2100-hlg".
# DEFAULT_COLORSPACE
The default color space for new images, set to "rec2100-hlg".
# DEFAULT_PIXELFORMAT
The default pixel format for new images, set to "rgba-float16".
# DEFAULT_PIXELFORMAT
The default pixel format for new images, set to "rgba-float16".
# SDR_MULTIPLIER
A multiplier used for scaling 8-bit SDR values to 16-bit.
# SDR_MULTIPLIER
A multiplier used for scaling 8-bit SDR values to 16-bit.
Record.<HDRPredefinedColorSpace, ColorTypes>
# static COLORSPACES
A mapping of predefined HDR color space names to their corresponding colorjs.io string representations.
Record.<HDRPredefinedColorSpace, ColorTypes>
# static COLORSPACES
A mapping of predefined HDR color space names to their corresponding colorjs.io string representations.
HDRPredefinedColorSpace
# static DEFAULT_COLORSPACE
The default color space for new images, set to "rec2100-hlg".
HDRPredefinedColorSpace
# static DEFAULT_COLORSPACE
The default color space for new images, set to "rec2100-hlg".
"rgba-float16"
# static DEFAULT_PIXELFORMAT
The default pixel format for new images, set to "rgba-float16".
"rgba-float16"
# static DEFAULT_PIXELFORMAT
The default pixel format for new images, set to "rgba-float16".
# static SDR_MULTIPLIER
A multiplier used for scaling 8-bit SDR values to 16-bit.
# static SDR_MULTIPLIER
A multiplier used for scaling 8-bit SDR values to 16-bit.
Methods
# fill(color) → {Float16Image|undefined}
Fills the entire image with a single color.
Parameters:
| Name | Type | Description |
|---|---|---|
color |
Array.<number>
|
An array of four numbers representing the R, G, B, and A channels (0-65535). |
The Float16Image instance for method chaining, or undefined if the color array is invalid.
Float16Image
|
undefined
# getImageData() → {ImageData|null}
Creates a standard ImageData object from the Float16Image data.
An ImageData object, or null if the data is undefined.
ImageData
|
null
# getPixel(w, h) → {Float16Array}
Retrieves the pixel data at a specified coordinate.
Parameters:
| Name | Type | Description |
|---|---|---|
w |
number
|
The x-coordinate (width). |
h |
number
|
The y-coordinate (height). |
A new Float16Array containing the R, G, B, and A values of the pixel.
Float16Array
# pixelCallback(fn)
Iterates through each pixel of the image and applies a callback function to its data.
Parameters:
| Name | Type | Description |
|---|---|---|
fn |
Float16ImagePixelCallback
|
The callback function to apply to each pixel. |
# setImageData(imageData) → {void}
Sets the image data of the current Float16Image instance.
Parameters:
| Name | Type | Description |
|---|---|---|
imageData |
HDRImageData
|
The image data to set. |
If the color space of the HDRImageData is not supported.
Error
void
# setPixel(w, h, px) → {void}
Sets the pixel data at a specified coordinate.
Parameters:
| Name | Type | Description |
|---|---|---|
w |
number
|
The x-coordinate (width). |
h |
number
|
The y-coordinate (height). |
px |
Array.<number>
|
An array of four numbers representing the R, G, B, and A channels. |
void
# static convertArrayToRec2100_hlg(data) → {Float16Array}
Converts a Uint8ClampedArray of sRGB pixel data to a Float16Array
of pixels in the rec2100-hlg color space.
Parameters:
| Name | Type | Description |
|---|---|---|
data |
Uint8ClampedArray
|
The array of 8-bit pixel data. |
The converted 16-bit pixel data.
Float16Array
# static convertPixelToRec2100_hlg(pixel) → {Float16Array}
Converts a single 8-bit pixel (from sRGB color space) to a 16-bit pixel
in the rec2100-hlg color space.
Parameters:
| Name | Type | Description |
|---|---|---|
pixel |
Uint8ClampedArray
|
An array of four 8-bit numbers (R, G, B, A). |
The converted 16-bit pixel in the rec2100-hlg color space.
Float16Array
# static fromImageData(imageData) → {Float16Image}
Creates a Float16Image instance from an HDRImageData object.
Parameters:
| Name | Type | Description |
|---|---|---|
imageData |
HDRImageData
|
The image data to use. |
If the color space of the HDRImageData is not supported.
Error
The new Float16Image instance.
# async static fromURL(url) → {Promise.<(Float16Image|undefined)>}
Loads an image from a URL and creates a Float16Image instance from it.
Parameters:
| Name | Type | Description |
|---|---|---|
url |
URL
|
The URL of the image to load. |
A promise that resolves with a Float16Image instance, or undefined if the image could not be loaded.
Promise.<(Float16Image|undefined)>
# async static loadSDRImageData(url) → {Promise.<(HDRImageData|undefined)>}
Loads an SDR image from a URL and returns its image data.
Parameters:
| Name | Type | Description |
|---|---|---|
url |
URL
|
The URL of the image to load. |
A promise that resolves with the HDRImageData or undefined if loading fails.
Promise.<(HDRImageData|undefined)>
# static scaleUint8ToFloat16(val) → {number}
Scales an 8-bit value to a 16-bit value. This is typically used for the alpha channel.
Parameters:
| Name | Type | Description |
|---|---|---|
val |
number
|
The 8-bit value to scale (0-255). |
The corresponding 16-bit value.
number