TracyWrapper.Profiler Class Reference

Application's profiler. Use this to interact with Tracy. More...

Static Public Member Functions
static void	InitThread (string? threadName=null)
	Call this once per thread before starting the profiler.
static void	SetEnabled (bool enabled)
	Turn profiler on/off.
static void	HeartBeat (string name="Frame")
	This needs to be called once every frame.
static void	PushProfileZone (string name, uint color=ZoneC.DEFAULT, [CallerLineNumber] int lineNumber=0, [CallerMemberName] string function="", [CallerFilePath] string sourceFile="")
	Begin profile region.
static void	PushProfileZone (string name, Color color, [CallerLineNumber] int lineNumber=0, [CallerMemberName] string function="", [CallerFilePath] string sourceFile="")
	Begin profile region.
static void	PopProfileZone ()
	End previous profile region.

Detailed Description

Application's profiler. Use this to interact with Tracy.

Member Function Documentation

HeartBeat()

static void TracyWrapper.Profiler.HeartBeat ( string name = "Frame" )

inlinestatic

This needs to be called once every frame.

Parameters

name	Display name

InitThread()

static void TracyWrapper.Profiler.InitThread ( string? threadName = null )

inlinestatic

Call this once per thread before starting the profiler.

Parameters

threadName

Set this for a custom thread display name.

PushProfileZone() [1/2]

static void TracyWrapper.Profiler.PushProfileZone ( string name, Color color, [CallerLineNumber] int lineNumber = 0, [CallerMemberName] string function = "", [CallerFilePath] string sourceFile = "" )

inlinestatic

Begin profile region.

Parameters

name	Display name
color	Display color
lineNumber	Override line number. Recommended to leave blank for caller's line number.
function	Override function name. Recommended to leave blank for caller's function name.
sourceFile	Override source file name. Recommended to leave blank for caller's source file name.

PushProfileZone() [2/2]

static void TracyWrapper.Profiler.PushProfileZone ( string name, uint color = ZoneC::DEFAULT, [CallerLineNumber] int lineNumber = 0, [CallerMemberName] string function = "", [CallerFilePath] string sourceFile = "" )

inlinestatic

Begin profile region.

Parameters

name	Display name
color	Display color
lineNumber	Override line number. Recommended to leave blank for caller's line number.
function	Override function name. Recommended to leave blank for caller's function name.
sourceFile	Override source file name. Recommended to leave blank for caller's source file name.

SetEnabled()

static void TracyWrapper.Profiler.SetEnabled ( bool enabled )

inlinestatic

Turn profiler on/off.

Parameters

enabled

Set to true to enable profiler.

Exceptions

Exception

Cannot disable profiler while profiling scopes are pushed.

---

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

• C:/Users/Augus/Documents/Programming/MonoGame/GalaxyGame/MugEngine/TracyWrapper/TracyWrapper/Profiler.cs