Types - Environment#

API reference for ./evaluate/environment on @huukhanhnguyen/types.

See the Guide for the package's role.

API reference#

Signatures are generated from the live package .d.ts - not hand-written.

ResolvedEnvironment#

type

type ResolvedEnvironment
// = {
    sun?: Sun;
    skyColor?: string;
    groundColor?: string;
    skyLux?: number;
    hdri?: EnvironmentHdri;
}

Sun#

type

The sun as a lit direction — COMPUTED from Environment.site + moment, never stored. Absent from a ResolvedEnvironment whenever either input is missing; present with direction[2] < 0 when the site's sun is below the horizon at that moment, which is a night study, not an error.

type Sun
// = {
    /** Unit vector TOWARD the sun, Z-up world space. */
    direction: Vector;
    /** Direct illuminance (lux) at the model. */
    lux: number;
    /** Colour temperature (K). */
    kelvin?: number;
}