Vixen
c7401864

WaterMeshSettings

struct Core/Vixen.Rendering.Water/WaterSurfacePass.cs:573
csharp
public readonly record struct WaterMeshSettings

The numbers the surface's own block carries, beyond what the window already says.

Read the guide page for this →

Remarks

A record rather than ten parameters, because every one of them is a knob a zone panel shows and the set grows — which is the argument RenderQuality makes for its own groups.

Fields and properties (7)

  • public float WaterTime

    The simulation's water time, in seconds. ⚠ Not a frame time — see § D2.

  • public float AttenuationDepth

    The depth at which waves reach their full height, in metres.

  • public float RestHeight

    Where the open surface sits, for the far mesh, in world units.

  • public float ShoreDepth

    How deep the water has to be before it is fully opaque water, in metres.

  • public float FoamDepth

    How shallow it has to be before it foams, in metres.

  • public float FoamCrest

    How far above the rest height a crest has to rise before it foams, in metres.

  • public static WaterMeshSettings Default

    The shader's own declared defaults, which is what a document that says nothing gets.

Used by (4)

  • WaterHorizonImageTestsVixen.Graphics.Golden.Tests
  • WaterMeshRendererVixen.Rendering.Water
  • WaterRendererFactoryVixen.Rendering.Water
  • WaterSurfacePassVixen.Rendering.Water