orx  stable
Portable Game Engine
OrxProfiler

Macros

#define orxPROFILER_KS32_MARKER_ID_NONE   -1
 
#define orxPROFILER_KU32_HISTORY_LENGTH   2
 
#define orxPROFILER_POP_MARKER()
 
#define orxPROFILER_PUSH_MARKER(NAME)
 

Functions

orxDLLAPI orxBOOL orxFASTCALL orxProfiler_AreMarkerOperationsEnabled ()
 
orxDLLAPI void orxFASTCALL orxProfiler_EnableMarkerOperations (orxBOOL _bEnable)
 
orxDLLAPI void orxFASTCALL orxProfiler_Exit ()
 
orxDLLAPI orxS32 orxFASTCALL orxProfiler_GetIDFromName (const orxSTRING _zName)
 
orxDLLAPI orxS32 orxFASTCALL orxProfiler_GetMarkerCounter ()
 
orxDLLAPI orxDOUBLE orxFASTCALL orxProfiler_GetMarkerMaxTime (orxS32 _s32MarkerID)
 
orxDLLAPI const orxSTRING orxFASTCALL orxProfiler_GetMarkerName (orxS32 _s32MarkerID)
 
orxDLLAPI orxU32 orxFASTCALL orxProfiler_GetMarkerPushCounter (orxS32 _s32MarkerID)
 
orxDLLAPI orxDOUBLE orxFASTCALL orxProfiler_GetMarkerTime (orxS32 _s32MarkerID)
 
orxDLLAPI orxDOUBLE orxFASTCALL orxProfiler_GetMaxResetTime ()
 
orxDLLAPI orxS32 orxFASTCALL orxProfiler_GetNextMarkerID (orxS32 _s32MarkerID)
 
orxDLLAPI orxS32 orxFASTCALL orxProfiler_GetNextSortedMarkerID (orxS32 _s32MarkerID)
 
orxDLLAPI orxDOUBLE orxFASTCALL orxProfiler_GetResetTime ()
 
orxDLLAPI orxU32 orxFASTCALL orxProfiler_GetUniqueMarkerDepth (orxS32 _s32MarkerID)
 
orxDLLAPI orxDOUBLE orxFASTCALL orxProfiler_GetUniqueMarkerStartTime (orxS32 _s32MarkerID)
 
orxDLLAPI orxSTATUS orxFASTCALL orxProfiler_Init ()
 
orxDLLAPI orxBOOL orxFASTCALL orxProfiler_IsMarkerIDValid (orxS32 _s32MarkerID)
 
orxDLLAPI orxBOOL orxFASTCALL orxProfiler_IsPaused ()
 
orxDLLAPI orxBOOL orxFASTCALL orxProfiler_IsUniqueMarker (orxS32 _s32MarkerID)
 
orxDLLAPI void orxFASTCALL orxProfiler_Pause (orxBOOL _bPause)
 
orxDLLAPI void orxFASTCALL orxProfiler_PopMarker ()
 
orxDLLAPI void orxFASTCALL orxProfiler_PushMarker (orxS32 _s32MarkerID)
 
orxDLLAPI void orxFASTCALL orxProfiler_ResetAllMarkers ()
 
orxDLLAPI void orxFASTCALL orxProfiler_ResetAllMaxima ()
 
orxDLLAPI orxSTATUS orxFASTCALL orxProfiler_SelectQueryFrame (orxU32 _u32QueryFrame, orxU32 _u32ThreadID)
 
orxDLLAPI void orxFASTCALL orxProfiler_Setup ()
 

Detailed Description

Profiler Module Allows to profile code execution

Macro Definition Documentation

#define orxPROFILER_KS32_MARKER_ID_NONE   -1

Defines

Definition at line 95 of file orxProfiler.h.

#define orxPROFILER_KU32_HISTORY_LENGTH   2

Definition at line 88 of file orxProfiler.h.

#define orxPROFILER_POP_MARKER ( )

Definition at line 86 of file orxProfiler.h.

#define orxPROFILER_PUSH_MARKER (   NAME)

Profiler macros

Definition at line 84 of file orxProfiler.h.

Function Documentation

orxDLLAPI orxBOOL orxFASTCALL orxProfiler_AreMarkerOperationsEnabled ( )

Are marker push/pop operations enabled?

Returns
orxTRUE / orxFALSE
orxDLLAPI void orxFASTCALL orxProfiler_EnableMarkerOperations ( orxBOOL  _bEnable)

Enables marker push/pop operations

Parameters
[in]_bEnableEnable
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]_zNameName of the marker
Returns
Marker's ID / orxPROFILER_KS32_MARKER_ID_NONE
orxDLLAPI orxS32 orxFASTCALL orxProfiler_GetMarkerCounter ( )

Gets the number of registered markers used on the queried thread

Returns
Number of registered markers
orxDLLAPI orxDOUBLE orxFASTCALL orxProfiler_GetMarkerMaxTime ( orxS32  _s32MarkerID)

Gets the marker's maximum cumulated time

Parameters
[in]_s32MarkerIDConcerned marker ID
Returns
Marker's max cumulated time
orxDLLAPI const orxSTRING orxFASTCALL orxProfiler_GetMarkerName ( orxS32  _s32MarkerID)

Gets the marker's name

Parameters
[in]_s32MarkerIDConcerned marker ID
Returns
Marker's name
orxDLLAPI orxU32 orxFASTCALL orxProfiler_GetMarkerPushCounter ( orxS32  _s32MarkerID)

Gets the marker's push counter

Parameters
[in]_s32MarkerIDConcerned 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]_s32MarkerIDConcerned marker ID
Returns
Marker's cumulated time
orxDLLAPI orxDOUBLE orxFASTCALL orxProfiler_GetMaxResetTime ( )

Gets the maximum reset time

Returns
Max reset time, in seconds
orxDLLAPI orxS32 orxFASTCALL orxProfiler_GetNextMarkerID ( orxS32  _s32MarkerID)

Gets the next registered marker ID

Parameters
[in]_s32MarkerIDID 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]_s32MarkerIDID 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]_s32MarkerIDConcerned 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]_s32MarkerIDConcerned 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]_s32MarkerIDID of the marker to test
Returns
orxTRUE / orxFALSE
orxDLLAPI orxBOOL orxFASTCALL orxProfiler_IsPaused ( )

Is profiler paused?

Returns
orxTRUE / orxFALSE
orxDLLAPI orxBOOL orxFASTCALL orxProfiler_IsUniqueMarker ( orxS32  _s32MarkerID)

Has the marker been pushed by a unique parent?

Parameters
[in]_s32MarkerIDConcerned marker ID
Returns
orxTRUE / orxFALSE
orxDLLAPI void orxFASTCALL orxProfiler_Pause ( orxBOOL  _bPause)

Pauses/unpauses the profiler

Parameters
[in]_bPausePause
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]_s32MarkerIDID 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 orxSTATUS orxFASTCALL orxProfiler_SelectQueryFrame ( orxU32  _u32QueryFrame,
orxU32  _u32ThreadID 
)

Selects the query frame for all GetMarker* functions below, in number of frame elapsed from the last one

Parameters
[in]_u32QueryFrameQuery frame, in number of frame elapsed since the last one (ie. 0 -> last frame, 1 -> frame before last, ...)
[in]_u32ThreadIDConcerned thread ID, if no data is found for this thread, orxSTATUS_FAILURE is returned
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE
orxDLLAPI void orxFASTCALL orxProfiler_Setup ( )

Setups Profiler module


Generated for orx by doxygen 1.5.6