Skip to content

Class DevOverlay

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

The engine's debug window: frame time graph, GPU pass timings, the render graph, and lighting statistics and controls. Call every frame between and .

public sealed class DevOverlay

Inheritance

object ← DevOverlay

Inherited Members

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

Properties

FrameTimeHistory

The frame times recorded so far, oldest first.

public IReadOnlyList<float> FrameTimeHistory { get; }

Property Value

IReadOnlyList<float>

GpuHistory

The GPU milliseconds of each top-level pass over the last frames, oldest first (a pass that did not run in a frame has 0 there).

public IReadOnlyDictionary<string, float[]> GpuHistory { get; }

Property Value

IReadOnlyDictionary<string, float[]>

Visible

Shows or hides the window (the game binds a key to it).

public bool Visible { get; set; }

Property Value

bool

Methods

Draw(DevOverlayData)

public void Draw(DevOverlayData data)

Parameters

data DevOverlayData

DrawProfiler(DevOverlayData)

The frame-time plot, the GPU plot and the pass table with no window around them, for a panel of an editor. Call every frame as well (with false it only records the history), so that there is something to show.

public void DrawProfiler(DevOverlayData data)

Parameters

data DevOverlayData