Function Prototype

vkCmdBeginDebugUtilsLabelEXT

Open a command buffer debug label region
primary / secondary
both
graphics / compute
action / state

A command buffer debug label region can be opened by calling:

void vkCmdBeginDebugUtilsLabelEXT(
    VkCommandBuffer commandBuffer,
    const VkDebugUtilsLabelEXT* pLabelInfo);
  • commandBuffer is the command buffer into which the command is recorded.
  • pLabelInfo is a pointer to a VkDebugUtilsLabelEXT structure specifying parameters of the label region to open.

Valid Usage (Implicit)

VUID-vkCmdBeginDebugUtilsLabelEXT-pLabelInfo-parameter

pLabelInfo must be a valid pointer to a valid VkDebugUtilsLabelEXT structure

VUID-vkCmdBeginDebugUtilsLabelEXT-commandBuffer-cmdpool

The VkCommandPool that commandBuffer was allocated from must support graphics, or compute operations

VUID-vkCmdBeginDebugUtilsLabelEXT-videocoding

This command must only be called outside of a video coding scope

Host Synchronization

  • Host access to commandBuffer must be externally synchronized
  • Host access to the VkCommandPool that commandBuffer was allocated from must be externally synchronized ::