# vkSetDebugUtilsObjectNameEXT(3) Manual Page

## Name

vkSetDebugUtilsObjectNameEXT - Give an application-defined name to an object

Loading… please wait.

## C Specification

An object can be given an application-defined name by calling:

    // Provided by VK_EXT_debug_utils
    VkResult vkSetDebugUtilsObjectNameEXT(
        VkDevice                                    device,
        const VkDebugUtilsObjectNameInfoEXT*        pNameInfo);

## Parameters

- `device` is the device that is associated with the named object passed in via `objectHandle`.

- `pNameInfo` is a pointer to a VkDebugUtilsObjectNameInfoEXT structure specifying parameters of the name to set on the object.

## Description

Valid Usage

- VUID-vkSetDebugUtilsObjectNameEXT-pNameInfo-02587
  `pNameInfo->objectType` must not be `VK_OBJECT_TYPE_UNKNOWN`

- VUID-vkSetDebugUtilsObjectNameEXT-pNameInfo-02588
  `pNameInfo->objectHandle` must not be VK_NULL_HANDLE

- VUID-vkSetDebugUtilsObjectNameEXT-pNameInfo-07872
  If `pNameInfo->objectHandle` is the valid handle of an instance-level object, the VkDevice identified by `device` must be a descendent of the same VkInstance as the object identified by `pNameInfo->objectHandle`

- VUID-vkSetDebugUtilsObjectNameEXT-pNameInfo-07873
  If `pNameInfo->objectHandle` is the valid handle of a physical-device-level object, the VkDevice identified by `device` must be a descendant of the same VkPhysicalDevice as the object identified by `pNameInfo->objectHandle`

- VUID-vkSetDebugUtilsObjectNameEXT-pNameInfo-07874
  If `pNameInfo->objectHandle` is the valid handle of a device-level object, that object must be a descendent of the VkDevice identified by `device`

Valid Usage (Implicit)

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

- VUID-vkSetDebugUtilsObjectNameEXT-pNameInfo-parameter
  `pNameInfo` must be a valid pointer to a valid VkDebugUtilsObjectNameInfoEXT structure

Host Synchronization

- Host access to `pNameInfo->objectHandle` 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_utils, VkDebugUtilsObjectNameInfoEXT, 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-2024 The Khronos Group Inc.

SPDX-License-Identifier: CC-BY-4.0