tephra.hpp file

The main file that includes the core library.

Defines

#define TEPHRA_ENABLE_DEBUG: Enables all Tephra-specific debug functionality. Equivalent to defining all of TEPHRA_ENABLE_DEBUG_TEPHRA_VALIDATION, TEPHRA_ENABLE_DEBUG_ASSERTS, TEPHRA_ENABLE_DEBUG_CONTEXTS, TEPHRA_ENABLE_DEBUG_NAMES and TEPHRA_ENABLE_DEBUG_STATISTIC_EVENTS.
#define TEPHRA_ENABLE_DEBUG_ASSERTS: Enables internal debug asserts.
#define TEPHRA_ENABLE_DEBUG_CONTEXTS: Enables the management and reporting of contexts in debug messages. These include information about the Tephra interface function call during which the message was generated.
#define TEPHRA_ENABLE_DEBUG_NAMES: Enables storage of debug names of Tephra objects and using them for internal Vulkan handles when tp::ApplicationExtension::EXT_DebugUtils is enabled.
#define TEPHRA_ENABLE_DEBUG_STATISTIC_EVENTS: Enables the reporting of certain statistics gathered during various stages of execution to a tp::DebugReportHandler.
#define TEPHRA_ENABLE_DEBUG_TEPHRA_VALIDATION: Enables validating correct usage of the library.

Define documentation

#define TEPHRA_ENABLE_DEBUG

Enables all Tephra-specific debug functionality. Equivalent to defining all of TEPHRA_ENABLE_DEBUG_TEPHRA_VALIDATION, TEPHRA_ENABLE_DEBUG_ASSERTS, TEPHRA_ENABLE_DEBUG_CONTEXTS, TEPHRA_ENABLE_DEBUG_NAMES and TEPHRA_ENABLE_DEBUG_STATISTIC_EVENTS.

#define TEPHRA_ENABLE_DEBUG_ASSERTS

Enables internal debug asserts.

#define TEPHRA_ENABLE_DEBUG_CONTEXTS

Enables the management and reporting of contexts in debug messages. These include information about the Tephra interface function call during which the message was generated.

#define TEPHRA_ENABLE_DEBUG_NAMES

Enables storage of debug names of Tephra objects and using them for internal Vulkan handles when tp::ApplicationExtension::EXT_DebugUtils is enabled.

#define TEPHRA_ENABLE_DEBUG_TEPHRA_VALIDATION

Enables validating correct usage of the library.