vkDebugMarkerSetObjectTagEXT(3)

# vkDebugMarkerSetObjectTagEXT(3) Manual Page

## Name

vkDebugMarkerSetObjectTagEXT - Attach arbitrary data to an object

Loading… please wait.

## C Specification

In addition to setting a name for an object, debugging and validation layers may have uses for additional binary data on a per-object basis that has no other place in the Vulkan API. For example, a `VkShaderModule` could have additional debugging data attached to it to aid in offline shader tracing. To attach data to an object, call:

    // Provided by VK_EXT_debug_marker
    VkResult vkDebugMarkerSetObjectTagEXT(
        VkDevice                                    device,
        const VkDebugMarkerObjectTagInfoEXT*        pTagInfo);

## Parameters

- `device` is the device that created the object.

- `pTagInfo` is a pointer to a VkDebugMarkerObjectTagInfoEXT structure specifying the parameters of the tag to attach to the object.

## Description

Valid Usage (Implicit)

- VUID-vkDebugMarkerSetObjectTagEXT-device-parameter
  `device` must be a valid VkDevice handle

- VUID-vkDebugMarkerSetObjectTagEXT-pTagInfo-parameter
  `pTagInfo` must be a valid pointer to a valid VkDebugMarkerObjectTagInfoEXT structure

Host Synchronization

- Host access to `pTagInfo->object` must be externally synchronized

Return Codes

On success, this command returns

  - `VK_SUCCESS`

On failure, this command returns

  - `VK_ERROR_OUT_OF_HOST_MEMORY`

  - `VK_ERROR_OUT_OF_DEVICE_MEMORY`

## See Also

VK_EXT_debug_marker, VkDebugMarkerObjectTagInfoEXT, VkDevice

## 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.

## Copyright

Copyright 2014-2022 The Khronos Group Inc.

SPDX-License-Identifier: CC-BY-4.0