class
D2DBitmap
js/d2d.js:1
D2DBitmap(arg)Parameters
| Name | Type | Description |
|---|---|---|
arg | D2DBitmap |
Documentation/D2DBitmap
propertyreadonly
Height
js/d2d.js:7
Height: numberpropertyreadonly
Width
js/d2d.js:13
Width: numbermethod
ApplyAlpha
js/d2d.js:19
ApplyAlpha(alpha)Parameters
| Name | Type | Description |
|---|---|---|
alpha | number | Valid values 0-255. |
Returns
method
ApplyAlphaIndirect
js/d2d.js:25
ApplyAlphaIndirect(alpha)Apllies alpha for entire image. Unlike D2DBitmap#ApplyAlpha changes the current object
Parameters
| Name | Type | Description |
|---|---|---|
alpha | number | Valid values 0-255. |
method
ApplyMask
js/d2d.js:31
ApplyMask(img)Changes will be saved in the current bitmap.
Parameters
| Name | Type | Description |
|---|---|---|
img | D2DBitmap |
Example source
method
Clone
js/d2d.js:40
Clone(x, y, w, h)Create partial copy of image represented by D2DBitmap object
Parameters
| Name | Type | Description |
|---|---|---|
x | number | |
y | number | |
w | number | |
h | number |
Returns
method
CreateRawBitmap
js/d2d.js:51
CreateRawBitmap()Create clone bitmap from D2DBitmap object
Returns
method
GetColourScheme
js/d2d.js:58
GetColourScheme(max_count)Takes the top of colors found in the image
Parameters
| Name | Type | Description |
|---|---|---|
max_count | number |
Returns
Array<number>method
GetColourSchemeJSON
js/d2d.js:65
GetColourSchemeJSON(max_count)Returns a JSON array in string form so you need to use JSON.parse() on the result.
Each entry in the array is an object which contains colour and frequency values.
Uses a different method for calculating colours than GetColourScheme.
Image is automatically resized during processing for performance reasons so there's no need to resize before calling the method.
Parameters
| Name | Type | Description |
|---|---|---|
max_count | number |
Returns
stringExample
// See docs\Helpers.js for "toRGB" function.
img = ... // use utils.GetAlbumArtV2 / d2d.Image / etc
colours = JSON.parse(img.GetColourSchemeJSON(5));
console.log(colours[0].col); // -4194304
console.log(colours[0].freq); // 0.34
console.log(toRGB(colours[0].col)); // [192, 0, 0]method
GetColourSchemeJSONV2
js/d2d.js:85
GetColourSchemeJSONV2(max_count)Returns a JSON array in string form so you need to use JSON.parse() on the result.
Each entry in the array is an object which contains colour and frequency values.
Uses a different method than GetColourSchemeJSON for calculating colours (K-means++ with Oklab).
Parameters
| Name | Type | Description |
|---|---|---|
max_count | number | |
min_chroma = 0.0optional | number | minimal chroma value for choosing start cluster pixel |
Returns
stringmethod
GetGraphics
js/d2d.js:96
GetGraphics()IMPORTANT: You MUST call ReleaseGraphics after work on D2DGraphics is done!
It is illegal to call any methods of D2DBitmap object while working with the obtained D2DGraphics object until ReleaseGraphics is called.
Returns
method
GetPixelData
js/d2d.js:104
GetPixelData(format)Extract raw pixels from bitmap as a byte array in specified pixel format
Parameters
| Name | Type | Description |
|---|---|---|
format = "bgra32"optional | string | Pixel format string (default: "bgra32") Supported formats: |
Returns
Uint8Array — null if was an error (for example, bitmap in unsupported format or unsupported format specified)
Example source
method
InvertColours
js/d2d.js:119
InvertColours()Inverts the colours in a bitmap, to create a negative image. i.e. White becomes black, black becomes white, etc.
Returns
method
ReleaseGraphics
js/d2d.js:126
ReleaseGraphics(gr)Parameters
| Name | Type | Description |
|---|---|---|
gr | D2DGraphics |
Returns
numbermethod
Resize
js/d2d.js:132
Resize(w, h, mode)Parameters
| Name | Type | Description |
|---|---|---|
w | number | |
h | number | |
mode = 0optional | number |
Returns
method
ResizeIndirect
js/d2d.js:140
ResizeIndirect(w, h, mode)Resizes image. Unlike D2DBitmap#Resize changes the current object
Parameters
| Name | Type | Description |
|---|---|---|
w | number | |
h | number | |
mode = 0optional | number | |
sharpness = 0.0optional | number | |
border_hard = falseoptional | number | |
cx = 0optional | number | Scale center point x |
cy = 0optional | number | Scale center point y |
method
RotateFlip
js/d2d.js:152
RotateFlip(mode)Changes will be saved in the current bitmap.
Parameters
| Name | Type | Description |
|---|---|---|
mode | number | See RotateFlipType |
method
SaveAs
js/d2d.js:159
SaveAs(path, format)Parameters
| Name | Type | Description |
|---|---|---|
path | string | Full path including file extension. The parent folder must already exist. |
format = 'image/png'optional | string | "image/png" |
Returns
booleanExample
let img = utils.GetAlbumArtEmbedded(fb.GetFocusItem().RawPath, 0);
if (img) {
img.SaveAs("D:\\export.jpg", "image/jpeg");
}method
StackBlur
js/d2d.js:177
StackBlur(radius)Changes will be saved in the current bitmap.
Parameters
| Name | Type | Description |
|---|---|---|
radius | number | Valid values 2-254. |
Examples
<caption>Blur image<caption>
// `samples/basic/StackBlur (image).js`<caption>Blur text<caption>
// `samples/basic/StackBlur (text).js`