pixi.js
Version:
<p align="center"> <a href="https://pixijs.com" target="_blank" rel="noopener noreferrer"> <img height="150" src="https://files.pixijs.download/branding/pixijs-logo-transparent-dark.svg?v=1" alt="PixiJS logo"> </a> </p> <br/> <p align="center">
32 lines (31 loc) • 1.34 kB
TypeScript
import type { ExtensionMetadata } from '../../../extensions/Extensions';
import type { Point } from '../../../maths/point/Point';
import type { Bounds } from '../../../scene/container/bounds/Bounds';
import type { Container } from '../../../scene/container/Container';
import type { Effect } from '../../../scene/container/Effect';
import type { PoolItem } from '../../../utils/pool/Pool';
/**
* AlphaMask is an effect that applies a mask to a container using the alpha channel of a sprite.
* It can be used to create complex masking effects by using a sprite as the mask.
* The mask can be inverted, and it can render the mask to a texture if the mask is not a sprite.
* @category rendering
* @advanced
*/
export declare class AlphaMask implements Effect, PoolItem {
static extension: ExtensionMetadata;
priority: number;
mask: Container;
inverse: boolean;
pipe: string;
renderMaskToTexture: boolean;
constructor(options?: {
mask: Container;
});
init(mask: Container): void;
reset(): void;
addBounds(bounds: Bounds, skipUpdateTransform?: boolean): void;
addLocalBounds(bounds: Bounds, localRoot: Container): void;
containsPoint(point: Point, hitTestFn: (container: Container, point: Point) => boolean): boolean;
destroy(): void;
static test(mask: any): boolean;
}