GdiBitmap — JSplitter API

class

Name	Type	Description
`arg`	`GdiBitmap`

Name	Type	Description
`alpha`	`number`	Valid values 0-255.

ApplyMask

js/foo_uie_jsplitter.js:4221

ApplyMask(img)

Changes will be saved in the current bitmap.

Parameters

Name	Type	Description
`img`	`GdiBitmap`

Example source

samples/basic/ApplyMask.jsopen source

method

Name	Type	Description
`x`	`number`
`y`	`number`
`w`	`number`
`h`	`number`

CreateRawBitmap

js/foo_uie_jsplitter.js:4239

CreateRawBitmap()

Create a DDB bitmap from GdiBitmap, which is used in GdiDrawBitmap

Returns

GdiRawBitmap

method

GetColourScheme

js/foo_uie_jsplitter.js:4246

GetColourScheme(max_count)

Returns up to max_count representative colours found in the image.
This is a legacy colour extraction method. For colour frequency information and more advanced clustering, use GetColourSchemeJSON or GetColourSchemeJSONV2.

Parameters

Name	Type	Description
`max_count`	`number`	maximum number of colours to return

Returns

Array<number>

method

GetColourSchemeJSON

js/foo_uie_jsplitter.js:4257

GetColourSchemeJSON(max_count)

Extracts representative colours from the image using K-means clustering in the RGB colour space.
Returns a JSON array in string form so you need to use JSON.parse() on the result.
Each entry contains a colour and its relative frequency in the clustered image.
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`	maximum number of colours to return

Returns

string

Example

// See docs\Helpers.js for "toRGB" function.
img = ... // use utils.GetAlbumArtV2 / gdi.Image / etc
colours = JSON.parse(img.GetColourSchemeJSON(5));
console.log(colours[0].col); // 4290772992
console.log(colours[0].freq); // 0.34
console.log(toRGB(colours[0].col)); // [192, 0, 0]

method

GetColourSchemeJSONV2

js/foo_uie_jsplitter.js:4278

GetColourSchemeJSONV2(max_count, min_chroma)

Extracts representative colours from the image using K-means++ clustering in the Oklab colour space.
Returns a JSON array in string form so you need to use JSON.parse() on the result.
Each entry contains a colour and its relative frequency in the clustered image.
K-means++ initialization improves the distribution of the initial cluster centres, while Oklab provides a perceptually more uniform distance metric than RGB.
The optional min_chroma parameter limits the initial cluster centre selection to pixels with at least the specified Oklab chroma. It does not filter pixels or colours from the clustering result.

Parameters

Name	Type	Description
`max_count`	`number`	maximum number of colours to return
`min_chroma = 0.0`optional	`number`	minimum Oklab chroma for pixels used as initial cluster centres

Returns

string

Example

// See docs\Helpers.js for "toRGB" function.
img = ... // use utils.GetAlbumArtV2 / gdi.Image / etc
colours = JSON.parse(img.GetColourSchemeJSONV2(10, 0.02));
console.log(colours[0].col); // 4290772992
console.log(colours[0].freq); // 0.34
console.log(toRGB(colours[0].col)); // [192, 0, 0]

method

GetGraphics

js/foo_uie_jsplitter.js:4301

GetGraphics()

Note: don't forget to use ReleaseGraphics after work on GdiGraphics is done!

Returns

GdiGraphics

method

GetPixelData

js/foo_uie_jsplitter.js:4308

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: "bgra32" 32bpp BGRA "rgba32" 32bpp RGBA "bgr24" 24bpp BGR "rgb24" 24bpp RGB

Returns

Uint8Array —

null if was an error (for example, bitmap in unsupported format or unsupported format specified)

Example

const img = gdi.Image(`${fb.ComponentPath}\\samples\\d2d\\images\\Field.jpg`);

let imgPixelData = img.GetPixelData();

utils.WriteBinaryFile("D:\\Field.bin", imgPixelData);

let rData = utils.ReadBinaryFile("D:\\Field.bin");

let rImg = gdi.CreateImageFromPixelData(rData, 2208, 1242);

function on_paint(gr) {
    gr.DrawImage(rImg, 0, 0, img.Width, img.Height, 0, 0, img.Width, img.Height);
}

method

InvertColours

js/foo_uie_jsplitter.js:4335

InvertColours()

Inverts the colours in a bitmap, to create a negative image. i.e. White becomes black, black becomes white, etc.

Returns

GdiBitmap

method

ReleaseGraphics

js/foo_uie_jsplitter.js:4342

ReleaseGraphics(gr)

Parameters

Name	Type	Description
`gr`	`GdiGraphics`

method

Resize

js/foo_uie_jsplitter.js:4347

Resize(w, h, mode)

Parameters

Name	Type	Description
`w`	`number`
`h`	`number`
`mode = 0`optional	`number`	See InterpolationMode

Returns

GdiBitmap

method

RotateFlip

js/foo_uie_jsplitter.js:4355

RotateFlip(mode)

Changes will be saved in the current bitmap.

Parameters

Name	Type	Description
`mode`	`number`	See RotateFlipType

method

SaveAs

js/foo_uie_jsplitter.js:4362

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" "image/bmp" "image/jpeg" "image/gif" "image/tiff"

Returns

boolean

Example

let img = utils.GetAlbumArtEmbedded(fb.GetFocusItem().RawPath, 0);
if (img) {
    img.SaveAs("D:\\export.jpg", "image/jpeg");
}

method

StackBlur

js/foo_uie_jsplitter.js:4380

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`