Photon Quantum 3.0.0

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

Represents a profiler context that manages profiling data. More...

Public Member Functions

 ProfilerContext (bool enabled)
 Initializes a new instance of the ProfilerContext class. More...
 
ProfilerContextData CreateReport (int frame, bool isVerified)
 Creates a profiler context report. More...
 
double GetFrameTimeAverage ()
 Gets the average frame time. More...
 
Profiler GetProfilerForTaskThread (FrameThreadSafe frame)
 Gets the profiler for the specified frame. More...
 
Profiler GetProfilerForTaskThread (int taskThreadIndex)
 Gets the profiler for the specified task thread index. More...
 
void Reset ()
 Resets the profiler context. More...
 
void SimulationBegin ()
 Begins a simulation. More...
 
void StoreFrameTime ()
 Stores the frame time. More...
 
double TicksToMS (long ticks)
 Converts ticks to milliseconds. More...
 

Detailed Description

Represents a profiler context that manages profiling data.

Constructor & Destructor Documentation

◆ ProfilerContext()

Quantum.Profiling.ProfilerContext.ProfilerContext ( bool  enabled)
inline

Initializes a new instance of the ProfilerContext class.

Parameters
enabledIndicates whether the profiler is enabled.

Member Function Documentation

◆ GetFrameTimeAverage()

double Quantum.Profiling.ProfilerContext.GetFrameTimeAverage ( )
inline

Gets the average frame time.

Returns
The average frame time.

◆ SimulationBegin()

void Quantum.Profiling.ProfilerContext.SimulationBegin ( )
inline

Begins a simulation.

◆ Reset()

void Quantum.Profiling.ProfilerContext.Reset ( )
inline

Resets the profiler context.

◆ StoreFrameTime()

void Quantum.Profiling.ProfilerContext.StoreFrameTime ( )
inline

Stores the frame time.

◆ TicksToMS()

double Quantum.Profiling.ProfilerContext.TicksToMS ( long  ticks)
inline

Converts ticks to milliseconds.

Parameters
ticksThe number of ticks.
Returns
The equivalent time in milliseconds.

◆ CreateReport()

ProfilerContextData Quantum.Profiling.ProfilerContext.CreateReport ( int  frame,
bool  isVerified 
)
inline

Creates a profiler context report.

Parameters
frameThe frame number.
isVerifiedIndicates whether the report is verified.
Returns
The profiler context report.

◆ GetProfilerForTaskThread() [1/2]

Profiler Quantum.Profiling.ProfilerContext.GetProfilerForTaskThread ( int  taskThreadIndex)
inline

Gets the profiler for the specified task thread index.

Parameters
taskThreadIndexThe task thread index.
Returns
The profiler for the task thread.

◆ GetProfilerForTaskThread() [2/2]

Profiler Quantum.Profiling.ProfilerContext.GetProfilerForTaskThread ( FrameThreadSafe  frame)
inline

Gets the profiler for the specified frame.

Parameters
frameThe frame.
Returns
The profiler for the frame.