Quantum 3 3.0.14

Static Public Member Functions | List of all members
Quantum.Profiling.QuantumGraphPlayerLoopUtility Class Reference

A system to add profiler callbacks into the Unity player loop. More...

Static Public Member Functions

static bool AddPlayerLoopSystem (Type playerLoopSystemType, Type targetLoopSystemType, PlayerLoopSystem.UpdateFunction updateFunction, int position=-1)
 Adds a player loop system to the Unity player loop. More...
 
static bool AddPlayerLoopSystem (Type playerLoopSystemType, Type targetSubSystemType, PlayerLoopSystem.UpdateFunction updateFunctionBefore, PlayerLoopSystem.UpdateFunction updateFunctionAfter)
 Adds a player loop system to the Unity player loop. More...
 
static void DumpPlayerLoopSystems ()
 Debug output of the player loop systems. More...
 
static bool HasPlayerLoopSystem (Type playerLoopSystemType)
 Checks if certain player loop system is already added. More...
 
static bool RemovePlayerLoopSystems (Type playerLoopSystemType)
 Remove a player loop system. More...
 
static void SetDefaultPlayerLoopSystem ()
 Resets the player loop. More...
 

Detailed Description

A system to add profiler callbacks into the Unity player loop.

Member Function Documentation

◆ SetDefaultPlayerLoopSystem()

static void Quantum.Profiling.QuantumGraphPlayerLoopUtility.SetDefaultPlayerLoopSystem ( )
inlinestatic

Resets the player loop.

◆ HasPlayerLoopSystem()

static bool Quantum.Profiling.QuantumGraphPlayerLoopUtility.HasPlayerLoopSystem ( Type  playerLoopSystemType)
inlinestatic

Checks if certain player loop system is already added.

Parameters
playerLoopSystemTypePlayer loop system type
Returns
True if the system type was found

◆ AddPlayerLoopSystem() [1/2]

static bool Quantum.Profiling.QuantumGraphPlayerLoopUtility.AddPlayerLoopSystem ( Type  playerLoopSystemType,
Type  targetLoopSystemType,
PlayerLoopSystem.UpdateFunction  updateFunction,
int  position = -1 
)
inlinestatic

Adds a player loop system to the Unity player loop.

Parameters
playerLoopSystemTypePlayer loos system type
targetLoopSystemTypeTarget loop type
updateFunctionUpdate function
positionThe position of the sub system
Returns
True is system was added
Exceptions
ArgumentOutOfRangeExceptionIs raised when the position is invalid

◆ AddPlayerLoopSystem() [2/2]

static bool Quantum.Profiling.QuantumGraphPlayerLoopUtility.AddPlayerLoopSystem ( Type  playerLoopSystemType,
Type  targetSubSystemType,
PlayerLoopSystem.UpdateFunction  updateFunctionBefore,
PlayerLoopSystem.UpdateFunction  updateFunctionAfter 
)
inlinestatic

Adds a player loop system to the Unity player loop.

Parameters
playerLoopSystemTypePlayer loos system type
targetSubSystemTypeTarget sub system type
updateFunctionBeforeUpdate before function
updateFunctionAfterUpdate after function
Returns
True if the system was added

◆ RemovePlayerLoopSystems()

static bool Quantum.Profiling.QuantumGraphPlayerLoopUtility.RemovePlayerLoopSystems ( Type  playerLoopSystemType)
inlinestatic

Remove a player loop system.

Parameters
playerLoopSystemTypeSystem type to remove
Returns
True if the system was found and removed

◆ DumpPlayerLoopSystems()

static void Quantum.Profiling.QuantumGraphPlayerLoopUtility.DumpPlayerLoopSystems ( )
inlinestatic

Debug output of the player loop systems.