Component for masked elements.

Holds mask mode and temporary data about current mask.

Memberof

PIXI

Constructors

  • Create MaskData

    Parameters

    • Optional maskObject: IMaskTarget

      object that describes the mask

    Returns MaskData

Properties

autoDetect: boolean

Whether we know the mask type beforehand

Default

true
colorMask: number

Color mask.

See

PIXI.COLOR_MASK_BITS

enabled: boolean

If enabled is true the mask is applied, if false it will not.

isMaskData: boolean

Indicator of the type (always true for PIXI.MaskData objects)

maskObject: IMaskTarget

Which element we use to mask

Member

multisample: null | MSAA_QUALITY

Number of samples of the sprite mask filter. If set to null, the sample count of the current render target is used.

Default

PIXI.Filter.defaultMultisample
pooled: boolean

Whether it belongs to MaskSystem pool

resolution: null | number

Resolution of the sprite mask filter. If set to null or 0, the resolution of the current render target is used.

Default

null

Mask type

Accessors

  • get filter(): ISpriteMaskFilter
  • The sprite mask filter. If set to null, the default sprite mask filter is used.

    Returns ISpriteMaskFilter

    Default

    null
    
  • set filter(value): void
  • Parameters

    Returns void

Methods

  • Copies counters from maskData above, called from pushMask().

    Parameters

    Returns void

  • Resets the mask data after popMask().

    Returns void

Generated using TypeDoc