Detailed Description
Profiler Module Allows to profile code execution
Define Documentation
| #define orxPROFILER_KS32_MARKER_ID_NONE -1 |
| #define orxPROFILER_POP_MARKER |
( |
) |
|
| #define orxPROFILER_PUSH_MARKER |
( |
|
NAME ) |
|
Function Documentation
| orxDLLAPI void orxFASTCALL orxProfiler_Exit |
( |
) |
|
Exits from the Profiler module
| orxDLLAPI orxS32 orxFASTCALL orxProfiler_GetIDFromName |
( |
const orxSTRING |
_zName ) |
|
Gets a marker ID given a name
- Parameters:
-
| [in] | _zName | Name of the marker |
- Returns:
- Marker's ID / orxPROFILER_KS32_MARKER_ID_NONE
| orxDLLAPI orxS32 orxFASTCALL orxProfiler_GetMarkerCounter |
( |
) |
|
Gets the number of registered markers
- Returns:
- Number of registered markers
| orxDLLAPI orxDOUBLE orxFASTCALL orxProfiler_GetMarkerMaxTime |
( |
orxS32 |
_s32MarkerID ) |
|
Gets the marker's maximum cumulated time
- Parameters:
-
| [in] | _s32MarkerID | Concerned marker ID |
- Returns:
- Marker's max cumulated time
| orxDLLAPI const orxSTRING orxFASTCALL orxProfiler_GetMarkerName |
( |
orxS32 |
_s32MarkerID ) |
|
Gets the marker's name
- Parameters:
-
| [in] | _s32MarkerID | Concerned marker ID |
- Returns:
- Marker's name
| orxDLLAPI orxU32 orxFASTCALL orxProfiler_GetMarkerPushCounter |
( |
orxS32 |
_s32MarkerID ) |
|
Gets the marker's push counter
- Parameters:
-
| [in] | _s32MarkerID | Concerned marker ID |
- Returns:
- Number of time the marker has been pushed since last reset
| orxDLLAPI orxDOUBLE orxFASTCALL orxProfiler_GetMarkerTime |
( |
orxS32 |
_s32MarkerID ) |
|
Gets the marker's cumulated time
- Parameters:
-
| [in] | _s32MarkerID | Concerned marker ID |
- Returns:
- Marker's cumulated time
| orxDLLAPI orxS32 orxFASTCALL orxProfiler_GetNextMarkerID |
( |
orxS32 |
_s32MarkerID ) |
|
Gets the next registered marker ID
- Parameters:
-
| [in] | _s32MarkerID | ID of the current marker, orxPROFILER_KS32_MARKER_ID_NONE to get the first one |
- Returns:
- Next registered marker's ID / orxPROFILER_KS32_MARKER_ID_NONE if the current marker was the last one
| orxDLLAPI orxS32 orxFASTCALL orxProfiler_GetNextSortedMarkerID |
( |
orxS32 |
_s32MarkerID ) |
|
Gets the ID of the next marker, sorted by their push time
- Parameters:
-
| [in] | _s32MarkerID | ID of the current pushed marker, orxPROFILER_KS32_MARKER_ID_NONE to get the first one |
- Returns:
- Next registered marker's ID / orxPROFILER_KS32_MARKER_ID_NONE if the current marker was the last one
| orxDLLAPI orxDOUBLE orxFASTCALL orxProfiler_GetResetTime |
( |
) |
|
Gets the time elapsed since last reset
- Returns:
- Time elapsed since the last reset, in seconds
| orxDLLAPI orxU32 orxFASTCALL orxProfiler_GetUniqueMarkerDepth |
( |
orxS32 |
_s32MarkerID ) |
|
Gets the uniquely pushed marker's depth, 1 being the depth of the top level
- Parameters:
-
| [in] | _s32MarkerID | Concerned marker ID |
- Returns:
- Marker's push depth / 0 if this marker hasn't been uniquely pushed
| orxDLLAPI orxDOUBLE orxFASTCALL orxProfiler_GetUniqueMarkerStartTime |
( |
orxS32 |
_s32MarkerID ) |
|
Gets the uniquely pushed marker's start time
- Parameters:
-
| [in] | _s32MarkerID | Concerned marker ID |
- Returns:
- Marker's start time / 0.0
| orxDLLAPI orxSTATUS orxFASTCALL orxProfiler_Init |
( |
) |
|
Inits the Profiler module
- Returns:
- orxSTATUS_SUCCESS / orxSTATUS_FAILURE
| orxDLLAPI orxBOOL orxFASTCALL orxProfiler_IsMarkerIDValid |
( |
orxS32 |
_s32MarkerID ) |
|
Is the given marker valid? (Useful when storing markers in static variables and still allow normal hot restart)
- Parameters:
-
| [in] | _s32MarkerID | ID of the marker to test |
- Returns:
- orxTRUE / orxFALSE
| orxDLLAPI orxBOOL orxFASTCALL orxProfiler_IsUniqueMarker |
( |
orxS32 |
_s32MarkerID ) |
|
Has the marker been pushed by a unique parent?
- Parameters:
-
| [in] | _s32MarkerID | Concerned marker ID |
- Returns:
- orxTRUE / orxFALSE
| orxDLLAPI void orxFASTCALL orxProfiler_PopMarker |
( |
) |
|
Pops a marker (from the stack) and updates its cumulated time (using the last marker push time)
| orxDLLAPI void orxFASTCALL orxProfiler_PushMarker |
( |
orxS32 |
_s32MarkerID ) |
|
Pushes a marker (on a stack) and starts a timer for it
- Parameters:
-
| [in] | _s32MarkerID | ID of the marker to push |
| orxDLLAPI void orxFASTCALL orxProfiler_ResetAllMarkers |
( |
) |
|
Resets all markers (usually called at the end of the frame)
| orxDLLAPI void orxFASTCALL orxProfiler_ResetAllMaxima |
( |
) |
|
Resets all maxima (usually called at a regular interval)
| orxDLLAPI void orxFASTCALL orxProfiler_Setup |
( |
) |
|
