WaterOverlay

class

Core/Vixen.Rendering.Water/WaterDiagnostics.cs:270

csharp

public sealed class WaterOverlay

`stat water`: the fold's counts, and the two diagnostics that are not one number.

Read the guide page for this →

Remarks

⚠ Two diagnostics rather than one, because the fixes differ. A zoneless body is a zone's extent; an unresolved one is an asset name or an asset that has not loaded. One number for both sends an author to the wrong place, which is the whole reason the fold counts them separately.

Fields and properties (5)

public string Name
What the console and the toggles call it. Lower case, no spaces.
public OverlayAnchor Anchor
Which corner it is pinned to.
public bool Enabled
Whether it is drawn.
public float Width
How wide the panel is, in pixels.
public WaterStatistics Statistics
What the systems reported. The host sets this once a frame.

Methods (2)

public void Read(WaterZoneSystem zones, WaterMeshRenderer? mesh = null)
Reads this frame's numbers off a zone system, and the node that drew it.
public void Draw(OverlaySurface surface, in GameTime time)
Draws it.

Used by (2)

AppGraphicsVixen.App.Hosting
WaterOverlayTestsVixen.Rendering.Water.Tests