public readonly record struct OverlayThemeWhat the overlays look like: colours, text size, and the space around things.
No guide page documents this yet — the page shows what the code says about itself.
Remarks
One value passed down rather than each overlay picking its own, so that "everything readable" and "everything out of the way" are one adjustment instead of nine. The defaults are tuned for a bright scene: a dark, mostly opaque backing and light text, because a diagnostic that is legible only over a dark skybox is a diagnostic that vanishes exactly when a level is bright.
Fields and properties (14)
public static OverlayTheme DefaultThe settings an overlay gets when nobody has said otherwise.
public float TextSizeThe cap height of overlay text, in pixels.
public float PaddingHow far a panel's contents sit inside its edges, in pixels.
public float MarginHow far a panel sits from the edge of the screen, in pixels.
public float GapHow far apart two stacked panels sit, in pixels.
public float FillSpacingHow far apart a fill's scanlines are. One is solid; two is half the segments.
public Color4 BackgroundWhat is drawn behind a panel.
public Color4 BorderThe line round a panel's edge.
public Color4 TextOrdinary text.
public Color4 HeadingA panel's title, and anything else that labels rather than reports.
public Color4 MutedText that has faded out of relevance — an older log line, a disabled entry.
public Color4 GoodA number that is where it should be.
public Color4 WarningA number that is close to a limit.
public Color4 BadA number that is past one.
Methods (2)
Used by (9)
- AudioOverlayVixen.Audio
- ConsoleOverlayVixen.Engine
- ConsoleTestsVixen.Engine.Tests
- DiagnosticOverlaysVixen.Engine
- FrameGraphOverlayVixen.Engine
- FrameStatsOverlayVixen.Engine
- LogOverlayVixen.Engine
- OverlayRegionVixen.Engine
- OverlaySurfaceVixen.Engine