Class StencilMask`Advanced`

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.

Implements

Index

Constructors

Properties

mask pipe priority extension

Methods

addBounds addLocalBounds containsPoint destroy init reset test

Constructors

constructor

new StencilMask(options: { mask: Container }): StencilMask
Parameters
- options: { mask: Container }
Returns StencilMask

Properties

mask

mask: Container

pipe

pipe: string = 'stencilMask'

priority

priority: number = 0

`Static`extension

extension: ExtensionMetadata = ExtensionType.MaskEffect

Methods

addBounds

addBounds(bounds: Bounds, skipUpdateTransform: boolean): void
Parameters
- bounds: Bounds
- skipUpdateTransform: boolean
Returns void
Implementation of Effect.addBounds

addLocalBounds

addLocalBounds(bounds: Bounds, localRoot: Container): void
Parameters
- bounds: Bounds
- localRoot: Container
Returns void
Implementation of Effect.addLocalBounds

containsPoint

containsPoint(
point: Point,
hitTestFn: (container: Container, point: Point) => boolean,
): boolean
Parameters
- point: Point
- hitTestFn: (container: Container, point: Point) => boolean
Returns boolean
Implementation of Effect.containsPoint

destroy

destroy(): void
Returns void
Implementation of Effect.destroy

init

init(mask: Container): void
Parameters
- mask: Container
Returns void
Implementation of PoolItem.init

reset

reset(): void
Returns void
Implementation of PoolItem.reset

`Static`test

test(mask: any): boolean
Parameters
- mask: any
Returns boolean