MEMBERS

readonly height :number

IncisorAPI.js, line 7452

The height of the PixelsObject.

inheritedTypes :object

IncisorAPI.js, line 7438

Dictionary object listing all of the types this object is compatible with.

type :string

IncisorAPI.js, line 7432

Type identifier.

readonly width :number

IncisorAPI.js, line 7445

The width of the PixelsObject.

METHODS

getPixel(x, y) returns {Vector4}

IncisorAPI.js, line 7471

Returns a Vector4 containing the RGBA color of the pixel at the given coordinates.

Parameters:

Name	Type	Attributes	Default	Description
x	number			The horizontal index of the pixel to get the color of.
y	number			The vertical index of the pixel to get the color of. The vertical position of pixels in PixelObjects map from bottom to top.

Returns:

Vector4

setPixel(x, y, color)

IncisorAPI.js, line 7479

Sets the RGBA color Value of the pixel at the given coordinates

Parameters:

Name	Type	Attributes	Default	Description
x	number			The horizontal index of the pixel to set the color of.
y	number			The vertical index of the pixel to get set color of. The vertical position of pixels in PixelObjects map from bottom to top.
color	Vector4			Vector with the RGBA color value for the desired pixel.

unMultiply()

IncisorAPI.js, line 7488

Performs a transformation on the bitmap data stored in this PixelsObject that approximates the reversal of "premultiplication" of images with transparency. Depending on the source of the content within this PixelsObject, you may want to invoke 'unMultiply' before writing it to an image on disk. This is because Incisor® primarily works with normal 'unmultiplied' source images and premultiplies images during runtime, so PixelsObjects created from composites of those premultiplied images will likely need to be unmultiplied prior to being written to disk to ensure that the resulting image is saved in the original 'unmultiplied' color space.

async writePngFile(filePath, isPathRelative (opt)) returns {IncrCommsResponseObject}

IncisorAPI.js, line 7463

Writes the bitmap from this PixelsObject to a ".png" file at the given path.

Parameters:

Name	Type	Attributes	Default	Description
filePath	string			The relative or absolute path to the file in question.
isPathRelative	boolean	<optional>		Bool stating if the given path is relative to the project path or an absolute path. If an absolute path is used that is outside of the project directory, the 'allowUniversalFileIO' item in application settings must be set to true. [DEFAULT: true]

Returns:

IncrCommsResponseObject -

[REQUIREMENT: user subscription access - 'fileIO']