Skip to content

Asserts

Navigation: SDK → Host

Asserts

Asserts used by FidelityFX SDK functions.

Defines

FFX_STATIC_ASSERT

#define FFX_STATIC_ASSERT(condition) static_assert(condition, #condition)

Simple static assert.

Source: sdk/include/FidelityFX/host/ffx_assert.h (line 147, column 9)

Functions

ffxAssertReport

FFX_API bool ffxAssertReport(const char *file, int32_t line, const char *condition, const char *msg)

Function to report an assert.

Returns: Always returns true.

Parameters:

  • file (const char *) – [in] The name of the file as a string.
  • line (int32_t) – [in] The index of the line in the file.
  • condition (const char *) – [in] The boolean condition that was tested.
  • msg (const char *) – [in] The optional message to print.

Returns: FFX_API bool

Source: sdk/include/FidelityFX/host/ffx_assert.h (line 83, column 14)

ffxAssertSetPrintingCallback

FFX_API void ffxAssertSetPrintingCallback(FfxAssertCallback callback)

Provides the ability to set a callback for assert messages.

Parameters:

  • callback (FfxAssertCallback) – [in] The callback function that will receive assert messages.

Returns: FFX_API void

Source: sdk/include/FidelityFX/host/ffx_assert.h (line 90, column 14)

Typedefs

FfxAssertCallback

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.

Source: sdk/include/FidelityFX/host/ffx_assert.h (line 70, column 9)