DebugLabel Class Reference

An RAII-style wrapper for Vulkan debug labels. More...

#include <VulkanHelper.h>

Public Member Functions
	DebugLabel (VkCommandBuffer, const char *, const float *=nullptr)
	~DebugLabel ()
	DebugLabel (const DebugLabel &)=delete
DebugLabel &	operator= (const DebugLabel &)=delete
	DebugLabel (DebugLabel &&)=delete
DebugLabel &	operator= (DebugLabel &&)=delete

Detailed Description

An RAII-style wrapper for Vulkan debug labels.

Creates a debug label on construction and automatically ends it when the object goes out of scope. This ensures that labels are always properly closed, even if exceptions occur. In release builds (when IS_IN_DEBUG is not defined), this class is empty and has no overhead.

Usage: void recordCommands(VkCommandBuffer cmd) { DebugLabel scope(cmd, "My Render Pass"); ... your rendering commands ... } // Label is automatically closed here

Definition at line 432 of file VulkanHelper.h.

Constructor & Destructor Documentation

DebugLabel() [1/3]

DebugLabel::DebugLabel ( VkCommandBuffer , const char * , const float * = nullptr )

inline

Definition at line 448 of file VulkanHelper.h.

Referenced by DebugLabel(), DebugLabel(), operator=(), and operator=().

Here is the caller graph for this function:

~DebugLabel()

DebugLabel::~DebugLabel ( )

inline

Definition at line 450 of file VulkanHelper.h.

DebugLabel() [2/3]

DebugLabel::DebugLabel ( const DebugLabel & )

delete

References DebugLabel().

Here is the call graph for this function:

DebugLabel() [3/3]

DebugLabel::DebugLabel ( DebugLabel && )

delete

References DebugLabel().

Here is the call graph for this function:

Member Function Documentation

operator=() [1/2]

DebugLabel & DebugLabel::operator= ( const DebugLabel & )

delete

References DebugLabel().

Here is the call graph for this function:

operator=() [2/2]

DebugLabel & DebugLabel::operator= ( DebugLabel && )

delete

References DebugLabel().

Here is the call graph for this function:

---

The documentation for this class was generated from the following file:

• /home/magerbeton/Documents/gl3-vulkan/Engine/include/Engine/Core/VulkanHelper.h