UNPKG

1.05 kBTypeScriptView Raw
1import { AbstractMaskSystem } from './AbstractMaskSystem';
2import type { ExtensionMetadata } from '@pixi/extensions';
3import type { Renderer } from '../Renderer';
4import type { IMaskTarget, MaskData } from './MaskData';
5/**
6 * System plugin to the renderer to manage stencils (used for masks).
7 * @memberof PIXI
8 */
9export declare class StencilSystem extends AbstractMaskSystem {
10 /** @ignore */
11 static extension: ExtensionMetadata;
12 /**
13 * @param renderer - The renderer this System works for.
14 */
15 constructor(renderer: Renderer);
16 getStackLength(): number;
17 /**
18 * Applies the Mask and adds it to the current stencil stack.
19 * @param maskData - The mask data
20 */
21 push(maskData: MaskData): void;
22 /**
23 * Pops stencil mask. MaskData is already removed from stack
24 * @param {PIXI.DisplayObject} maskObject - object of popped mask data
25 */
26 pop(maskObject: IMaskTarget): void;
27 /**
28 * Setup renderer to use the current stencil data.
29 * @private
30 */
31 _useCurrent(): void;
32}