DebugLabel Class Reference

RAII wrapper for a Vulkan debug label region. More...

#include <VulkanHelper.h>

Public Member Functions
	DebugLabel (VkCommandBuffer, const char *, const float *=nullptr)
	Release-build no-op constructor.
	~DebugLabel ()
	Release-build no-op destructor.
	DebugLabel (const DebugLabel &)=delete
	Debug label scopes cannot be copied.
DebugLabel &	operator= (const DebugLabel &)=delete
	Debug label scopes cannot be copy-assigned.
	DebugLabel (DebugLabel &&)=delete
	Debug label scopes cannot be moved.
DebugLabel &	operator= (DebugLabel &&)=delete
	Debug label scopes cannot be move-assigned.

Detailed Description

RAII wrapper for a Vulkan debug label region.

The constructor starts a label region on a command buffer. The destructor ends the label region. Release builds compile the wrapper to empty constructor and destructor bodies.

void recordCommands(VkCommandBuffer cmd)
{
    DebugLabel scope(cmd, "My Render Pass");
    // Record rendering commands here.
}

Definition at line 723 of file VulkanHelper.h.

Constructor & Destructor Documentation

DebugLabel() [1/3]

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

inline

Release-build no-op constructor.

Definition at line 750 of file VulkanHelper.h.

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

Here is the caller graph for this function:

~DebugLabel()

DebugLabel::~DebugLabel ( )

inline

Release-build no-op destructor.

Definition at line 755 of file VulkanHelper.h.

DebugLabel() [2/3]

DebugLabel::DebugLabel ( const DebugLabel & )

delete

Debug label scopes cannot be copied.

References DebugLabel().

Here is the call graph for this function:

DebugLabel() [3/3]

DebugLabel::DebugLabel ( DebugLabel && )

delete

Debug label scopes cannot be moved.

References DebugLabel().

Here is the call graph for this function:

Member Function Documentation

operator=() [1/2]

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

delete

Debug label scopes cannot be copy-assigned.

References DebugLabel().

Here is the call graph for this function:

operator=() [2/2]

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

delete

Debug label scopes cannot be move-assigned.

References DebugLabel().

Here is the call graph for this function:

---

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

• /workspace/magerbeton/gl3-vulkan/code/Engine/include/Engine/Core/VulkanHelper.h