new PIXI.MaskSystem (renderer) overrides
Name | Type | Description |
---|---|---|
renderer |
PIXI.Renderer |
The renderer this System works for. |
Extends
Members
Current index of alpha mask pool
- Default Value:
- 0
alphaMaskPool Array<PIXI.SpriteMaskFilter>
Pool of used sprite mask filters
Enable scissor masking.
maskDataPool Array<PIXI.MaskData>
Pool of mask data
Methods
Sets type of MaskData based on its maskObject
Name | Type | Description |
---|---|---|
maskData |
PIXI.MaskData |
Removes the last mask from the mask stack and doesn't return it.
NOTE: The batch renderer should be flushed beforehand to render the masked contents before the mask is removed.
Name | Type | Description |
---|---|---|
target |
PIXI.DisplayObject |
Display Object to pop the mask from |
Removes the last filter from the filter stack and doesn't return it.
Enables the mask and appends it to the current mask stack.
NOTE: The batch renderer should be flushed beforehand to prevent pending renders from being masked.
Name | Type | Description |
---|---|---|
target |
PIXI.DisplayObject |
Display Object to push the mask to |
maskData |
PIXI.MaskData | PIXI.Sprite | PIXI.Graphics | PIXI.DisplayObject |
The masking data. |
Applies the Mask and adds it to the current filter stack.
Name | Type | Description |
---|---|---|
maskData |
PIXI.MaskData |
Sprite to be used as the mask |
Changes the mask stack that is used by this System.
Name | Type | Description |
---|---|---|
maskStack |
Array<PIXI.MaskData> |
The mask stack |
Inherited Properties
From class PIXI.System
renderer PIXI.Renderer inherited
The renderer this manager works for.
Inherited Methods
From class PIXI.System
destroy () void inherited
Generic destroy methods to be overridden by the subclass