EngineProfiler

Base class for creating custom profilers.

1.0.0

class EngineProfilerReckfellSharpInherits RefCounted

Base class for creating custom profilers.

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.

Declarations checked against C# SDK 1.0.0. Expand a name to see declarations and documentation.

Constructors1

EngineProfilerConstructor

# EngineProfiler

C#
public EngineProfiler();

Methods3

_AddFramevoid

# _AddFrame

C#
public virtual void _AddFrame(Reckfell.Collections.Array data);

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

Parameters
Name	Type	Default
`data`	`Reckfell.Collections.Array`	—

_Tickvoid

# _Tick

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

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.

Parameters
Name	Type	Default
`frameTime`	`double`	—
`processTime`	`double`	—
`physicsTime`	`double`	—
`physicsFrameTime`	`double`	—

_Togglevoid

# _Toggle

C#
public virtual void _Toggle(bool enable, Reckfell.Collections.Array options);

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

Parameters
Name	Type	Default
`enable`	`bool`	—
`options`	`Reckfell.Collections.Array`	—

Reckfell Engine documentationBack to top ↑