Miscellaneous

FidelityFX Cauldron Framework Misc reference documentation.

Modules

Enumerations

Name

Description

LogLevel

An enumeration of message log types.
LOGLEVEL_TRACE = 0x1 << 0 – Trace message.
LOGLEVEL_DEBUG = 0x1 << 1 – Debug message (only shows in debug builds).
LOGLEVEL_INFO = 0x1 << 2 – Information message.
LOGLEVEL_WARNING = 0x1 << 3 – Warning message.
LOGLEVEL_ERROR = 0x1 << 4 – Error message. Will show an error dialog on Windows.
LOGLEVEL_FATAL = 0x1 << 5 – Fatal message. This will throw a critical assert and halt execution.
LOGLEVEL_COUNT = 6 – Message type count.

Structs

Name

Description

LogMessageEntry

Structure used to fetch filtered messages based on a message type.

Classes

Name

Description

Log

This is the logger for FidelityFX Cauldron Framework.

MessageBuffer

Represents a message entry in our list of log messages.

Sync

Sync primitive class (CPU-side multithreading synchronization).

ThreadSafeQueue

Thread-safe queue implementation.

ThreadSafeRingBuffer

Thread-safe ring buffer used to back logging system.