orxProfiler.h

Go to the documentation of this file.

/* Orx - Portable Game Engine
 *
 * Copyright (c) 2008-2022 Orx-Project
 *
 * This software is provided 'as-is', without any express or implied
 * warranty. In no event will the authors be held liable for any damages
 * arising from the use of this software.
 *
 * Permission is granted to anyone to use this software for any purpose,
 * including commercial applications, and to alter it and redistribute it
 * freely, subject to the following restrictions:
 *
 *    1. The origin of this software must not be misrepresented; you must not
 *    claim that you wrote the original software. If you use this software
 *    in a product, an acknowledgment in the product documentation would be
 *    appreciated but is not required.
 *
 *    2. Altered source versions must be plainly marked as such, and must not be
 *    misrepresented as being the original software.
 *
 *    3. This notice may not be removed or altered from any source
 *    distribution.
 */

#ifndef _orxPROFILER_H_
#define _orxPROFILER_H_


#include "orxInclude.h"

#include "core/orxThread.h"


/* *** Uncomment the line below to enable orx profiling in non debug builds *** */
//#define __orxPROFILER__


#ifdef __orxPROFILER__

  #define orxPROFILER_PUSH_MARKER(NAME)                             \
  do                                                                \
  {                                                                 \
    static orxS32 s32ProfilerID = orxPROFILER_KS32_MARKER_ID_NONE;  \
                                                                    \
    if(orxProfiler_IsMarkerIDValid(s32ProfilerID) == orxFALSE)      \
    {                                                               \
      s32ProfilerID = orxProfiler_GetIDFromName(NAME);              \
    }                                                               \
                                                                    \
    orxProfiler_PushMarker(s32ProfilerID);                          \
  } while(orxFALSE)


  #define orxPROFILER_POP_MARKER()                                  \
  do                                                                \
  {                                                                 \
    orxProfiler_PopMarker();                                        \
  } while(orxFALSE)

  #define orxPROFILER_KU32_HISTORY_LENGTH         (3 * 60)

#else /* __orxPROFILER__ */

  #define orxPROFILER_PUSH_MARKER(NAME)

  #define orxPROFILER_POP_MARKER()

  #define orxPROFILER_KU32_HISTORY_LENGTH         2

#endif /* __orxPROFILER__ */


#define orxPROFILER_KS32_MARKER_ID_NONE           -1


extern orxDLLAPI void orxFASTCALL                 orxProfiler_Setup();

extern orxDLLAPI orxSTATUS orxFASTCALL            orxProfiler_Init();

extern orxDLLAPI void orxFASTCALL                 orxProfiler_Exit();


extern orxDLLAPI orxS32 orxFASTCALL               orxProfiler_GetIDFromName(const orxSTRING _zName);

extern orxDLLAPI orxBOOL orxFASTCALL              orxProfiler_IsMarkerIDValid(orxS32 _s32MarkerID);


extern orxDLLAPI void orxFASTCALL                 orxProfiler_PushMarker(orxS32 _s32MarkerID);

extern orxDLLAPI void orxFASTCALL                 orxProfiler_PopMarker();

extern orxDLLAPI void orxFASTCALL                 orxProfiler_EnableMarkerOperations(orxBOOL _bEnable);

extern orxDLLAPI orxBOOL orxFASTCALL              orxProfiler_AreMarkerOperationsEnabled();

extern orxDLLAPI void orxFASTCALL                 orxProfiler_Pause(orxBOOL _bPause);

extern orxDLLAPI orxBOOL orxFASTCALL              orxProfiler_IsPaused();


extern orxDLLAPI void orxFASTCALL                 orxProfiler_ResetAllMarkers();

extern orxDLLAPI void orxFASTCALL                 orxProfiler_ResetAllMaxima();

extern orxDLLAPI orxDOUBLE orxFASTCALL            orxProfiler_GetResetTime();

extern orxDLLAPI orxDOUBLE orxFASTCALL            orxProfiler_GetMaxResetTime();


extern orxDLLAPI orxS32 orxFASTCALL               orxProfiler_GetMarkerCount();


extern orxDLLAPI orxS32 orxFASTCALL               orxProfiler_GetNextMarkerID(orxS32 _s32MarkerID);

extern orxDLLAPI orxS32 orxFASTCALL               orxProfiler_GetNextSortedMarkerID(orxS32 _s32MarkerID);


extern orxDLLAPI orxSTATUS orxFASTCALL            orxProfiler_SelectQueryFrame(orxU32 _u32QueryFrame, orxU32 _u32ThreadID);


extern orxDLLAPI orxDOUBLE orxFASTCALL            orxProfiler_GetMarkerTime(orxS32 _s32MarkerID);

extern orxDLLAPI orxDOUBLE orxFASTCALL            orxProfiler_GetMarkerMaxTime(orxS32 _s32MarkerID);

extern orxDLLAPI const orxSTRING orxFASTCALL      orxProfiler_GetMarkerName(orxS32 _s32MarkerID);

extern orxDLLAPI orxU32 orxFASTCALL               orxProfiler_GetMarkerPushCount(orxS32 _s32MarkerID);


extern orxDLLAPI orxBOOL orxFASTCALL              orxProfiler_IsUniqueMarker(orxS32 _s32MarkerID);


extern orxDLLAPI orxDOUBLE orxFASTCALL            orxProfiler_GetUniqueMarkerStartTime(orxS32 _s32MarkerID);

extern orxDLLAPI orxU32 orxFASTCALL               orxProfiler_GetUniqueMarkerDepth(orxS32 _s32MarkerID);


#endif /* _orxPROFILER_H_ */