orx  stable
Portable Game Engine
orxDebug.h File Reference
#include "orxInclude.h"

Go to the source code of this file.

Macros

#define orxASSERT(TEST, ...)
 
#define orxBREAK()
 
#define orxDEBUG_ENABLE_LEVEL(LEVEL, ENABLE)   _orxDebug_EnableLevel(LEVEL, ENABLE)
 
#define orxDEBUG_EXIT()    _orxDebug_Exit()
 
#define orxDEBUG_GET_FLAGS()    _orxDebug_GetFlags()
 
#define orxDEBUG_INIT()
 
#define orxDEBUG_IS_LEVEL_ENABLED(LEVEL)    _orxDebug_IsLevelEnabled(LEVEL)
 
#define orxDEBUG_KS32_BUFFER_OUTPUT_SIZE   2048
 
#define orxDEBUG_KU32_STATIC_FLAG_CONSOLE   0x00000040
 
#define orxDEBUG_KU32_STATIC_FLAG_FILE   0x00000010
 
#define orxDEBUG_KU32_STATIC_FLAG_FULL_TIMESTAMP   0x00000002
 
#define orxDEBUG_KU32_STATIC_FLAG_NONE   0x00000000
 
#define orxDEBUG_KU32_STATIC_FLAG_TAGGED   0x00000008
 
#define orxDEBUG_KU32_STATIC_FLAG_TERMINAL   0x00000020
 
#define orxDEBUG_KU32_STATIC_FLAG_TIMESTAMP   0x00000001
 
#define orxDEBUG_KU32_STATIC_FLAG_TYPE   0x00000004
 
#define orxDEBUG_KU32_STATIC_MASK_DEBUG   0x0000003D
 
#define orxDEBUG_KU32_STATIC_MASK_DEFAULT   0x00000075
 
#define orxDEBUG_KU32_STATIC_MASK_USER_ALL   0x0FFFFFFF
 
#define orxDEBUG_KZ_DATE_FORMAT   orxANSI_KZ_COLOR_FG_CYAN "[%H:%M:%S]" orxANSI_KZ_COLOR_RESET
 
#define orxDEBUG_KZ_DATE_FULL_FORMAT   orxANSI_KZ_COLOR_FG_CYAN "[%Y-%m-%d %H:%M:%S]" orxANSI_KZ_COLOR_RESET
 
#define orxDEBUG_KZ_DEFAULT_DEBUG_FILE   "orx-debug.log"
 
#define orxDEBUG_KZ_DEFAULT_DEBUG_SUFFIX   "-debug.log"
 
#define orxDEBUG_KZ_DEFAULT_LOG_FILE   "orx.log"
 
#define orxDEBUG_KZ_DEFAULT_LOG_SUFFIX   ".log"
 
#define orxDEBUG_KZ_FILE_FORMAT   orxANSI_KZ_COLOR_FG_MAGENTA "[%s:%s(%u)]" orxANSI_KZ_COLOR_RESET
 
#define orxDEBUG_KZ_TYPE_ERROR_FORMAT   orxANSI_KZ_COLOR_FG_RED "[%s]" orxANSI_KZ_COLOR_RESET
 
#define orxDEBUG_KZ_TYPE_LOG_FORMAT   orxANSI_KZ_COLOR_FG_GREEN "[%s]" orxANSI_KZ_COLOR_RESET
 
#define orxDEBUG_KZ_TYPE_WARNING_FORMAT   orxANSI_KZ_COLOR_FG_YELLOW "[%s]" orxANSI_KZ_COLOR_RESET
 
#define orxDEBUG_PRINT(LEVEL, STRING, ...)
 
#define orxDEBUG_SET_FLAGS(SET, UNSET)    _orxDebug_SetFlags(SET, UNSET)
 
#define orxDEBUG_SETBASEFILENAME(FILE)
 
#define orxDEBUG_SETDEBUGFILE(FILE)
 
#define orxDEBUG_SETLOGFILE(FILE)    _orxDebug_SetLogFile(FILE)
 

Enumerations

enum  orxDEBUG_LEVEL {
  orxDEBUG_LEVEL_ANIM = 0, orxDEBUG_LEVEL_CONFIG, orxDEBUG_LEVEL_CLOCK, orxDEBUG_LEVEL_DISPLAY,
  orxDEBUG_LEVEL_FILE, orxDEBUG_LEVEL_INPUT, orxDEBUG_LEVEL_JOYSTICK, orxDEBUG_LEVEL_KEYBOARD,
  orxDEBUG_LEVEL_MEMORY, orxDEBUG_LEVEL_MOUSE, orxDEBUG_LEVEL_OBJECT, orxDEBUG_LEVEL_PARAM,
  orxDEBUG_LEVEL_PHYSICS, orxDEBUG_LEVEL_PLUGIN, orxDEBUG_LEVEL_PROFILER, orxDEBUG_LEVEL_RENDER,
  orxDEBUG_LEVEL_SCREENSHOT, orxDEBUG_LEVEL_SOUND, orxDEBUG_LEVEL_SYSTEM, orxDEBUG_LEVEL_TIMER,
  orxDEBUG_LEVEL_LOG, orxDEBUG_LEVEL_ASSERT, orxDEBUG_LEVEL_USER, orxDEBUG_LEVEL_NUMBER,
  orxDEBUG_LEVEL_MAX_NUMBER = 32, orxDEBUG_LEVEL_ALL = 0xFFFFFFFE, orxDEBUG_LEVEL_NONE = orxENUM_NONE
}
 

Functions

orxDLLAPI void orxFASTCALL _orxDebug_Break ()
 
orxDLLAPI void orxFASTCALL _orxDebug_EnableLevel (orxDEBUG_LEVEL _eLevel, orxBOOL _bEnable)
 
orxDLLAPI void orxFASTCALL _orxDebug_Exit ()
 
orxDLLAPI orxU32 orxFASTCALL _orxDebug_GetFlags ()
 
orxDLLAPI orxSTATUS orxFASTCALL _orxDebug_Init ()
 
orxDLLAPI orxBOOL orxFASTCALL _orxDebug_IsLevelEnabled (orxDEBUG_LEVEL _eLevel)
 
orxDLLAPI void orxCDECL _orxDebug_Log (orxDEBUG_LEVEL _eLevel, const orxSTRING _zFunction, const orxSTRING _zFile, orxU32 _u32Line, const orxSTRING _zFormat,...)
 
orxDLLAPI void orxFASTCALL _orxDebug_SetDebugFile (const orxSTRING _zFileName)
 
orxDLLAPI void orxFASTCALL _orxDebug_SetFlags (orxU32 _u32Add, orxU32 _u32Remove)
 
orxDLLAPI void orxFASTCALL _orxDebug_SetLogFile (const orxSTRING _zFileName)
 

Detailed Description

Date
10/12/2003
Author
iarwa.nosp@m.in@o.nosp@m.rx-pr.nosp@m.ojec.nosp@m.t.org
Todo:
  • Add graphical debug from outside, using a shared debug info array
  • Enhance logging, use of different log levels / colors

Definition in file orxDebug.h.


Generated for orx by doxygen 1.5.6