Skip to content

LiteFX::Rendering::Backends::VulkanDevice::setDebugName

Sets the debug name for an object.

Synopsis

Declared in <litefx/backends/vulkan.hpp>

template<typename THandle>
void setDebugName(
    THandle objectHandle,
    VkDebugReportObjectTypeEXT objectType,
    StringView name) const;

Description

This function sets the debug name for an object to make it easier to identify when using an external debugger. This function will do nothing in release mode or if the device extension VK_EXT_debug_marker is not available.

Template Parameters

NameDescription
THandleThe type of the handle. Must be a Vulkan handle type.

Parameters

NameDescription
objectHandleThe handle of the object casted to an integer.
objectTypeThe type of the object.
nameThe debug name of the object.