Central place to query profiling results and change profiling options.
Public Member Functions | |
__init__ (object pObject=None) | |
Constructor. | |
int | GetEventSampleCount () |
Get number of time event samples collected during last sampling. | |
FBProfileTimeEvent | GetEventSample (int pIndex) |
Only possible way to query collected FBProfileTimeEvent. | |
FBProfileTimeEvent | GetEndEventSample (int pIndex) |
Get end time event for event at given index. | |
int | GetStatCount () |
Stats are holding last execution time/duration of action. | |
int | GetStatIndex (str pName) |
Search for index of given stat name. | |
str | GetStatName (int pIndex) |
Get information about what action is stat refering to. | |
str | GetStatComment (int pIndex) |
Get aditional information about what action is stat refering to. | |
float | GetStatStart (int pIndex) |
Get start time of action. | |
float | GetStatStop (int pIndex) |
Get stop time of action. | |
float | GetStatDuration (int pIndex) |
Get time that was spend on execution of action. | |
float | GetProfilingCost () |
Profiling collection can affect scene performace. | |
int | RegisterTaskCycle (str pUniqueName, float pColor=None) |
Register a new task cycle for profiling. | |
bool | IsTaskCycleNameRegistered (str pName) |
Test to see if a task cycle is already registered based on the name provided. | |
FBProfiler | TheOne () |
Get the global object for this class. | |
Public Attributes | |
FBPropertyProfilingMode | ProfilingMode |
Read/Write Property: Profiling collection modes, including disabling all profiling. | |
FBPropertyBase | EvaluationDepth |
Read/Write Property: Specify the depth of evaluation profiling for data collection (maximum value is 10). | |
FBPropertyBase | BufferSize |
Read/Write Property: Buffer size for average and timing computation (maximum value 200). | |
FBPropertyBase | FrameReference |
Read/Write Property: Draw task cycles in relation to main thread cycle time - frame cycle (percentage display). | |
FBPropertyBase | ActiveSampling |
Read/Write Property: Activate the sampling for time events. |
__init__ | ( | object | pObject = None | ) |
int GetEventSampleCount | ( | ) |
Get number of time event samples collected during last sampling.
FBProfileTimeEvent GetEventSample | ( | int | pIndex | ) |
Only possible way to query collected FBProfileTimeEvent.
pIndex | Sample index. |
FBProfileTimeEvent GetEndEventSample | ( | int | pIndex | ) |
Get end time event for event at given index.
This function and FBProfileTimeEvent.IsSingleEvent are useful to identify duration of event action.
pIndex | Sample index. |
int GetStatCount | ( | ) |
Stats are holding last execution time/duration of action.
They are used for actions that doesn't appear frequently, like file IO.
Search for index of given stat name.
pName | Name of the sample that we are looking for. |
Get information about what action is stat refering to.
pIndex | Index of stat. |
Get aditional information about what action is stat refering to.
pIndex | Index of stat. |
Get start time of action.
pIndex | Index of stat. |
Get stop time of action.
pIndex | Index of stat. |
Get time that was spend on execution of action.
pIndex | Index of stat. |
float GetProfilingCost | ( | ) |
Profiling collection can affect scene performace.
This function return how costly is profiling.
Register a new task cycle for profiling.
Pointer to name needs to stay valid during whole application session.
pUniqueName | Unique name for new task cycle |
pColor | Color for new task cycle. Used in Profiling Center for drawing. |
Test to see if a task cycle is already registered based on the name provided.
Can also be used to verify if a name is free to be used, this included checking any conflicts with internal names.
pName | Task cycle name to test |
FBProfiler TheOne | ( | ) |
FBPropertyProfilingMode ProfilingMode |
Read/Write Property: Profiling collection modes, including disabling all profiling.
FBPropertyBase EvaluationDepth |
Read/Write Property: Specify the depth of evaluation profiling for data collection (maximum value is 10).
FBPropertyBase BufferSize |
Read/Write Property: Buffer size for average and timing computation (maximum value 200).
FBPropertyBase FrameReference |
Read/Write Property: Draw task cycles in relation to main thread cycle time - frame cycle (percentage display).
FBPropertyBase ActiveSampling |
Read/Write Property: Activate the sampling for time events.
Call before quering for FBProfileTimeEvent.