Interface SkyParams

interface SkyParams {
    enabled?: boolean;
    groundColor?: [number, number, number];
    horizonBlend?: number;
    horizonColor?: [number, number, number];
    skyColor?: [number, number, number];
    sunAngularSize?: number;
    sunColor?: [number, number, number];
    sunDirection?: [number, number, number];
    sunEnabled?: boolean;
    sunGlowIntensity?: number;
    sunGlowSize?: number;
    worldUp?: [number, number, number];
}

Properties

enabled? groundColor? horizonBlend? horizonColor? skyColor? sunAngularSize? sunColor? sunDirection? sunEnabled? sunGlowIntensity? sunGlowSize? worldUp?

Properties

Optionalenabled

enabled?: boolean

Whether to draw the procedural sky background at all. When false, the renderer falls through to whatever was already in the clear buffer. Default true.

OptionalgroundColor

groundColor?: [number, number, number]

Below-horizon ground colour. Default [0.58, 0.64, 0.60].

OptionalhorizonBlend

horizonBlend?: number

Angular width of the horizon blend band. Default 0.5.

OptionalhorizonColor

horizonColor?: [number, number, number]

Horizon colour. Default [0.66, 0.72, 0.74].

OptionalskyColor

skyColor?: [number, number, number]

Sky zenith colour. Default [0.74, 0.80, 0.88].

OptionalsunAngularSize

sunAngularSize?: number

Sun disc angular diameter in degrees. Default 3.

OptionalsunColor

sunColor?: [number, number, number]

Sun disc + corona colour. Default [1.0, 0.97, 0.82].

OptionalsunDirection

sunDirection?: [number, number, number]

World-space direction toward the sun (sign is the opposite of a DirLight's dir, which points the way photons travel). Need not be normalized. Default [0.577, 0.577, 0.577].

OptionalsunEnabled

sunEnabled?: boolean

Draw a sun disc + glow. Default true.

OptionalsunGlowIntensity

sunGlowIntensity?: number

Peak intensity of the sun glow. Default 0.25.

OptionalsunGlowSize

sunGlowSize?: number

Exponent controlling how tightly the glow hugs the disc. Default 16.

OptionalworldUp

worldUp?: [number, number, number]

World-space "up" direction. Default [0, 0, 1] (Z-up).

Settings

Member Visibility

On This Page

Properties