Documentation
    Preparing search index...

    Interface TurbulenceFieldOptions

    Options of turbulenceField.

    interface TurbulenceFieldOptions {
        amplitude?: number;
        frequency?: number;
        scroll?: Vector3;
    }
    Index
    amplitude?: number

    Hard per-component bound in units/s², default DEFAULT_TURBULENCE_AMPLITUDE: every returned component satisfies |componentᵢ| ≤ |amplitude|. It is a bound, not the typical magnitude — see the honesty note. A negative value mirrors the field; the bound uses the absolute value.

    frequency?: number

    Lattice cells per world unit, default DEFAULT_TURBULENCE_FREQUENCY. Must be finite and > 0. Higher means smaller eddies. It does not change the strength of the field — see the honesty note on normalisation.

    scroll?: Vector3

    World-space velocity at which the noise lattice drifts, in units/s, copied. Default (0, 0, 0), which makes the field completely time-independent.

    With a non-zero value the field is sampled at position − scroll · time, so sample(p, v, t) equals sample(p − scroll·t, v, 0) exactly. This is advection of a frozen pattern ("Taylor's frozen turbulence hypothesis"), not an evolving flow: an observer drifting with scroll sees a constant force forever. True 4D evolution is staged — it needs a fourth noise dimension, which costs 16 lattice hashes per scalar sample instead of 8.