VkDebugMarkerObjectTagInfoEXT(3)

Name

VkDebugMarkerObjectTagInfoEXT - Specify parameters of a tag to attach to an object

C Specification

The VkDebugMarkerObjectTagInfoEXT structure is defined as:

// Provided by VK_EXT_debug_marker
typedef struct VkDebugMarkerObjectTagInfoEXT {
    VkStructureType               sType;
    const void*                   pNext;
    VkDebugReportObjectTypeEXT    objectType;
    uint64_t                      object;
    uint64_t                      tagName;
    size_t                        tagSize;
    const void*                   pTag;
} VkDebugMarkerObjectTagInfoEXT;

Members

  • sType is a VkStructureType value identifying this structure.

  • pNext is NULL or a pointer to a structure extending this structure.

  • objectType is a VkDebugReportObjectTypeEXT specifying the type of the object to be named.

  • object is the object to be tagged.

  • tagName is a numerical identifier of the tag.

  • tagSize is the number of bytes of data to attach to the object.

  • pTag is a pointer to an array of tagSize bytes containing the data to be associated with the object.

Description

The tagName parameter gives a name or identifier to the type of data being tagged. This can be used by debugging layers to easily filter for only data that can be used by that implementation.

Valid Usage

  • VUID-VkDebugMarkerObjectTagInfoEXT-objectType-01493
    objectType must not be VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT

  • VUID-VkDebugMarkerObjectTagInfoEXT-object-01494
    object must not be VK_NULL_HANDLE

  • VUID-VkDebugMarkerObjectTagInfoEXT-object-01495
    object must be a Vulkan object of the type associated with objectType as defined in VkDebugReportObjectTypeEXT and Vulkan Handle Relationship

Valid Usage (Implicit)

  • VUID-VkDebugMarkerObjectTagInfoEXT-sType-sType
    sType must be VK_STRUCTURE_TYPE_DEBUG_MARKER_OBJECT_TAG_INFO_EXT

  • VUID-VkDebugMarkerObjectTagInfoEXT-pNext-pNext
    pNext must be NULL

  • VUID-VkDebugMarkerObjectTagInfoEXT-objectType-parameter
    objectType must be a valid VkDebugReportObjectTypeEXT value

  • VUID-VkDebugMarkerObjectTagInfoEXT-pTag-parameter
    pTag must be a valid pointer to an array of tagSize bytes

  • VUID-VkDebugMarkerObjectTagInfoEXT-tagSize-arraylength
    tagSize must be greater than 0

Host Synchronization

  • Host access to object must be externally synchronized

See Also

VK_EXT_debug_marker, VkDebugReportObjectTypeEXT, VkStructureType, vkDebugMarkerSetObjectTagEXT

Document Notes

For more information, see the Vulkan Specification.

This page is extracted from the Vulkan Specification. Fixes and changes should be made to the Specification, not directly.