Class: AlphaMask

Defined in: node_modules/pixi.js/lib/rendering/mask/alpha/AlphaMask.d.ts:16

AlphaMask is an effect that applies a mask to a container using a sprite texture. By default, the red channel of the mask texture controls visibility. Set channel to 'alpha' to use the alpha channel instead, which is useful for masks defined by transparency. The mask can be inverted, and non-sprite masks are rendered to a texture automatically.

Advanced

Implements

• Effect
• PoolItem

Constructors

Constructor

> new AlphaMask(options?): AlphaMask

Defined in: node_modules/pixi.js/lib/rendering/mask/alpha/AlphaMask.d.ts:24

Parameters

options?

mask

Container

Returns

AlphaMask

Properties

channel

> channel: MaskChannel

Defined in: node_modules/pixi.js/lib/rendering/mask/alpha/AlphaMask.d.ts:21

---

inverse

> inverse: boolean

Defined in: node_modules/pixi.js/lib/rendering/mask/alpha/AlphaMask.d.ts:20

---

mask

> mask: Container

Defined in: node_modules/pixi.js/lib/rendering/mask/alpha/AlphaMask.d.ts:19

---

pipe

> pipe: string

Defined in: node_modules/pixi.js/lib/rendering/mask/alpha/AlphaMask.d.ts:22

Implementation of

Effect.pipe

---

priority

> priority: number

Defined in: node_modules/pixi.js/lib/rendering/mask/alpha/AlphaMask.d.ts:18

Implementation of

Effect.priority

---

renderMaskToTexture

> renderMaskToTexture: boolean

Defined in: node_modules/pixi.js/lib/rendering/mask/alpha/AlphaMask.d.ts:23

---

extension

> static extension: ExtensionMetadata

Defined in: node_modules/pixi.js/lib/rendering/mask/alpha/AlphaMask.d.ts:17

Methods

addBounds()

> addBounds(bounds, skipUpdateTransform?): void

Defined in: node_modules/pixi.js/lib/rendering/mask/alpha/AlphaMask.d.ts:29

Parameters

bounds

Bounds

skipUpdateTransform?

boolean

Returns

void

Implementation of

Effect.addBounds

---

addLocalBounds()

> addLocalBounds(bounds, localRoot): void

Defined in: node_modules/pixi.js/lib/rendering/mask/alpha/AlphaMask.d.ts:30

Parameters

bounds

Bounds

localRoot

Container

Returns

void

Implementation of

Effect.addLocalBounds

---

containsPoint()

> containsPoint(point, hitTestFn): boolean

Defined in: node_modules/pixi.js/lib/rendering/mask/alpha/AlphaMask.d.ts:31

Parameters

point

Point

hitTestFn

(container, point) => boolean

Returns

boolean

Implementation of

Effect.containsPoint

---

destroy()

> destroy(): void

Defined in: node_modules/pixi.js/lib/rendering/mask/alpha/AlphaMask.d.ts:32

Returns

void

Implementation of

Effect.destroy

---

init()

> init(mask): void

Defined in: node_modules/pixi.js/lib/rendering/mask/alpha/AlphaMask.d.ts:27

Parameters

mask

Container

Returns

void

Implementation of

PoolItem.init

---

reset()

> reset(): void

Defined in: node_modules/pixi.js/lib/rendering/mask/alpha/AlphaMask.d.ts:28

Returns

void

Implementation of

PoolItem.reset

---

test()

> static test(mask): boolean

Defined in: node_modules/pixi.js/lib/rendering/mask/alpha/AlphaMask.d.ts:33

Parameters

mask

any

Returns

boolean