vkCmdInsertDebugUtilsLabelEXT(3)

C Specification

A single debug label can be inserted into a command buffer by calling:

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

Parameters

commandBuffer is the command buffer into which the command is recorded.
pInfo is a pointer to a VkDebugUtilsLabelEXT structure specifying parameters of the label to insert.

Description

Valid Usage (Implicit)

VUID-vkCmdInsertDebugUtilsLabelEXT-commandBuffer-parameter
commandBuffer must be a valid VkCommandBuffer handle
VUID-vkCmdInsertDebugUtilsLabelEXT-pLabelInfo-parameter
pLabelInfo must be a valid pointer to a valid VkDebugUtilsLabelEXT structure
VUID-vkCmdInsertDebugUtilsLabelEXT-commandBuffer-recording
commandBuffer must be in the recording state
VUID-vkCmdInsertDebugUtilsLabelEXT-commandBuffer-cmdpool
The VkCommandPool that commandBuffer was allocated from must support graphics, or compute operations
VUID-vkCmdInsertDebugUtilsLabelEXT-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