threejs-worldgen
    Preparing search index...

    Interface SkyProps

    Props of <Sky>: every SkyInput setting plus the ones below.

    interface SkyProps {
        atmosphere?: DeepPartial<AtmosphereOptions>;
        camera?: Camera;
        children?: ReactNode;
        clock?: DeepPartial<ClockOptions>;
        clouds?: DeepPartial<CloudOptions>;
        lighting?: DeepPartial<LightingOptions>;
        moon?: DeepPartial<MoonDiscOptions>;
        nightLights?: DeepPartial<NightLightsOptions>;
        observer?: DeepPartial<ObserverOptions>;
        ref?: Ref<Sky | null>;
        seed?: string | number;
        shells?: DeepPartial<ShellsOptions>;
        shootingStars?: DeepPartial<ShootingStarsOptions>;
        stars?: DeepPartial<StarsOptions>;
        sun?: DeepPartial<SunDiscOptions>;
        system?: SystemInput;
        world?: WorldLike;
    }

    Hierarchy (View Summary)

    Index
    atmosphere? camera? children? clock? clouds? lighting? moon? nightLights? observer? ref? seed? shells? shootingStars? stars? sun? system? world?
    atmosphere?: DeepPartial<AtmosphereOptions>

    Atmosphere physics.

    camera?: Camera

    Camera the observer follows. Defaults to the R3F default camera.

    children?: ReactNode

    Children see the sky through useSky() / useSkyTime(). Rendered once the sky is ready.

    clock?: DeepPartial<ClockOptions>

    Time: date, time scale, day length, pause.

    clouds?: DeepPartial<CloudOptions>

    Sparse Gaussian clouds.

    lighting?: DeepPartial<LightingOptions>

    Lights, environment, fog and exposure.

    moon?: DeepPartial<MoonDiscOptions>

    Moon disc and moonlit sky.

    nightLights?: DeepPartial<NightLightsOptions>

    City lights on the night side, seen from altitude.

    observer?: DeepPartial<ObserverOptions>

    Where the observer is and how render space maps onto the planet.

    ref?: Ref<Sky | null>

    Receives the underlying Sky instance.

    seed?: string | number

    Seeds the stars, meteors and procedural planets (unless they set their own seed).

    shells?: DeepPartial<ShellsOptions>

    Labelled altitude shells (troposphere, ionosphere, Kármán line, apogee). Off by default.

    shootingStars?: DeepPartial<ShootingStarsOptions>

    Meteors.

    stars?: DeepPartial<StarsOptions>

    Star field and Milky Way.

    sun?: DeepPartial<SunDiscOptions>

    Sun disc.

    system?: SystemInput

    Star system overrides.

    world?: WorldLike

    A threejs-biomes World: sets the planet radius and observer position for planet worlds.

    Settings
    Member Visibility

    On This Page
    Properties