public interface IDiagnosticOverlayOne toggleable diagnostic panel.
No guide page documents this yet — the page shows what the code says about itself.
Remarks
An interface rather than a closed set, because the interesting overlays belong to the subsystems they report on: physics knows what a contact is and the asset system knows what is resident, and neither of those facts belongs in this assembly. What lives here is the frame, and the four whose data is already in Vixen.Core.Diagnostics.
⚠ An overlay draws and reads; it does not simulate. It is called after everything that produces its numbers has run, from a system in PreRender, so a value it reads is this frame's and anything it writes is geometry.
Fields and properties (3)
string NameWhat the console and the toggles call it. Lower case, no spaces.
OverlayAnchor AnchorWhich corner it is pinned to.
bool EnabledWhether it is drawn.
Methods (1)
void Draw(OverlaySurface surface, in GameTime time)Draws it.
Used by (7)
- AudioOverlayVixen.Audio
- ConsoleOverlayVixen.Engine
- DiagnosticOverlaysVixen.Engine
- FrameGraphOverlayVixen.Engine
- FrameStatsOverlayVixen.Engine
- LogOverlayVixen.Engine
- RecordingVixen.Engine.Tests