Skip to content

A fast 2D and 3D game engine — TypeScript SDK, C++/WebAssembly core, visual editor. Ship one project to web, desktop, WeChat MiniGames, playable ads, and native Android / iOS.

875 B
Raw Blame
// SPDX-License-Identifier: Apache-2.0
// SPDX-FileCopyrightText: Copyright (c) 2024-present ESEngine Team
import { defineBuiltin } from '../../ecs/component';

// Scissor clips to an axis-aligned rectangle and costs nothing; Stencil clips to
// the mask's own shape. Single-sourced from the C++ ES_ENUM via the generated
// module, so the number this writes is the number the renderer reads.
export { MaskMode } from '../../wasm/wasm.generated';
import { MaskMode } from '../../wasm/wasm.generated';

export interface UIMaskData {
    enabled: boolean;
    mode: MaskMode;
    /** Stencil mode only: above 0, clip to the SHAPE the mask sprite draws
     *  instead of to its box (0, the default, keeps the box). */
    alphaCutoff: number;
}

export const UIMask = defineBuiltin<UIMaskData>('UIMask', {
    enabled: true,
    mode: MaskMode.Scissor,
    alphaCutoff: 0,
});