vkCmdBeginDebugUtilsLabelEXT(3)

Name

vkCmdBeginDebugUtilsLabelEXT - Open a command buffer debug label region

C Specification

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

// Provided by VK_EXT_debug_utils
void vkCmdBeginDebugUtilsLabelEXT(
    VkCommandBuffer                             commandBuffer,
    const VkDebugUtilsLabelEXT*                 pLabelInfo);

Parameters

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.

Description

Valid Usage (Implicit)

VUID-vkCmdBeginDebugUtilsLabelEXT-commandBuffer-parameter
commandBuffer must be a valid VkCommandBuffer handle
VUID-vkCmdBeginDebugUtilsLabelEXT-pLabelInfo-parameter
pLabelInfo must be a valid pointer to a valid VkDebugUtilsLabelEXT structure
VUID-vkCmdBeginDebugUtilsLabelEXT-commandBuffer-recording
commandBuffer must be in the recording state
VUID-vkCmdBeginDebugUtilsLabelEXT-commandBuffer-cmdpool
The VkCommandPool that commandBuffer was allocated from must support transfer, graphics, compute, decode, encode, or optical flow operations

Host Synchronization

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