Class: ScissorMask

Defined in: node_modules/pixi.js/lib/rendering/mask/scissor/ScissorMask.d.ts:14

ScissorMask is an effect that applies a scissor mask to a container. It restricts rendering to the area defined by the mask. The mask is a Container that defines the area to be rendered. The mask must be a Container that is not renderable or measurable. This effect is used to create clipping regions in the rendering process.

Advanced

Implements

• Effect

Constructors

Constructor

> new ScissorMask(mask): ScissorMask

Defined in: node_modules/pixi.js/lib/rendering/mask/scissor/ScissorMask.d.ts:18

Parameters

mask

Container

Returns

ScissorMask

Properties

mask

> mask: Container

Defined in: node_modules/pixi.js/lib/rendering/mask/scissor/ScissorMask.d.ts:16

---

pipe

> pipe: string

Defined in: node_modules/pixi.js/lib/rendering/mask/scissor/ScissorMask.d.ts:17

Implementation of

Effect.pipe

---

priority

> priority: number

Defined in: node_modules/pixi.js/lib/rendering/mask/scissor/ScissorMask.d.ts:15

Implementation of

Effect.priority

Methods

addBounds()

> addBounds(bounds, skipUpdateTransform?): void

Defined in: node_modules/pixi.js/lib/rendering/mask/scissor/ScissorMask.d.ts:19

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/scissor/ScissorMask.d.ts:20

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/scissor/ScissorMask.d.ts:21

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/scissor/ScissorMask.d.ts:23

Returns

void

Implementation of

Effect.destroy

---

reset()

> reset(): void

Defined in: node_modules/pixi.js/lib/rendering/mask/scissor/ScissorMask.d.ts:22

Returns

void