Taos API Reference
    Preparing search index...

    Interface SkyDoc

    interface SkyDoc {
        type: "Sky";
        mode?: "color" | "texture" | "atmosphere" | "stars";
        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

    type mode? skyColor? skyTexture? sunIntensity? rayleigh? mie? ozone? groundAlbedo? enableStars? starsExtinction? starsBrightness? starsCatalog? starsLowerHemisphere? starsLatitude? starsSiderealDeg? planetMode? planetRadius? atmosphereHeight? horizonless?

    Properties

    type: "Sky"
    mode?: "color" | "texture" | "atmosphere" | "stars"

    How the sky background is produced: procedural 'atmosphere', a flat 'color', an equirectangular 'texture', or a dark 'stars' field.

    skyColor?: [number, number, number]

    Flat sky color (linear RGB) for mode === 'color' / 'stars'.

    skyTexture?: string

    Project-root-relative panorama path for mode === 'texture'.

    sunIntensity?: number
    rayleigh?: number
    mie?: number
    ozone?: number
    groundAlbedo?: [number, number, number]
    enableStars?: boolean
    starsExtinction?: number
    starsBrightness?: number

    Star brightness multiplier (catalog stars).

    starsCatalog?: boolean

    Render the real Yale catalog instead of the procedural field.

    starsLowerHemisphere?: number

    0 clamps stars to the upper hemisphere; 1 wraps the full sphere.

    starsLatitude?: number

    Observer latitude (degrees, +N) for catalog star orientation.

    starsSiderealDeg?: number

    Sidereal rotation of the catalog sky (degrees about the pole).

    planetMode?: boolean
    planetRadius?: number
    atmosphereHeight?: number
    horizonless?: boolean

    Settings

    Member Visibility

    On This Page

    Properties