diff options
| author | Egor Yusov <egor.yusov@gmail.com> | 2018-03-27 16:06:36 +0000 |
|---|---|---|
| committer | Egor Yusov <egor.yusov@gmail.com> | 2018-03-27 16:06:36 +0000 |
| commit | d0f28728ac2b9a8c7349b26c7ea40182aa952a30 (patch) | |
| tree | 138c8cf101f539dc92ab967f05096779eee9faef /Primitives/interface | |
| parent | Added DebugMessageCallback to EngineCreation attribs (diff) | |
| download | DiligentCore-d0f28728ac2b9a8c7349b26c7ea40182aa952a30.tar.gz DiligentCore-d0f28728ac2b9a8c7349b26c7ea40182aa952a30.zip | |
Added comments
Diffstat (limited to 'Primitives/interface')
| -rw-r--r-- | Primitives/interface/DebugOutput.h | 15 |
1 files changed, 14 insertions, 1 deletions
diff --git a/Primitives/interface/DebugOutput.h b/Primitives/interface/DebugOutput.h index 969c8dd1..df8aab18 100644 --- a/Primitives/interface/DebugOutput.h +++ b/Primitives/interface/DebugOutput.h @@ -44,9 +44,22 @@ enum class DebugMessageSeverity : Int32 FatalError }; -using DebugMessageCallbackType = void(*)(DebugMessageSeverity, const Char* Message, const char* Function, const char* File, int Line); + +/// Type of the debug messag callback function + +/// \param [in] Severity - Message severity +/// \param [in] Message - Debug message +/// \param [in] Function - Name of the function or nullptr +/// \param [in] Function - File name or nullptr +/// \param [in] Line - Line number +using DebugMessageCallbackType = void(*)(DebugMessageSeverity Severity, const Char* Message, const char* Function, const char* File, int Line); extern DebugMessageCallbackType DebugMessageCallback; + +/// Sets the debug message callback function + +/// \note This function needs to be called for every executable module that +/// wants to use the callback. void SetDebugMessageCallback(DebugMessageCallbackType DbgMessageCallback); } |