This reference page is linked to from the following overview topics: MotionBuilder 2014.
Central place to query profiling results and change profiling options.
Definition at line 226 of file fbprofiler.h.
#include <fbprofiler.h>
Public Member Functions | |
FBProfiler (HIObject pObject=NULL) | |
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 (const char *pName) |
Search for index of given stat name. | |
const char * | GetStatName (int pIndex) |
Get information about what action is stat refering to. | |
const char * | GetStatComment (int pIndex) |
Get aditional information about what action is stat refering to. | |
double | GetStatStart (int pIndex) |
Get start time of action. | |
double | GetStatStop (int pIndex) |
Get stop time of action. | |
double | GetStatDuration (int pIndex) |
Get time that was spend on execution of action. | |
double | GetProfilingCost () |
Profiling collection can affect scene performace. | |
Static Public Member Functions | |
static int | RegisterTaskCycle (const char *pUniqueName, float *pColor=NULL) |
Register a new task cycle for profiling. | |
static bool | IsTaskCycleNameRegistered (const char *pName) |
Test to see if a task cycle is already registered based on the name provided. | |
static FBProfiler & | TheOne () |
Get the global object for this class. | |
Public Attributes | |
FBPropertyProfilingMode | ProfilingMode |
Read/Write Property: Profiling collection modes, including disabling all profiling. | |
FBPropertyInt | EvaluationDepth |
Read/Write Property: Specify the depth of evaluation profiling for data collection (maximum value is 10). | |
FBPropertyInt | BufferSize |
Read/Write Property: Buffer size for average and timing computation (maximum value 200). | |
FBPropertyBool | FrameReference |
Read/Write Property: Draw task cycles in relation to main thread cycle time - frame cycle (percentage display). | |
FBPropertyBool | ActiveSampling |
Read/Write Property: Activate the sampling for time events. |
FBProfiler | ( | HIObject | pObject = NULL | ) |
Constructor.
pObject | For internal use only. |
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.
int GetStatIndex | ( | const char * | pName | ) |
Search for index of given stat name.
pName | Name of the sample that we are looking for. |
const char* GetStatName | ( | int | pIndex | ) |
Get information about what action is stat refering to.
pIndex | Index of stat. |
const char* GetStatComment | ( | int | pIndex | ) |
Get aditional information about what action is stat refering to.
pIndex | Index of stat. |
double GetStatStart | ( | int | pIndex | ) |
Get start time of action.
pIndex | Index of stat. |
double GetStatStop | ( | int | pIndex | ) |
Get stop time of action.
pIndex | Index of stat. |
double GetStatDuration | ( | int | pIndex | ) |
Get time that was spend on execution of action.
pIndex | Index of stat. |
double GetProfilingCost | ( | ) |
Profiling collection can affect scene performace.
This function return how costly is profiling.
static int RegisterTaskCycle | ( | const char * | pUniqueName, |
float * | pColor = NULL |
||
) | [static] |
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. |
static bool IsTaskCycleNameRegistered | ( | const char * | pName | ) | [static] |
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 |
static FBProfiler& TheOne | ( | ) | [static] |
FBPropertyProfilingMode ProfilingMode |
Read/Write Property: Profiling collection modes, including disabling all profiling.
Definition at line 234 of file fbprofiler.h.
Read/Write Property: Specify the depth of evaluation profiling for data collection (maximum value is 10).
Definition at line 235 of file fbprofiler.h.
Read/Write Property: Buffer size for average and timing computation (maximum value 200).
Definition at line 236 of file fbprofiler.h.
Read/Write Property: Draw task cycles in relation to main thread cycle time - frame cycle (percentage display).
Definition at line 237 of file fbprofiler.h.
Read/Write Property: Activate the sampling for time events.
Call before quering for FBProfileTimeEvent.
Definition at line 238 of file fbprofiler.h.