Strata - v1.4.10
    Preparing search index...

    Interface DecalPoolRef

    Ref interface for DecalPool imperative control.

    interface DecalPoolRef {
        addDecal: (
            position: [number, number, number] | Vector3,
            normal: [number, number, number] | Vector3,
            options?: {
                color?: ColorRepresentation;
                fadeTime?: number;
                rotation?: number;
                size?: number | [number, number];
                texture?: Texture<unknown>;
            },
        ) => string;
        clear: () => void;
        count: number;
        removeDecal: (id: string) => boolean;
    }
    Index

    Properties

    addDecal clear count removeDecal

    Properties

    addDecal: (
        position: [number, number, number] | Vector3,
        normal: [number, number, number] | Vector3,
        options?: {
            color?: ColorRepresentation;
            fadeTime?: number;
            rotation?: number;
            size?: number | [number, number];
            texture?: Texture<unknown>;
        },
    ) => string

    Add a new decal to the pool. Returns a unique ID.

    clear: () => void

    Clear all decals from the pool.

    count: number

    Current number of active decals.

    removeDecal: (id: string) => boolean

    Manually remove a decal by ID.

    Settings

    Member Visibility

    On This Page

    Properties