EngineProfiler

Inherits: RefCounted < Object

Base class for creating custom profilers.

Description

This class can be used to implement custom profilers that are able to interact with the engine and editor debugger.

See EngineDebugger and EditorDebuggerPlugin for more information.

Methods

void

_add_frame ( Array data ) virtual

void

_tick ( float frame_time, float idle_time, float physics_time, float physics_frame_time ) virtual

void

_toggle ( bool enable, Array options ) virtual

Method Descriptions

  • void _add_frame ( Array data ) virtual

Called when data is added to profiler using EngineDebugger.profiler_add_frame_data.


  • void _tick ( float frame_time, float idle_time, float physics_time, float physics_frame_time ) virtual

Called once every engine iteration when the profiler is active with information about the current frame.


  • void _toggle ( bool enable, Array options ) virtual

Called when the profiler is enabled/disabled, along with a set of options.