Renderer · function

seaStateForAgitation

The same surface state, asked for directly instead of derived from wind.

Explained in Hello world.

function seaStateForAgitation(agitation: number): SeaState
import { seaStateForAgitation } from '@driftengine/core';

Parameters

ParameterTypeDescription
agitationnumber

In depth

Shares this module's floor and ceiling so an indoor body and an outdoor one at the same roughness look the same — the point is where the number comes from, not a second scale with its own feel. Foam is deliberately reachable: a sluice or a pump outfall breaks without any wind at all.