Taos API Reference
    Preparing search index...

    Interface OceanFftSimOptions

    interface OceanFftSimOptions {
        strength?: number;
        chopStrength?: number;
        foamThreshold?: number;
        N?: number;
        tileSize?: number;
        windSpeed?: number;
        windDir?: { x: number; z: number };
        amplitude?: number;
        capillarySuppression?: number;
        seed?: number;
    }

    Hierarchy

    • OceanFftSpectrumOptions
      • OceanFftSimOptions
    Index

    Properties

    strength?: number

    Per-vertex strength of the FFT heightfield contribution. Default 1.

    chopStrength?: number

    Lateral chop strength (λ in the Jacobian). Scales the xz lateral displacement Tessendorf-style — gives the asymmetric breaking-wave profile rather than smooth rolling swell. Default 1.4.

    foamThreshold?: number

    Jacobian foam threshold — max(0, foamThreshold − J) is written into the FFT output's alpha channel for the surface shader to modulate foam intensity. Default 1.0 (foam where J < 1, i.e. surface starts compressing).

    N?: number

    Grid size along one axis. Power of two recommended. Default 64.

    tileSize?: number

    Side length of the spatial tile in meters. Default 128.

    windSpeed?: number

    Wind speed (m/s). Drives the Phillips spectrum's L = V²/g. Default 12.

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

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

    amplitude?: number

    Overall amplitude scaling. Default 0.0008 — tuned for tileSize 128 and windSpeed 12 to produce a wave field with ~0.5 m peak waves.

    capillarySuppression?: number

    Capillary suppression length (meters). Damps waves shorter than this to prevent jagged high-frequency noise that the discrete grid can't resolve. Default 0.5.

    seed?: number

    Seed for the Box-Muller Gaussian sampler — pass a fixed integer to reproduce the same spectrum across runs. Default uses Math.random.