PIXI.MaskData

class MaskData

Component for masked elements.

Holds mask mode and temporary data about current mask.

Constructor

new PIXI.MaskData(maskObject: PIXI.DisplayObject) → {}

Create MaskData

Parameters:
Name	Type	Attributes	Default	Description
maskObject	PIXI.DisplayObject	<optional>	null	object that describes the mask

boolean	autoDetect = true
PIXI.COLOR_MASK_BITS	colorMask Color mask.
boolean	enabled If enabled is true the mask is applied, if false it will not.
ISpriteMaskFilter	filter = null
boolean	isMaskData Indicator of the type (always true for MaskData objects)
PIXI.DisplayObject	maskObject
PIXI.MSAA_QUALITY	multisample = PIXI.settings.FILTER_MULTISAMPLE
boolean	pooled Whether it belongs to MaskSystem pool
number	resolution = null
PIXI.MASK_TYPES	type Mask type

void

void

reset()

Resets the mask data after popMask().

autoDetect MaskData.ts:30

autoDetect: boolean = true

Whether we know the mask type beforehand

colorMask MaskData.ts:65

colorMask: PIXI.COLOR_MASK_BITS

Color mask.

enabled MaskData.ts:62

enabled: boolean

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

filter MaskData.ts:137

filter: ISpriteMaskFilter = null

The sprite mask filter. If set to null, the default sprite mask filter is used.

isMaskData MaskData.ts:45

isMaskData: boolean

Indicator of the type (always true for MaskData objects)

maskObject MaskData.ts:36

maskObject: PIXI.DisplayObject

Which element we use to mask

multisample MaskData.ts:55

multisample: PIXI.MSAA_QUALITY = PIXI.settings.FILTER_MULTISAMPLE

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

pooled MaskData.ts:42

pooled: boolean

Whether it belongs to MaskSystem pool

resolution MaskData.ts:48

resolution: number = null

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

type MaskData.ts:27

type: PIXI.MASK_TYPES

Mask type

copyCountersOrReset MaskData.ts:182

copyCountersOrReset(maskAbove: PIXI.MaskData) → {void}

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

Parameters:
Name	Type	Attributes	Description
maskAbove	PIXI.MaskData	<optional>

Returns:
Type	Description
void

reset MaskData.ts:166

reset() → {void}

Resets the mask data after popMask().

Returns:
Type	Description
void