Table of Contents

Class EngineProfiler

Namespace
Godot
Assembly
GodotSharp.dll

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.

public class EngineProfiler : RefCounted, IDisposable
Inheritance
EngineProfiler
Implements
Inherited Members

Constructors

EngineProfiler() 

public EngineProfiler()

Methods

HasGodotClassMethod(in godot_string_name)

Check if the type contains a method with the given name. This method is used by Godot to check if a method exists before invoking it. Do not call or override this method.

protected override bool HasGodotClassMethod(in godot_string_name method)

Parameters

method godot_string_name

Name of the method to check for.

Returns

bool

HasGodotClassSignal(in godot_string_name)

Check if the type contains a signal with the given name. This method is used by Godot to check if a signal exists before raising it. Do not call or override this method.

protected override bool HasGodotClassSignal(in godot_string_name signal)

Parameters

signal godot_string_name

Name of the signal to check for.

Returns

bool

InvokeGodotClassMethod(in godot_string_name, NativeVariantPtrArgs, out godot_variant)

Invokes the method with the given name, using the given arguments. This method is used by Godot to invoke methods from the engine side. Do not call or override this method.

protected override bool InvokeGodotClassMethod(in godot_string_name method, NativeVariantPtrArgs args, out godot_variant ret)

Parameters

method godot_string_name

Name of the method to invoke.

args NativeVariantPtrArgs

Arguments to use with the invoked method.

ret godot_variant

Value returned by the invoked method.

Returns

bool

_AddFrame(Array)

Called when data is added to profiler using ProfilerAddFrameData(StringName, Array).

public virtual void _AddFrame(Array data)

Parameters

data Array

_Tick(double, double, double, double)

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.

public virtual void _Tick(double frameTime, double processTime, double physicsTime, double physicsFrameTime)

Parameters

frameTime double
processTime double
physicsTime double
physicsFrameTime double

_Toggle(bool, Array)

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

public virtual void _Toggle(bool enable, Array options)

Parameters

enable bool
options Array
Edit this page