Taos API Reference
    Preparing search index...

    Interface GeoWaterSettings

    Live look controls, read each frame.

    interface GeoWaterSettings {
        opacity: number;
        tint: [number, number, number];
        sky: [number, number, number];
        skyBrightness: number;
        normalTileM: number;
        distortion: number;
        shoreFade: number;
        fresnelPower: number;
        specPower: number;
        normalScale: number;
        debug: boolean;
        sst?: boolean;
        sstStrength?: number;
        sstFalseColor?: boolean;
        sstContours?: boolean;
        sstContourStep?: number;
    }
    Index

    Properties

    opacity tint sky skyBrightness normalTileM distortion shoreFade fresnelPower specPower normalScale debug sst? sstStrength? sstFalseColor? sstContours? sstContourStep?

    Properties

    opacity: number

    Base opacity over deep water (a in the blend).

    tint: [number, number, number]

    Underwater tint color (deep water reads toward this).

    sky: [number, number, number]

    Grazing-angle (Fresnel) reflection color (the zenith sky-reflection color).

    skyBrightness: number

    Day→night brightness multiplier on the reflected sky (1 = full day, ~0 = night).

    normalTileM: number

    World meters one tile of the ripple normal map spans.

    distortion: number

    Screen-space refraction wobble (fraction of the screen).

    shoreFade: number

    Shoreline fade distance (meters of water depth over which it fades in).

    fresnelPower: number
    specPower: number
    normalScale: number

    Strength of the ripple normal perturbation.

    debug: boolean

    Flat opaque "Water Mask" debug view.

    sst?: boolean

    Living-world SST layer: modulate tint + clarity by real sea-surface temperature. Requires an sst provider on the feature. Default off.

    sstStrength?: number

    How strongly SST pushes the look away from the constant tint (0 = off, 1 = full). Default 1. Applies to the subtle-tint view only.

    sstFalseColor?: boolean

    False-color "study" view: paint the sea by the colormap LUT instead of tinting it. Default off.

    sstContours?: boolean

    Draw isotherm contour lines in the false-color view. Default off.

    sstContourStep?: number

    Contour interval in °C. Default 2.

    Settings

    Member Visibility

    On This Page

    Properties