Skip to content

Class DevOverlayData

Namespace: Apogee.DevTools
Assembly: Apogee.DevTools.dll

What the overlay shows. Fill it each frame from whatever the game has; leave out what it does not have.

public sealed class DevOverlayData

Inheritance

object ← DevOverlayData

Inherited Members

object.Equals(object?), object.Equals(object?, object?), object.GetHashCode(), object.GetType(), object.ReferenceEquals(object?, object?), object.ToString()

Properties

Camera

The camera: the overlay edits its field of view, near plane and cluster range.

public Camera? Camera { get; set; }

Property Value

Camera?

CpuFrameMilliseconds

The CPU time of the last frame in milliseconds.

public double CpuFrameMilliseconds { get; set; }

Property Value

double

GpuName

public string GpuName { get; set; }

Property Value

string

GpuTimings

The GPU sections of the last finished frame ().

public IReadOnlyList<GpuTiming> GpuTimings { get; set; }

Property Value

IReadOnlyList<GpuTiming>

Plan

The render graph of the last frame ().

public GraphPlan? Plan { get; set; }

Property Value

GraphPlan?

Scene

public RenderScene? Scene { get; set; }

Property Value

RenderScene?

Settings

The renderer's settings: the overlay edits exposure and the debug view in place.

public RenderSettings? Settings { get; set; }

Property Value

RenderSettings?

ShaderErrors

Shaders that were edited and did not compile (): the pipelines made from them are as they were before the edit. The overlay shows them in red.

public IReadOnlyList<string> ShaderErrors { get; set; }

Property Value

IReadOnlyList<string>

Stats

public RenderStats? Stats { get; set; }

Property Value

RenderStats?

Toggles

Switches the host offers in a Debug section: whatever it can turn on to see what is going on.

public IReadOnlyList<OverlayToggle> Toggles { get; set; }

Property Value

IReadOnlyList<OverlayToggle>