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)

Properties

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

Properties

Optionallabel

label?: string

Optional label of the Light.

Optionalcolor

color?: Vec3

The Light color. Default to Vec3(1).

Optionalintensity

intensity?: number

The Light intensity. Default to 1.

Optionalposition

position?: Vec3

The SpotLight position. Default to Vec3(1).

Optionaltarget

target?: Vec3

The SpotLight target. Default to Vec3(0).

Optionalangle

angle?: number

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

Optionalpenumbra

penumbra?: number

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

Optionalrange

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.

Optionalshadow

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