C Specification

An object can be given a user-friendly name by calling:

// Provided by VK_EXT_debug_marker
VkResult vkDebugMarkerSetObjectNameEXT(
    VkDevice                                    device,
    const VkDebugMarkerObjectNameInfoEXT*       pNameInfo);

Parameters

  • device is the device that created the object.

  • pNameInfo is a pointer to a VkDebugMarkerObjectNameInfoEXT structure specifying the parameters of the name to set on the object.

Description

Valid Usage (Implicit)

  • VUID-vkDebugMarkerSetObjectNameEXT-device-parameter
    device must be a valid VkDevice handle

  • VUID-vkDebugMarkerSetObjectNameEXT-pNameInfo-parameter
    pNameInfo must be a valid pointer to a valid VkDebugMarkerObjectNameInfoEXT structure

Host Synchronization

  • Host access to pNameInfo->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, VkDebugMarkerObjectNameInfoEXT, 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