pixel-data-js
    Preparing search index...

    Interface PixelOptions

    Configuration for pixel manipulation operations. Designed to be used by spreading a Rect object ({x, y, w, h}) directly.

    interface PixelOptions {
        alpha?: number;
        h?: number;
        invertMask?: boolean;
        mask?: AnyMask | null;
        maskType?: MaskType;
        mw?: number;
        mx?: number;
        my?: number;
        w?: number;
        x?: number;
        y?: number;
    }

    Hierarchy (View Summary)

    Index

    Properties

    alpha? h? invertMask? mask? maskType? mw? mx? my? w? x? y?

    Properties

    alpha?: number

    Overall layer opacity 0-255.

    255
    h?: number

    The height of the region to process.

    Source height.

    invertMask?: boolean

    If true the inverse of the mask will be applied

    mask?: AnyMask | null

    An optional mask to restrict where pixels are written.

    maskType?: MaskType

    The interpretation logic for the provided mask. Defaults to MaskType.Binary.

    mw?: number

    Mask width.

    w
    mx?: number

    X offset into the mask buffer.

    0
    my?: number

    Y offset into the mask buffer.

    0
    w?: number

    The width of the region to process.

    Source width.

    x?: number

    The starting X coordinate in the destination buffer.

    y?: number

    The starting Y coordinate in the destination buffer.

    Settings

    Member Visibility

    On This Page

    Properties