errors.h File Reference

#include <string>
#include <Windows.h>

Go to the source code of this file.

Namespaces
	Blam
	Namespace surrounding all major engine components.
	Blam::Diagnostics
	Namespace containing things related to engine diagnostics, profiling, error handling, and logging.
	Blam::Diagnostics::Errors
	Namespace containing things relating to error information and reporting.
	Blam::Error
	Namespace containing things relating to Error information and reporting.

Macros
#define	BLAM
#define	BR_FAILED(result)   (result < 0)
#define	BR_SUCCEEDED(result)   (result >= 0)

Enumerations
enum	BlamErrorDisplayType { Log, Win32Dialog, Win32MessageBox, QtDialog }
	Enumerator used to control how error info from Blam::Error::ShowLastErrorInfo is displayed. More...
enum	BlamResult {   OK = 0, Error_Generic = -1, Error_FileNotFound = -2, Error_Init_SDL2_OpenGL_Failed = -40,   Error_Init_ImGui_OpenGL_Failed = -41, Error_Init_SDL2_D3D_Failed = -42, Error_Init_ImGui_D3D_Failed = -43, Error_Reserved44 = -44,   Error_Init_D3D11_Failed_Generic = -45, Error_Init_OpenGL3_Failed_Generic = -46, Error_Init_OpenGL3_CreateContext_Failed = -47 }
	Enumerator containing any and all result codes used throughout the engine. More...

Functions
BLAM std::string	Blam::Diagnostics::Errors::GetErrorString (BlamResult result)
BLAM void	Blam::Error::ShowLastErrorInfo (const char *function, BlamErrorDisplayType display_type)
	Displays the last error information from Windows. More...
BLAM int	Blam::Error::ShowErrorDialog (std::string message, HRESULT hr, bool allow_continue, bool allow_safemode)
	Shows an Error dialog with the specified error details and result handle. More...
BLAM std::string	Blam::Error::GetStringFromHResult (HRESULT hr)
	Converts a result handle to a string. More...

Macro Definition Documentation

BLAM

#define BLAM

BR_FAILED

#define BR_FAILED

(

result

)

(result < 0)

BR_SUCCEEDED

#define BR_SUCCEEDED

(

result

)

(result >= 0)

Enumeration Type Documentation

BlamErrorDisplayType

enum BlamErrorDisplayType

Enumerator used to control how error info from Blam::Error::ShowLastErrorInfo is displayed.

Enumerator
Log	Writes the error to the game log.
Win32Dialog	Shows an engine Error dialog.
Win32MessageBox	Shows a generic message box.
QtDialog	Shows a dialog created using Qt.

BlamResult

enum BlamResult

Enumerator containing any and all result codes used throughout the engine.

Enumerator
OK
Error_Generic
Error_FileNotFound
Error_Init_SDL2_OpenGL_Failed
Error_Init_ImGui_OpenGL_Failed
Error_Init_SDL2_D3D_Failed
Error_Init_ImGui_D3D_Failed
Error_Reserved44
Error_Init_D3D11_Failed_Generic
Error_Init_OpenGL3_Failed_Generic
Error_Init_OpenGL3_CreateContext_Failed