ReadonlynameWhen false, the feature is skipped each frame. Toggling triggers a cached-graph invalidation.
Enable shallow-water wave attenuation around a circular shoal (e.g. an
island): waves shrink toward the shore where the water shallows. The
water depth at world distance d from (centerX, centerZ) is taken as
max(d − shoreRadius, 0) · depthSlope. Pass depthSlope <= 0 to
disable. See OceanPass.setShoal.
Replace the LOD configuration. Resets the snapped centers.
Register a custom wave input — point ripples, future object-attached
wakes, brush strokes, etc. The input's setup runs immediately and
it joins the per-frame update + per-LOD draw loop.
Register a persistent dynamic-wave disturbance source
(boat splat, dropped object, depth-charge, etc.). The disturbance
is re-applied every frame at its current position, so updating
the source's position from per-frame game code (e.g. a beforeFrame
hook tracking a GameObject) is enough to drive a moving wake.
Wire a reflection-probe cube view into the surface fragment's
reflection sample. Pass null to fall back to the configured sky
panorama. The view must have dimension: 'cube' — slice a
cube-array down to a single cube before passing it in.
CPU surface query. Returns the Gerstner-spectrum surface height + normal at world (x, z) at the current frame time. Useful for buoyancy / collision / camera-on-water effects. Does NOT include the dynamic-sim contribution (GPU-resident; not worth a readback for the typical "object is its own wake source" case).
Optionalout: Vec3Release GPU resources.
Stable identifier used for lookup, signature hashing, and pass-name keying.