Unravel Engine C++ Reference
Loading...
Searching...
No Matches
unravel::statistics_panel Class Reference

Panel that displays real-time performance statistics, profiler data, memory usage, and GPU resource utilization for the engine. More...

#include <statistics_panel.h>

Public Member Functions

auto init (rtti::context &ctx) -> void
 Initialize the statistics panel.
 
auto deinit (rtti::context &ctx) -> void
 Deinitialize the statistics panel and clean up resources.
 
auto on_frame_update (rtti::context &ctx, delta_t dt) -> void
 Update the statistics panel logic each frame.
 
auto on_frame_render (rtti::context &ctx, delta_t dt) -> void
 Render the statistics panel each frame.
 
auto on_frame_ui_render (rtti::context &ctx, const char *name) -> void
 Render the statistics panel UI.
 
auto set_visible (bool visible) -> void
 Set the visibility state of the panel.
 
auto is_visible () const -> bool
 Check if the panel is currently visible.
 

Detailed Description

Panel that displays real-time performance statistics, profiler data, memory usage, and GPU resource utilization for the engine.

Definition at line 20 of file statistics_panel.h.

Member Function Documentation

◆ deinit()

auto unravel::statistics_panel::deinit ( rtti::context & ctx) -> void

Deinitialize the statistics panel and clean up resources.

Parameters
ctxThe application context

Definition at line 46 of file statistics_panel.cpp.

◆ init()

auto unravel::statistics_panel::init ( rtti::context & ctx) -> void

Initialize the statistics panel.

Parameters
ctxThe application context

Definition at line 41 of file statistics_panel.cpp.

◆ is_visible()

auto unravel::statistics_panel::is_visible ( ) const -> bool
inline

Check if the panel is currently visible.

Returns
True if the panel is visible

Definition at line 83 of file statistics_panel.h.

◆ on_frame_render()

auto unravel::statistics_panel::on_frame_render ( rtti::context & ctx,
delta_t dt ) -> void

Render the statistics panel each frame.

Parameters
ctxThe application context
dtDelta time since last frame

Definition at line 56 of file statistics_panel.cpp.

◆ on_frame_ui_render()

auto unravel::statistics_panel::on_frame_ui_render ( rtti::context & ctx,
const char * name ) -> void

Render the statistics panel UI.

Parameters
ctxThe application context
nameThe panel window name

Definition at line 61 of file statistics_panel.cpp.

◆ on_frame_update()

auto unravel::statistics_panel::on_frame_update ( rtti::context & ctx,
delta_t dt ) -> void

Update the statistics panel logic each frame.

Parameters
ctxThe application context
dtDelta time since last frame

Definition at line 51 of file statistics_panel.cpp.

◆ set_visible()

auto unravel::statistics_panel::set_visible ( bool visible) -> void
inline

Set the visibility state of the panel.

Parameters
visibleTrue to make the panel visible

Definition at line 72 of file statistics_panel.h.


The documentation for this class was generated from the following files: