Interface PaintMaskOnImageOptions

interface PaintMaskOnImageOptions {
    blend?: boolean;
    color?: (null | number)[];
    origin?: Point;
    out?: Image;
}

Properties

blend?: boolean

Whether the given color should be blended with the original pixel.

Default

true

color?: (null | number)[]

Color with which to blend the image pixel.

Default

Opaque black.
origin?: Point

Top-left corner of the mask relative to a parent image.

Default

{row: 0, column: 0}

out?: Image

Image to which to output.