Create MaskData
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
maskObject |
PIXI.DisplayObject |
<optional> |
null |
object that describes the mask |
Members
Whether we know the mask type beforehand
- Default Value:
- true
Color mask.
- See:
If enabled is true the mask is applied, if false it will not.
The sprite mask filter.
If set to null, the default sprite mask filter is used.
- Default Value:
- null
Indicator of the type (always true for PIXI.MaskData objects)
maskObject PIXI.DisplayObject
Which element we use to mask
multisample PIXI.MSAA_QUALITY | null
Number of samples of the sprite mask filter.
If set to null, the sample count of the current render target is used.
- Default Value:
- PIXI.Filter.defaultMultisample
Whether it belongs to MaskSystem pool
Resolution of the sprite mask filter.
If set to null or 0, the resolution of the current render target is used.
- Default Value:
- null
type PIXI.MASK_TYPES
Mask type
Methods
Copies counters from maskData above, called from pushMask().
| Name | Type | Attributes | Description |
|---|---|---|---|
maskAbove |
PIXI.MaskData |
<optional> |
Resets the mask data after popMask().