Pixel Data JS - v0.28.0
    Preparing search index...

    Interface PixelMutateOptions

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

    interface PixelMutateOptions {
        h?: number;
        invertMask?: boolean;
        mask?: BinaryMask | null;
        mx?: number;
        my?: number;
        w?: number;
        x?: number;
        y?: number;
    }

    Hierarchy (View Summary)

    Index

    Properties

    h? invertMask? mask? mx? my? w? x? y?

    Properties

    h?: number

    The height of the region in the destination buffer.

    Source height.
    invertMask?: boolean

    If true the inverse of the mask will be applied

    false
    mask?: BinaryMask | null

    An optional mask to restrict where pixels are mutated.

    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 in the destination buffer.

    Source width.
    x?: number

    The starting X coordinate in the destination buffer.

    0
    y?: number

    The starting Y coordinate in the destination buffer.

    0

    Settings

    Member Visibility

    On This Page

    Properties