threejs-worldgen
    Preparing search index...

    Interface StarsProps

    Props of <Stars>: every StarsInput setting plus ref.

    interface StarsProps {
        brightness?: number;
        darkSky?: number;
        density?: number;
        enabled?: boolean;
        magnitudeLimit?: number;
        milkyWay?: DeepPartial<MilkyWayOptions>;
        ref?: Ref<Stars | null>;
        saturation?: number;
        seed?: string | number;
        size?: number;
        twinkle?: number;
        twinkleSpeed?: number;
    }

    Hierarchy (View Summary)

    Index
    brightness? darkSky? density? enabled? magnitudeLimit? milkyWay? ref? saturation? seed? size? twinkle? twinkleSpeed?
    brightness?: number

    Overall star brightness.

    darkSky?: number

    Sky luminance (renderer units) of a truly dark sky; brighter skies lower the limiting magnitude.

    density?: number

    Multiplier on how many stars each cell layer holds, 0..1.5.

    enabled?: boolean

    Draw stars (and the Milky Way).

    magnitudeLimit?: number

    Faintest magnitude shown under a perfectly dark sky (6 ≈ naked eye, 8 = binoculars-rich).

    milkyWay?: DeepPartial<MilkyWayOptions>

    Milky Way settings.

    ref?: Ref<Stars | null>

    Receives the underlying Stars instance.

    saturation?: number

    Colour saturation of star tints, 0 (white) .. 2.

    seed?: string | number

    Seed for star positions, brightness and colours.

    size?: number

    Star size in pixels (they're points, so keep it ~1).

    twinkle?: number

    Twinkle strength, 0..1. Grows towards the horizon.

    twinkleSpeed?: number

    Twinkle speed multiplier.

    Settings
    Member Visibility

    On This Page
    Properties