Stats

Collects and visualizes runtime performance statistics.

The Stats class tracks frames per second, frame time, and the number of rendered objects per frame. It is used by the runtime when show_stats is set to true to provide an on-screen performance overlay during development and debugging.

Typical usage inside the main loop:

while (running) {
  stats.BeforeRender();
  renderer.Render(scene, camera);
  stats.AfterRender(renderer.RenderedObjectsPerFrame());
  stats.Draw();
}

Construction

Constructors

Stats()

vglx::Stats::Stats()

Constructs a Stats object.

Functions

AfterRender() void

void vglx::Stats::AfterRender(unsigned n_objects)

Parameter	Description
n_objects	Number of objects rendered in the frame.

Marks the end of a frame render. Updates frame time and records the number of rendered objects.

BeforeRender() void

void vglx::Stats::BeforeRender()

Marks the beginning of a frame render. Records timing information and increments the frame counter. Call this before issuing any render commands.

Draw() void

void vglx::Stats::Draw() const

Draws the performance overlay. Renders a window containing FPS, frame time, and rendered object histograms.