vkSetDebugUtilsObjectNameEXT(3)

# vkSetDebugUtilsObjectNameEXT(3) Manual Page

## Name

vkSetDebugUtilsObjectNameEXT - Give a user-friendly name to an object

## C Specification

    VkResult vkSetDebugUtilsObjectNameEXT(
        VkDevice                                    device,
        const VkDebugUtilsObjectNameInfoEXT*        pNameInfo);

## Parameters

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

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

## Description

Valid Usage

- `pNameInfo->objectType` must not be `VK_OBJECT_TYPE_UNKNOWN`

- `pNameInfo->objectHandle` must not be VK_NULL_HANDLE

Valid Usage (Implicit)

- `device` must be a valid VkDevice handle

- `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

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 (c) 2014-2020 Khronos Group. This work is licensed under a Creative Commons Attribution 4.0 International License.