threejs-worldgen
    Preparing search index...

    Interface WaterProps

    Props of <Water>: the settings both surfaces share, plus per-surface overrides.

    interface WaterProps {
        camera?: Camera;
        environment?: Texture<unknown, TextureEventMap> | null;
        ocean?: false | OceanInput;
        origin?: [x: number, y: number, z: number];
        rivers?: false | Partial<RiversSettings>;
        sun?: DirectionalLight | null;
        world: World;
    }

    Hierarchy

    Index
    camera? environment? ocean? origin? rivers? sun? world
    camera?: Camera

    Camera. Defaults to the R3F default camera.

    environment?: Texture<unknown, TextureEventMap> | null

    Environment reflected (an equirect or cube texture, prefiltered for you). null = the sky colours. Object input.

    ocean?: false | OceanInput

    Ocean settings, or false for no ocean.

    origin?: [x: number, y: number, z: number]

    Floating origin shared by both surfaces.

    rivers?: false | Partial<RiversSettings>

    River settings, or false for no rivers.

    sun?: DirectionalLight | null

    Light for the sun glint and daylight. null = the first DirectionalLight found in the scene. Object input.

    world: World

    The world.

    Settings
    Member Visibility

    On This Page
    Properties