Class: StencilMask

Defined in: node_modules/pixi.js/lib/rendering/mask/stencil/StencilMask.d.ts:15

A mask that uses the stencil buffer to clip the rendering of a container. This is useful for complex masks that cannot be achieved with simple shapes. It is more performant than using a Graphics mask, but requires WebGL support. It is also useful for masking with Container objects that have complex shapes.

Advanced

Implements

• Effect
• PoolItem

Constructors

Constructor

> new StencilMask(options): StencilMask

Defined in: node_modules/pixi.js/lib/rendering/mask/stencil/StencilMask.d.ts:20

Parameters

options

mask

Container

Returns

StencilMask

Properties

mask

> mask: Container

Defined in: node_modules/pixi.js/lib/rendering/mask/stencil/StencilMask.d.ts:18

---

pipe

> pipe: string

Defined in: node_modules/pixi.js/lib/rendering/mask/stencil/StencilMask.d.ts:19

Implementation of

Effect.pipe

---

priority

> priority: number

Defined in: node_modules/pixi.js/lib/rendering/mask/stencil/StencilMask.d.ts:17

Implementation of

Effect.priority

---

extension

> static extension: ExtensionMetadata

Defined in: node_modules/pixi.js/lib/rendering/mask/stencil/StencilMask.d.ts:16

Methods

addBounds()

> addBounds(bounds, skipUpdateTransform): void

Defined in: node_modules/pixi.js/lib/rendering/mask/stencil/StencilMask.d.ts:25

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/stencil/StencilMask.d.ts:26

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/stencil/StencilMask.d.ts:27

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/stencil/StencilMask.d.ts:28

Returns

void

Implementation of

Effect.destroy

---

init()

> init(mask): void

Defined in: node_modules/pixi.js/lib/rendering/mask/stencil/StencilMask.d.ts:23

Parameters

mask

Container

Returns

void

Implementation of

PoolItem.init

---

reset()

> reset(): void

Defined in: node_modules/pixi.js/lib/rendering/mask/stencil/StencilMask.d.ts:24

Returns

void

Implementation of

PoolItem.reset

---

test()

> static test(mask): boolean

Defined in: node_modules/pixi.js/lib/rendering/mask/stencil/StencilMask.d.ts:29

Parameters

mask

any

Returns

boolean