Taos API Reference
    Preparing search index...

    Interface OceanWaveSpec

    interface OceanWaveSpec {
        direction: { x: number; z: number };
        amplitude: number;
        wavelength: number;
        steepness: number;
        phase?: number;
    }
    Index

    Properties

    direction amplitude wavelength steepness phase?

    Properties

    direction: { x: number; z: number }

    xz plane unit vector — host should normalize; shader re-normalizes too.

    amplitude: number

    World-unit wave height (half peak-to-trough).

    wavelength: number

    Wavelength in world units. Drives the dispersion frequency sqrt(g*k).

    steepness: number

    Choppiness in [0, 1]; 0 = flat sinusoid, ~0.9 = sharp peaks / flat troughs.

    phase?: number

    Constant phase offset, in radians. Use to de-correlate same-direction waves.

    Settings

    Member Visibility

    On This Page

    Properties