gpu-curtains
    Preparing search index...

    Interface SpotLightBaseParams

    Base parameters used to create a SpotLight.

    interface SpotLightBaseParams {
        label?: string;
        color?: Vec3;
        intensity?: number;
        position?: Vec3;
        target?: Vec3;
        angle?: number;
        penumbra?: number;
        range?: number;
        shadow?: Omit<ShadowBaseParams, "light">;
    }

    Hierarchy (View Summary)

    Index

    Properties

    label? color? intensity? position? target? angle? penumbra? range? shadow?

    Properties

    label?: string

    Optional label of the Light.

    color?: Vec3

    The Light color. Default to Vec3(1).

    intensity?: number

    The Light intensity. Default to 1.

    position?: Vec3

    The SpotLight position. Default to Vec3(1).

    target?: Vec3

    The SpotLight target. Default to Vec3(0).

    angle?: number

    Maximum angle of light dispersion from its direction whose upper bound is PI / 2. Default to PI / 3.

    penumbra?: number

    Percent of the spotlight cone that is attenuated due to penumbra. Takes values between 0 and 1. Default is 0.

    range?: number

    The SpotLight range, used to compute the SpotLight attenuation over distance. When range is zero, light will attenuate according to inverse-square law to infinite distance. When range is non-zero, light will attenuate according to inverse-square law until near the distance cutoff, where it will then attenuate quickly and smoothly to 0. Inherently, cutoffs are not physically correct. Default to 0.

    shadow?: Omit<ShadowBaseParams, "light">

    The SpotLight shadow parameters used to create a SpotShadow. If not set, the SpotShadow won't be set as active and won't cast any shadows. On the other hand, if anything is passed (even an empty object), the SpotShadow will start casting shadows, so use with caution. Default to null (which means the SpotLight will not cast shadows).

    Settings

    Member Visibility

    On This Page

    Properties