Assert

Navigation: Samples → Cauldron → Miscellaneous

Assert

FidelityFX Cauldron Framework’s assert support.

Defines

Stringize

#define Stringize(L) #L

Converts \L into a string in the context of a define (macro).

Source: framework/cauldron/framework/inc/misc/assert.h (line 43, column 9)

MakeString

#define MakeString(M, L) M(L)

Calls passed in macro \M with parameter \L (used to make a string via Stringize.

Source: framework/cauldron/framework/inc/misc/assert.h (line 49, column 9)

Reminder

#define Reminder __FILE__ "(" $Line ") : Reminder: "

Macros for pragma message() statements, links message to corresponding line of code. Usage: pragma message(Reminder “message goes here”)

Source: framework/cauldron/framework/inc/misc/assert.h (line 62, column 9)

Functions

CauldronAssert

inline void CauldronAssert(AssertLevel severity, bool condition, const wchar_t *format,...)

Calls the proper assertion function according to the AssertLevel passed in.

Returns: None.

Parameters:

• severity (AssertLevel) – [in] The AssertLevel to process.
• condition (bool)
• format (const wchar_t *) – [in] The formatted string to parse and pass to the assert function.
• “ (...)

Attributes: inline

Source: framework/cauldron/framework/inc/misc/assert.h (line 207, column 17)

Enumerations

AssertLevel

enum AssertLevel

An enumeration of Cauldron’s assertion levels.

Values:

ASSERT_WARNING

ASSERT_WARNING = 0

Warning.

ASSERT_ERROR

Error. (Displays error UI if supported on Platform)

ASSERT_CRITICAL

Critical. Throws calling application.

Source: framework/cauldron/framework/inc/misc/assert.h (line 192, column 5)