Taos API Reference
    Preparing search index...

    Interface OceanFftSimOptions

    interface OceanFftSimOptions {
        strength?: number;
        chopStrength?: number;
        N?: number;
        windSpeed?: number;
        windDir?: { x: number; z: number };
        turbulence?: number;
        multiplier?: number;
        powerMultipliers?: number[];
        powerLog?: number[];
        seed?: number;
    }

    Hierarchy

    • OceanFftSpectrumOptions
      • OceanFftSimOptions
    Index

    Properties

    strength?: number

    Overall weight of the FFT contribution when the shape-combine pass folds it into the LOD cascade. Default 1.

    chopStrength?: number

    Lateral chop strength (λ) — scales the xz displacement Tessendorf-style for asymmetric, sharp-crested waves. Default 1.6 (Crest's spectrum default).

    N?: number

    Grid size along one axis of every cascade slice. Power of two. Default 128 — wave content is band-limited to 4..8 waves across the tile, so this sets spatial smoothness (16–32 texels per wave), not bandwidth.

    windSpeed?: number

    Wind speed (m/s). Sets the Pierson–Moskowitz peak — which wavelengths carry the most energy. Default 10.

    windDir?: { x: number; z: number }

    Unit-vector wind direction in world XZ. Default (1, 0).

    turbulence?: number

    Directional turbulence in [0, 1] — 0 aligns everything with the wind, 1 is fully isotropic. Default 0.145 (Crest's default).

    multiplier?: number

    Overall amplitude multiplier on the spectrum. Default 1.

    powerMultipliers?: number[]

    Optional per-octave power multipliers (index 0 = 0.0625 m wavelength octave, doubling each entry — Crest's 14 spectrum sliders). Default all 1 (pure Pierson–Moskowitz shape).

    powerLog?: number[]

    Crest-exact spectrum: the 14 per-octave _powerLog slider values (log10 of linear power; octave 0 = 0.0625 m wavelength, doubling each entry). When given, the power curve is 10^powerLog linearly interpolated across the octave axis — bit-matching Crest's _SpectrumControls texture sample — INSTEAD of the Pierson–Moskowitz base (the PM wind term still applies, as in Crest). Takes precedence over powerMultipliers.

    seed?: number

    Seed for the Gaussian sampler — fixed integer reproduces the same sea across runs. Default uses Math.random.