|
enum | orxDEBUG_LEVEL {
orxDEBUG_LEVEL_ANIM = 0
, orxDEBUG_LEVEL_CLOCK
, orxDEBUG_LEVEL_COMMAND
, orxDEBUG_LEVEL_CONFIG
,
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
} |
Debug module Module used to output debug info and assert code
◆ orxASSERT
#define orxASSERT |
( |
| TEST, |
|
|
| ... ) |
◆ orxBREAK
◆ orxDEBUG_ENABLE_LEVEL
#define orxDEBUG_ENABLE_LEVEL |
( |
| LEVEL, |
|
|
| ENABLE ) |
Value:
orxDLLAPI void orxFASTCALL _orxDebug_EnableLevel(orxDEBUG_LEVEL _eLevel, orxBOOL _bEnable)
Definition at line 346 of file orxDebug.h.
◆ orxDEBUG_EXIT
#define orxDEBUG_EXIT |
( |
| ) |
|
Value:
orxDLLAPI void orxFASTCALL _orxDebug_Exit()
Definition at line 249 of file orxDebug.h.
◆ orxDEBUG_GET_FLAGS
#define orxDEBUG_GET_FLAGS |
( |
| ) |
|
Value:
orxDLLAPI orxU32 orxFASTCALL _orxDebug_GetFlags()
Definition at line 350 of file orxDebug.h.
◆ orxDEBUG_INIT
#define orxDEBUG_INIT |
( |
| ) |
|
Value:do \
{ \
orxU32 u32DebugFlags; \
_orxDebug_Init(); \
{ \
} \
{ \
} \
} \
#define orxDEBUG_KU32_STATIC_MASK_USER_ALL
#define orxDEBUG_KU32_STATIC_MASK_DEBUG
#define orxANSI_KZ_COLOR_FG_YELLOW
#define orxANSI_KZ_COLOR_BLINK_ON
#define orxANSI_KZ_COLOR_FG_GREEN
#define orxANSI_KZ_COLOR_FG_RED
#define orxANSI_KZ_COLOR_BLINK_OFF
#define orxANSI_KZ_COLOR_FG_DEFAULT
orxDLLAPI const orxSTRING orxFASTCALL orxSystem_GetVersionFullString()
orxDLLAPI orxU32 orxFASTCALL orxSystem_GetVersionNumeric()
#define __orxVERSION_FULL_STRING__
Definition at line 221 of file orxDebug.h.
◆ orxDEBUG_IS_LEVEL_ENABLED
#define orxDEBUG_IS_LEVEL_ENABLED |
( |
| LEVEL | ) |
|
Value:
orxDLLAPI orxBOOL orxFASTCALL _orxDebug_IsLevelEnabled(orxDEBUG_LEVEL _eLevel)
Definition at line 347 of file orxDebug.h.
◆ orxDEBUG_KS32_BUFFER_OUTPUT_SIZE
#define orxDEBUG_KS32_BUFFER_OUTPUT_SIZE 2048 |
◆ orxDEBUG_KU32_STATIC_FLAG_CALLBACK
#define orxDEBUG_KU32_STATIC_FLAG_CALLBACK 0x00000080 |
◆ orxDEBUG_KU32_STATIC_FLAG_CONSOLE
#define orxDEBUG_KU32_STATIC_FLAG_CONSOLE 0x00000040 |
◆ orxDEBUG_KU32_STATIC_FLAG_FILE
#define orxDEBUG_KU32_STATIC_FLAG_FILE 0x00000010 |
◆ orxDEBUG_KU32_STATIC_FLAG_FULL_TIMESTAMP
#define orxDEBUG_KU32_STATIC_FLAG_FULL_TIMESTAMP 0x00000002 |
◆ orxDEBUG_KU32_STATIC_FLAG_NONE
#define orxDEBUG_KU32_STATIC_FLAG_NONE 0x00000000 |
◆ orxDEBUG_KU32_STATIC_FLAG_TAGGED
#define orxDEBUG_KU32_STATIC_FLAG_TAGGED 0x00000008 |
◆ orxDEBUG_KU32_STATIC_FLAG_TERMINAL
#define orxDEBUG_KU32_STATIC_FLAG_TERMINAL 0x00000020 |
◆ orxDEBUG_KU32_STATIC_FLAG_TIMESTAMP
#define orxDEBUG_KU32_STATIC_FLAG_TIMESTAMP 0x00000001 |
◆ orxDEBUG_KU32_STATIC_FLAG_TYPE
#define orxDEBUG_KU32_STATIC_FLAG_TYPE 0x00000004 |
◆ orxDEBUG_KU32_STATIC_MASK_DEBUG
#define orxDEBUG_KU32_STATIC_MASK_DEBUG 0x000000BD |
◆ orxDEBUG_KU32_STATIC_MASK_DEFAULT
#define orxDEBUG_KU32_STATIC_MASK_DEFAULT 0x000000F5 |
◆ orxDEBUG_KU32_STATIC_MASK_USER_ALL
#define orxDEBUG_KU32_STATIC_MASK_USER_ALL 0x0FFFFFFF |
◆ orxDEBUG_KZ_DATE_FORMAT
◆ orxDEBUG_KZ_DATE_FULL_FORMAT
◆ orxDEBUG_KZ_DEFAULT_DEBUG_FILE
#define orxDEBUG_KZ_DEFAULT_DEBUG_FILE "orx-debug.log" |
◆ orxDEBUG_KZ_DEFAULT_DEBUG_SUFFIX
#define orxDEBUG_KZ_DEFAULT_DEBUG_SUFFIX "-debug.log" |
◆ orxDEBUG_KZ_DEFAULT_LOG_FILE
#define orxDEBUG_KZ_DEFAULT_LOG_FILE "orx.log" |
◆ orxDEBUG_KZ_DEFAULT_LOG_SUFFIX
#define orxDEBUG_KZ_DEFAULT_LOG_SUFFIX ".log" |
◆ orxDEBUG_KZ_FILE_FORMAT
◆ orxDEBUG_KZ_TYPE_ERROR_FORMAT
◆ orxDEBUG_KZ_TYPE_LOG_FORMAT
◆ orxDEBUG_KZ_TYPE_WARNING_FORMAT
◆ orxDEBUG_PRINT
#define orxDEBUG_PRINT |
( |
| LEVEL, |
|
|
| STRING, |
|
|
| ... ) |
◆ orxDEBUG_SET_FLAGS
#define orxDEBUG_SET_FLAGS |
( |
| SET, |
|
|
| UNSET ) |
Value:
orxDLLAPI void orxFASTCALL _orxDebug_SetFlags(orxU32 _u32Add, orxU32 _u32Remove)
Definition at line 349 of file orxDebug.h.
◆ orxDEBUG_SET_LOG_CALLBACK
#define orxDEBUG_SET_LOG_CALLBACK |
( |
| CALLBACK | ) |
|
Value:
orxDLLAPI void orxFASTCALL _orxDebug_SetLogCallback(const orxDEBUG_CALLBACK_FUNCTION _pfnLogCallback)
Definition at line 352 of file orxDebug.h.
◆ orxDEBUG_SETBASEFILENAME
#define orxDEBUG_SETBASEFILENAME |
( |
| FILE | ) |
|
Value: do \
{ \
{ \
orxCHAR zBuffer[512]; \
\
_orxDebug_SetLogFile(zBuffer); \
} \
else \
{ \
_orxDebug_SetLogFile(FILE); \
} \
#define orxDEBUG_KZ_DEFAULT_LOG_SUFFIX
orxDLLAPI const orxSTRING orxSTRING_EMPTY
Definition at line 360 of file orxDebug.h.
◆ orxDEBUG_SETDEBUGFILE
#define orxDEBUG_SETDEBUGFILE |
( |
| FILE | ) |
|
◆ orxDEBUG_SETLOGFILE
#define orxDEBUG_SETLOGFILE |
( |
| FILE | ) |
|
Value:
orxDLLAPI void orxFASTCALL _orxDebug_SetLogFile(const orxSTRING _zFileName)
Definition at line 359 of file orxDebug.h.
◆ orxDEBUG_CALLBACK_FUNCTION
typedef orxSTATUS(orxFASTCALL * orxDEBUG_CALLBACK_FUNCTION) (orxDEBUG_LEVEL _eLevel, const orxSTRING _zFunction, const orxSTRING _zFile, orxU32 _u32Line, const orxSTRING _zLog) |
◆ orxDEBUG_LEVEL
Enumerator |
---|
orxDEBUG_LEVEL_ANIM | Anim Debug
|
orxDEBUG_LEVEL_CLOCK | Clock Debug
|
orxDEBUG_LEVEL_COMMAND | Command Debug
|
orxDEBUG_LEVEL_CONFIG | Config Debug
|
orxDEBUG_LEVEL_DISPLAY | Display Debug
|
orxDEBUG_LEVEL_FILE | File Debug
|
orxDEBUG_LEVEL_INPUT | Input Debug
|
orxDEBUG_LEVEL_JOYSTICK | Joystick Debug
|
orxDEBUG_LEVEL_KEYBOARD | Keyboard Debug
|
orxDEBUG_LEVEL_MEMORY | Memory Debug
|
orxDEBUG_LEVEL_MOUSE | Mouse Debug
|
orxDEBUG_LEVEL_OBJECT | Object Debug
|
orxDEBUG_LEVEL_PARAM | Param Debug
|
orxDEBUG_LEVEL_PHYSICS | Physics Debug
|
orxDEBUG_LEVEL_PLUGIN | Plug-in Debug
|
orxDEBUG_LEVEL_PROFILER | Profiler Debug
|
orxDEBUG_LEVEL_RENDER | Render Debug
|
orxDEBUG_LEVEL_SCREENSHOT | Screenshot Debug
|
orxDEBUG_LEVEL_SOUND | Sound Debug
|
orxDEBUG_LEVEL_SYSTEM | System Debug
|
orxDEBUG_LEVEL_TIMER | Timer Debug
|
orxDEBUG_LEVEL_LOG | Log Debug
|
orxDEBUG_LEVEL_ASSERT | Assert Debug
|
orxDEBUG_LEVEL_USER | User Debug
|
orxDEBUG_LEVEL_NUMBER | |
orxDEBUG_LEVEL_MAX_NUMBER | |
orxDEBUG_LEVEL_ALL | All Debugs
|
orxDEBUG_LEVEL_NONE | |
Definition at line 81 of file orxDebug.h.
◆ _orxDebug_Break()
orxDLLAPI void orxFASTCALL _orxDebug_Break |
( |
| ) |
|
|
extern |
◆ _orxDebug_EnableLevel()
Enables/disables a given log level
- Parameters
-
[in] | _eLevel | Debug level to enable/disable |
[in] | _bEnable | Enable / disable |
◆ _orxDebug_Exit()
orxDLLAPI void orxFASTCALL _orxDebug_Exit |
( |
| ) |
|
|
extern |
Exits from the debug module
◆ _orxDebug_GetFlags()
orxDLLAPI orxU32 orxFASTCALL _orxDebug_GetFlags |
( |
| ) |
|
|
extern |
Gets current debug flags
- Returns
- Current debug flags
◆ _orxDebug_Init()
Inits the debug module
- Returns
- orxSTATUS_SUCCESS / orxSTATUS_FAILURE
◆ _orxDebug_IsLevelEnabled()
Is a given log level enabled?
- Parameters
-
[in] | _eLevel | Concerned debug level |
◆ _orxDebug_Log()
orxDLLAPI void orxCDECL _orxDebug_Log |
( |
orxDEBUG_LEVEL | _eLevel, |
|
|
const orxSTRING | _zFunction, |
|
|
const orxSTRING | _zFile, |
|
|
orxU32 | _u32Line, |
|
|
const orxSTRING | _zFormat, |
|
|
| ... ) |
|
extern |
Logs given debug text
- Parameters
-
[in] | _eLevel | Debug level associated with this output |
[in] | _zFunction | Calling function name |
[in] | _zFile | Calling file name |
[in] | _u32Line | Calling file line |
[in] | _zFormat | Printf formatted text |
◆ _orxDebug_SetDebugFile()
orxDLLAPI void orxFASTCALL _orxDebug_SetDebugFile |
( |
const orxSTRING | _zFileName | ) |
|
|
extern |
Sets debug file name
- Parameters
-
[in] | _zFileName | Debug file name |
◆ _orxDebug_SetFlags()
orxDLLAPI void orxFASTCALL _orxDebug_SetFlags |
( |
orxU32 | _u32Add, |
|
|
orxU32 | _u32Remove ) |
|
extern |
Sets current debug flags
- Parameters
-
[in] | _u32Add | Flags to add |
[in] | _u32Remove | Flags to remove |
◆ _orxDebug_SetLogCallback()
Sets log callback function, if the callback returns orxSTATUS_FAILURE, the log entry will be entirely inhibited
- Parameters
-
[in] | _pfnLogCallback | Log callback function, orxNULL to remove it |
◆ _orxDebug_SetLogFile()
orxDLLAPI void orxFASTCALL _orxDebug_SetLogFile |
( |
const orxSTRING | _zFileName | ) |
|
|
extern |
Sets log file name
- Parameters
-
[in] | _zFileName | Log file name |