Skip to content

Namespace Apogee.DevTools

Classes

DevOverlay

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

DevOverlayData

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

DevToolsLibrary

The devtools table of scripts: when to draw, and what to show in the debug window.

ImGuiHost

A Dear ImGui context wired to the engine: SDL input, display size and the dark style. Draw widgets between and ; then puts the result on the screen.

ImGuiLibrary

Dear ImGui for Luau scripts, as the global table imgui: snake_case functions over the same calls the dev tools use. A widget returns changed, value; a window or tree that can be open returns whether it is; every begin has its end (ImGui recovers from a script that forgets, at the end of the frame). With no frame open every call does nothing and returns what it was given, so tool code can stay in a shipped game. Ids are the labels, with ImGui's ## and ### conventions.

ImGuiRenderer

Draws Dear ImGui's draw data onto the frame's output as a render-graph pass: its textures (the font atlas) become images in the bindless heap as ImGui asks for them, and its vertices and indices go through per-frame buffers that the shader pulls from. Use it as the of , or call on your own graph.

OverlayToggle

A checkbox the host adds to the overlay's Debug section: it reads and writes a switch of the host's (physics debug drawing, say).

Plots

Plots with ImPlot, for the overlay's graphs and the editor's profiler: a small surface over the binding that takes strings and spans. Use it between and : if (Plots.Begin("id", size)) { Plots.Axes(...); Plots.Line(...); Plots.End(); }.

ScriptGui

What scripts register for the dev tools: functions that draw each frame, and values to watch. The host calls once a frame between and ; the debug window shows .

Ui

The few Dear ImGui calls the dev tools use, with C# strings and ref values instead of C pointers. Call them between BeginFrame and EndFrame.