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_GetMarkerCount ()
orxDLLAPI orxDOUBLE orxFASTCALL	orxProfiler_GetMarkerMaxTime (orxS32 _s32MarkerID)
orxDLLAPI const orxSTRING orxFASTCALL	orxProfiler_GetMarkerName (orxS32 _s32MarkerID)
orxDLLAPI orxU32 orxFASTCALL	orxProfiler_GetMarkerPushCount (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

◆ orxPROFILER_KS32_MARKER_ID_NONE

#define orxPROFILER_KS32_MARKER_ID_NONE -1

Defines

Definition at line 95 of file orxProfiler.h.

◆ orxPROFILER_KU32_HISTORY_LENGTH

#define orxPROFILER_KU32_HISTORY_LENGTH 2

Definition at line 88 of file orxProfiler.h.

◆ orxPROFILER_POP_MARKER

#define orxPROFILER_POP_MARKER ( )

Definition at line 86 of file orxProfiler.h.

◆ orxPROFILER_PUSH_MARKER

#define orxPROFILER_PUSH_MARKER ( NAME )

Profiler macros

Definition at line 84 of file orxProfiler.h.

Function Documentation

◆ orxProfiler_AreMarkerOperationsEnabled()

orxDLLAPI orxBOOL orxFASTCALL orxProfiler_AreMarkerOperationsEnabled ( )

extern

Are marker push/pop operations enabled?

Returns: orxTRUE / orxFALSE

◆ orxProfiler_EnableMarkerOperations()

orxDLLAPI void orxFASTCALL orxProfiler_EnableMarkerOperations ( orxBOOL _bEnable )

extern

Enables marker push/pop operations

Parameters

[in] _bEnable Enable

◆ orxProfiler_Exit()

orxDLLAPI void orxFASTCALL orxProfiler_Exit ( )

extern

Exits from the Profiler module

◆ orxProfiler_GetIDFromName()

orxDLLAPI orxS32 orxFASTCALL orxProfiler_GetIDFromName ( const orxSTRING _zName )

extern

Gets a marker ID given a name

Parameters

[in] _zName Name of the marker

Returns: Marker's ID / orxPROFILER_KS32_MARKER_ID_NONE

◆ orxProfiler_GetMarkerCount()

orxDLLAPI orxS32 orxFASTCALL orxProfiler_GetMarkerCount ( )

extern

Gets the number of registered markers used on the queried thread

Returns: Number of registered markers

◆ orxProfiler_GetMarkerMaxTime()

orxDLLAPI orxDOUBLE orxFASTCALL orxProfiler_GetMarkerMaxTime ( orxS32 _s32MarkerID )

extern

Gets the marker's maximum cumulated time

Parameters

[in] _s32MarkerID Concerned marker ID

Returns: Marker's max cumulated time

◆ orxProfiler_GetMarkerName()

orxDLLAPI const orxSTRING orxFASTCALL orxProfiler_GetMarkerName ( orxS32 _s32MarkerID )

extern

Gets the marker's name

Parameters

[in] _s32MarkerID Concerned marker ID

Returns: Marker's name

◆ orxProfiler_GetMarkerPushCount()

orxDLLAPI orxU32 orxFASTCALL orxProfiler_GetMarkerPushCount ( orxS32 _s32MarkerID )

extern

Gets the marker's push count

Parameters

[in] _s32MarkerID Concerned marker ID

Returns: Number of time the marker has been pushed since last reset

◆ orxProfiler_GetMarkerTime()

orxDLLAPI orxDOUBLE orxFASTCALL orxProfiler_GetMarkerTime ( orxS32 _s32MarkerID )

extern

Gets the marker's cumulated time

Parameters

[in] _s32MarkerID Concerned marker ID

Returns: Marker's cumulated time

◆ orxProfiler_GetMaxResetTime()

orxDLLAPI orxDOUBLE orxFASTCALL orxProfiler_GetMaxResetTime ( )

extern

Gets the maximum reset time

Returns: Max reset time, in seconds

◆ orxProfiler_GetNextMarkerID()

orxDLLAPI orxS32 orxFASTCALL orxProfiler_GetNextMarkerID ( orxS32 _s32MarkerID )

extern

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

◆ orxProfiler_GetNextSortedMarkerID()

orxDLLAPI orxS32 orxFASTCALL orxProfiler_GetNextSortedMarkerID ( orxS32 _s32MarkerID )

extern

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

◆ orxProfiler_GetResetTime()

orxDLLAPI orxDOUBLE orxFASTCALL orxProfiler_GetResetTime ( )

extern

Gets the time elapsed since last reset

Returns: Time elapsed since the last reset, in seconds

◆ orxProfiler_GetUniqueMarkerDepth()

orxDLLAPI orxU32 orxFASTCALL orxProfiler_GetUniqueMarkerDepth ( orxS32 _s32MarkerID )

extern

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

◆ orxProfiler_GetUniqueMarkerStartTime()

orxDLLAPI orxDOUBLE orxFASTCALL orxProfiler_GetUniqueMarkerStartTime ( orxS32 _s32MarkerID )

extern

Gets the uniquely pushed marker's start time

Parameters

[in] _s32MarkerID Concerned marker ID

Returns: Marker's start time / 0.0

◆ orxProfiler_Init()

orxDLLAPI orxSTATUS orxFASTCALL orxProfiler_Init ( )

extern

Inits the Profiler module

Returns: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

◆ orxProfiler_IsMarkerIDValid()

orxDLLAPI orxBOOL orxFASTCALL orxProfiler_IsMarkerIDValid ( orxS32 _s32MarkerID )

extern

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

◆ orxProfiler_IsPaused()

orxDLLAPI orxBOOL orxFASTCALL orxProfiler_IsPaused ( )

extern

Is profiler paused?

Returns: orxTRUE / orxFALSE

◆ orxProfiler_IsUniqueMarker()

orxDLLAPI orxBOOL orxFASTCALL orxProfiler_IsUniqueMarker ( orxS32 _s32MarkerID )

extern

Has the marker been pushed by a unique parent?

Parameters

[in] _s32MarkerID Concerned marker ID

Returns: orxTRUE / orxFALSE

◆ orxProfiler_Pause()

orxDLLAPI void orxFASTCALL orxProfiler_Pause ( orxBOOL _bPause )

extern

Pauses/unpauses the profiler

Parameters

[in] _bPause Pause

◆ orxProfiler_PopMarker()

orxDLLAPI void orxFASTCALL orxProfiler_PopMarker ( )

extern

Pops a marker (from the stack) and updates its cumulated time (using the last marker push time)

◆ orxProfiler_PushMarker()

orxDLLAPI void orxFASTCALL orxProfiler_PushMarker ( orxS32 _s32MarkerID )

extern

Pushes a marker (on a stack) and starts a timer for it

Parameters

[in] _s32MarkerID ID of the marker to push

◆ orxProfiler_ResetAllMarkers()

orxDLLAPI void orxFASTCALL orxProfiler_ResetAllMarkers ( )

extern

Resets all markers (usually called at the end of the frame)

◆ orxProfiler_ResetAllMaxima()

orxDLLAPI void orxFASTCALL orxProfiler_ResetAllMaxima ( )

extern

Resets all maxima (usually called at a regular interval)

◆ orxProfiler_SelectQueryFrame()

orxDLLAPI orxSTATUS orxFASTCALL orxProfiler_SelectQueryFrame	(	orxU32	_u32QueryFrame,
		orxU32	_u32ThreadID )

extern

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

Parameters

[in]	_u32QueryFrame	Query frame, in number of frame elapsed since the last one (ie. 0 -> last frame, 1 -> frame before last, ...)
[in]	_u32ThreadID	Concerned thread ID, if no data is found for this thread, orxSTATUS_FAILURE is returned

Returns: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

◆ orxProfiler_Setup()

orxDLLAPI void orxFASTCALL orxProfiler_Setup ( )

extern

Setups Profiler module

Macros

Functions

Detailed Description

Macro Definition Documentation

◆ orxPROFILER_KS32_MARKER_ID_NONE

◆ orxPROFILER_KU32_HISTORY_LENGTH

◆ orxPROFILER_POP_MARKER

◆ orxPROFILER_PUSH_MARKER

Function Documentation

◆ orxProfiler_AreMarkerOperationsEnabled()

◆ orxProfiler_EnableMarkerOperations()

◆ orxProfiler_Exit()

◆ orxProfiler_GetIDFromName()

◆ orxProfiler_GetMarkerCount()

◆ orxProfiler_GetMarkerMaxTime()

◆ orxProfiler_GetMarkerName()

◆ orxProfiler_GetMarkerPushCount()

◆ orxProfiler_GetMarkerTime()

◆ orxProfiler_GetMaxResetTime()

◆ orxProfiler_GetNextMarkerID()

◆ orxProfiler_GetNextSortedMarkerID()

◆ orxProfiler_GetResetTime()

◆ orxProfiler_GetUniqueMarkerDepth()

◆ orxProfiler_GetUniqueMarkerStartTime()

◆ orxProfiler_Init()

◆ orxProfiler_IsMarkerIDValid()

◆ orxProfiler_IsPaused()

◆ orxProfiler_IsUniqueMarker()

◆ orxProfiler_Pause()

◆ orxProfiler_PopMarker()

◆ orxProfiler_PushMarker()

◆ orxProfiler_ResetAllMarkers()

◆ orxProfiler_ResetAllMaxima()

◆ orxProfiler_SelectQueryFrame()

◆ orxProfiler_Setup()