Documentation / scene / UnderwaterState
Interface: UnderwaterState
Defined in: libs/scene/src/render/underwater.ts:29
The body of water a camera is currently inside, and how deep.
Properties
water
water:
Water
Defined in: libs/scene/src/render/underwater.ts:31
The water node the camera is submerged in.
material
material:
WaterMaterial
Defined in: libs/scene/src/render/underwater.ts:33
Its material, which owns the medium coefficients and the underwater settings.
surfaceY
surfaceY:
number
Defined in: libs/scene/src/render/underwater.ts:35
World Y of that water's rest plane.
eyeDepth
eyeDepth:
number
Defined in: libs/scene/src/render/underwater.ts:37
How far the eye is below the rest plane, in meters. Always positive.