PixiJS

Class: MaskData

PIXI.MaskData

Component for masked elements

Holds mask mode and temporary data about current mask

new PIXI.MaskData (maskObject)

MaskData.js:12

Create MaskData

Name Type Default Description
maskObject PIXI.DisplayObject null optional

object that describes the mask

Members

_scissorRect PIXI.Rectangle

Scissor operation above the mask in stack. Null if _scissorCounter is zero, rectangle instance if positive.

autoDetect boolean

Whether we know the mask type beforehand

Default Value:
  • true

isMaskData boolean

Indicator of the type

maskObject PIXI.DisplayObject

Which element we use to mask

pooled boolean

Whether it belongs to MaskSystem pool

type PIXI.MASK_TYPES

Mask type

Methods

copyCountersOrReset (maskAbove)

MaskData.js:89

copies counters from maskData above, called from pushMask()

Name Type Description
maskAbove PIXI.MaskData | null

reset ()

MaskData.js:75

resets the mask data after popMask()