class Log

This is the logger for FidelityFX Cauldron Framework.

File location: framework/cauldron/framework/inc/misc/log.h

Construction

Return type

Description
Log (const wchar_t* filename)
Log construction with filename to write results to.

Methods

Return type

Description

static int
InitLogSystem (const wchar_t* filename)
Log system initialization. Called as part of “Framework“ initialization.

static int
TerminateLogSystem ()
Log system termination. Called as part of “Framework“ shutdown.

static void
Write (LogLevel level, const wchar_t* text, …)
Writes a log message.

static void
WriteDetailed ( LogLevel level, const wchar_t* filename, int line, const wchar_t* text, … )
Writes a detailed log message. Detailed message contain file and line identifiers.

static std::wstring
GetMessages (int32_t flags = 0xffff)
Gets all the messages with the requested levels. It returns a single string with all the messages.

static void
GetMessages (std::vector<LogMessageEntry >& messages, int32_t flags = 0xffff)
Gets all the messages with the requested levels. It returns a vector with all of the individual messages.

static void
QueryMessageCounts (std::array<uint32_t, LOGLEVEL_COUNT >& countAray)
Gets the number of messages for each message type.

Detailed description

This is the logger for FidelityFX Cauldron Framework. It provides a static interface for message logging.

Construction

Log

Copied!

Log (const wchar_t* filename)

Log construction with filename to write results to.

Methods

InitLogSystem

Copied!

static int InitLogSystem (const wchar_t* filename)

Log system initialization. Called as part of Framework initialization.

TerminateLogSystem

Copied!

static int TerminateLogSystem ()

Log system termination. Called as part of Framework shutdown.

Write

Copied!

static void Write (LogLevel  level, const wchar_t* text, ...)

Writes a log message.

WriteDetailed

Copied!

static void WriteDetailed (
    LogLevel  level,
    const wchar_t* filename,
    int line,
    const wchar_t* text,
    ...
)

Writes a detailed log message. Detailed message contain file and line identifiers.

GetMessages

Copied!

static std::wstring GetMessages (int32_t flags = 0xffff)

Gets all the messages with the requested levels. It returns a single string with all the messages.

GetMessages

Copied!

static void GetMessages (
    std::vector<LogMessageEntry >& messages,
    int32_t flags = 0xffff
)

Gets all the messages with the requested levels. It returns a vector with all of the individual messages.

QueryMessageCounts

Copied!

static void QueryMessageCounts (std::array<uint32_t, LOGLEVEL_COUNT >& countAray)

Gets the number of messages for each message type.