Assert
FidelityFX Cauldron Framework ‘s assert support.
Enumerations
|
Name |
Description |
|---|---|
|
AssertLevel |
An enumeration of “Cauldron“ ‘s assertion levels.
ASSERT_WARNING = 0 – Warning.
ASSERT_ERROR – Error. (Displays error UI if supported on Platform)
ASSERT_CRITICAL – Critical. Throws calling application.
|
Functions
|
Return type |
Description |
|---|---|
|
void |
cauldron::CauldronAssert ( AssertLevel severity, bool condition, const wchar_t* format, … )
Calls the proper assertion function according to the “AssertLevel“ passed in.
|
Macros
|
Name |
Description |
|---|---|
|
MakeString (M, L) M(L) |
Calls passed in macro M with parameter L (used to make a string via
Stringize. |
|
Reminder __FILE__ “(” $Line “) : Reminder: “ |
Macros for pragma message() statements, links message to corresponding line of code. Usage: pragma message(Reminder “message goes here”)
|
|
Stringize (L) #L |
Converts L into a string in the context of a define (macro).
|
Detailed description
FidelityFX Cauldron Framework ‘s assert support.
Global functions
CauldronAssert
Copied!
void cauldron::CauldronAssert (
AssertLevel severity,
bool condition,
const wchar_t* format,
...
)Calls the proper assertion function according to the AssertLevel passed in.
Parameters:
|
severity |
The |
|
format |
The formatted string to parse and pass to the assert function. |
Returns:
None.
Macros
MakeString
Copied!
#define MakeString (M, L) M(L)Calls passed in macro M with parameter L (used to make a string via Stringize.
Reminder
Copied!
#define Reminder __FILE__ "(" $Line ") : Reminder: "Macros for pragma message() statements, links message to corresponding line of code. Usage: pragma message(Reminder “message goes here”)
Stringize
Copied!
#define Stringize (L) #LConverts L into a string in the context of a define (macro).
