Interface MaskOptions

Options for configuring mask behavior on a display object.

// Basic mask inversion
sprite.setMask({
    mask: graphics,
    inverse: true
});

interface MaskOptions {
inverse: boolean;
}

Properties

inverse: boolean

Whether the mask should be inverted. When true, the masked area becomes transparent and the unmasked area becomes visible.

false

// Invert the mask
sprite.setMask({
    mask: graphics,
    inverse: true
});