Class EngineProfiler

Base class for creating custom profilers.

Inheritance

RefCounted

Object

EngineProfiler

Remarks

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

_add_frame(Array)

Qualifiers: virtual

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

void _add_frame(Array data)

Parameters

data Array

_tick(float, float, float, float)

Qualifiers: virtual

Called once every engine iteration when the profiler is active with information about the current frame. All time values are in seconds. Lower values represent faster processing times and are therefore considered better.

void _tick(float frame_time, float process_time, float physics_time, float physics_frame_time)

Parameters

frame_time float

process_time float

physics_time float

physics_frame_time float

_toggle(bool, Array)

Qualifiers: virtual

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

void _toggle(bool enable, Array options)

Parameters

enable bool

options Array