Taos API Reference
    Preparing search index...

    Interface SkyOptions

    interface SkyOptions {
        mode?: SkyMode;
        skyColor?: [number, number, number];
        skyTexture?: string;
        sunIntensity?: number;
        rayleigh?: number;
        mie?: number;
        ozone?: number;
        groundAlbedo?: [number, number, number];
        enableStars?: boolean;
        starsExtinction?: number;
        starsBrightness?: number;
        starsCatalog?: boolean;
        starsLowerHemisphere?: number;
        starsLatitude?: number;
        starsSiderealDeg?: number;
        planetMode?: boolean;
        planetRadius?: number;
        atmosphereHeight?: number;
        horizonless?: boolean;
    }
    Index

    Properties

    mode?: SkyMode

    Background source (Sky.mode). Default 'atmosphere'.

    skyColor?: [number, number, number]

    Flat sky color, linear RGB (Sky.skyColor). Adopted by reference.

    skyTexture?: string

    Equirectangular panorama path (Sky.skyTexture).

    sunIntensity?: number

    Sun radiance at the top of the atmosphere (Sky.sunIntensity).

    rayleigh?: number

    Rayleigh scattering multiplier (Sky.rayleigh).

    mie?: number

    Mie scattering multiplier (Sky.mie).

    ozone?: number

    Ozone absorption multiplier (Sky.ozone).

    groundAlbedo?: [number, number, number]

    Ground albedo (linear RGB) (Sky.groundAlbedo). Adopted by reference.

    enableStars?: boolean

    Render a procedural starfield (Sky.enableStars).

    starsExtinction?: number

    Star luminance extinction (Sky.starsExtinction).

    starsBrightness?: number

    Star brightness multiplier (Sky.starsBrightness).

    starsCatalog?: boolean

    Use the real Yale star catalog (Sky.starsCatalog).

    starsLowerHemisphere?: number

    Star lower-hemisphere wrap, 0..1 (Sky.starsLowerHemisphere).

    starsLatitude?: number

    Observer latitude for catalog orientation (Sky.starsLatitude).

    starsSiderealDeg?: number

    Sidereal rotation in degrees (Sky.starsSiderealDeg).

    planetMode?: boolean

    Spherical planet mode (Sky.planetMode).

    planetRadius?: number

    Planet surface radius (Sky.planetRadius).

    atmosphereHeight?: number

    Atmosphere shell thickness (Sky.atmosphereHeight).

    horizonless?: boolean

    Wrap the sky with no hard planet limb (Sky.horizonless).