Hilo3d API - v2.0.0-alpha.9
    Preparing search index...

    Interface DecalProjectorOptions

    Parameters of a bounded world-space decal, projected along its local negative Z axis.

    interface DecalProjectorOptions {
        affectsRoughness?: boolean;
        atlasRect?: readonly [number, number, number, number];
        color?: Readonly<Color>;
        distanceFade?: number;
        edgeFade?: number;
        enabled?: boolean;
        layer?: number;
        maxDistance?: number;
        normalFade?: number;
        normalScale?: number;
        normalThreshold?: number;
        opacity?: number;
        order?: number;
        roughness?: number;
        transform?: Readonly<Matrix4>;
    }
    Index
    affectsRoughness? atlasRect? color? distanceFade? edgeFade? enabled? layer? maxDistance? normalFade? normalScale? normalThreshold? opacity? order? roughness? transform?
    affectsRoughness?: boolean

    Whether roughness is changed, even without a roughness atlas. Defaults to false.

    atlasRect?: readonly [number, number, number, number]

    Top-left atlas rectangle [x, y, width, height] in normalized coordinates. Defaults to full atlas.

    color?: Readonly<Color>

    Linear base-color multiplier; alpha also modulates opacity. Copied; defaults to white.

    distanceFade?: number

    Inward distance fade in world units. Defaults to one, clamped to maxDistance.

    edgeFade?: number

    Inward XY boundary fade as a fraction of projector width/height, in [0, 0.5]. Defaults to 0.01.

    enabled?: boolean

    Whether the projector contributes. Defaults to true.

    layer?: number

    Receiver material mask; a zero intersection excludes this projector. Defaults to all bits.

    maxDistance?: number

    Maximum receiver distance from the camera in world units. Defaults to 10000.

    normalFade?: number

    Smooth angular transition above normalThreshold, in [0, 1]. Defaults to 0.1.

    normalScale?: number

    Tangent-space normal strength in [0, 4]. Defaults to one.

    normalThreshold?: number

    Minimum dot product of receiver normal and projector outward normal, in [0, 1]. Defaults to 0.

    opacity?: number

    Coverage multiplier in [0, 1]. Defaults to one.

    order?: number

    Increasing overlap order; equal orders preserve authored membership order. Defaults to zero.

    roughness?: number

    Roughness multiplier/constant in [0, 1]. Defaults to one.

    transform?: Readonly<Matrix4>

    Maps the local [-0.5, 0.5] projection cube into world space. Copied; defaults to identity.

    Settings
    Member Visibility

    On This Page
    Properties