Asserts
Asserts used by FidelityFX SDK functions.
Typedefs
|
Type |
Description |
|---|---|
|
typedef void |
(*FfxAssertCallback )(const char *message)
A typedef for the callback function for assert printing.
|
Functions
|
Return type |
Description |
|---|---|
|
FFX_API bool |
ffxAssertReport ( const char* file, int32_t line, const char* condition, const char* msg )
Function to report an assert.
|
|
FFX_API void |
ffxAssertSetPrintingCallback (FfxAssertCallback callback)
Provides the ability to set a callback for assert messages.
|
Macros
|
Name |
Description |
|---|---|
|
FFX_STATIC_ASSERT (condition) static_assert(condition, #condition) |
Simple static assert.
|
Detailed description
Asserts used by FidelityFX SDK functions.
Typedefs
FfxAssertCallback
Copied!
typedef void (*FfxAssertCallback )(const char *message)A typedef for the callback function for assert printing.
This can be used to re-route printing of assert messages from the FFX backend to another destination. For example instead of the default behaviour of printing the assert messages to the debugger’s TTY the message can be re-routed to a MessageBox in a GUI application.
Parameters:
|
message |
The message generated by the assert. |
Global functions
ffxAssertReport
Copied!
FFX_API bool ffxAssertReport (
const char* file,
int32_t line,
const char* condition,
const char* msg
)Function to report an assert.
Parameters:
|
file |
The name of the file as a string. |
|
line |
The index of the line in the file. |
|
condition |
The boolean condition that was tested. |
|
msg |
The optional message to print. |
Returns:
Always returns true.
ffxAssertSetPrintingCallback
Copied!
FFX_API void ffxAssertSetPrintingCallback (FfxAssertCallback callback)Provides the ability to set a callback for assert messages.
Parameters:
|
callback |
The callback function that will receive assert messages. |
Macros
FFX_STATIC_ASSERT
Copied!
#define FFX_STATIC_ASSERT (condition) static_assert(condition, #condition)Simple static assert.
