XrDebugUtilsObjectNameInfoEXT(3)

C Specification

// Provided by XR_EXT_debug_utils
typedef struct XrDebugUtilsObjectNameInfoEXT {
    XrStructureType    type;
    const void*        next;
    XrObjectType       objectType;
    uint64_t           objectHandle;
    const char*        objectName;
} XrDebugUtilsObjectNameInfoEXT;

Members

Member Descriptions

type is the XrStructureType of this structure.
next is NULL or a pointer to the next structure in a structure chain. No such structures are defined in core OpenXR or this extension.
objectType is an XrObjectType specifying the type of the object to be named.
objectHandle is the object to be named.
objectName is a NULL terminated UTF-8 string specifying the name to apply to objectHandle.

Description

Valid Usage

If objectType is XR_OBJECT_TYPE_UNKNOWN, objectHandle must not be XR_NULL_HANDLE
If objectType is not XR_OBJECT_TYPE_UNKNOWN, objectHandle must be XR_NULL_HANDLE or an OpenXR handle of the type associated with objectType

Valid Usage (Implicit)

The XR_EXT_debug_utils extension must be enabled prior to using XrDebugUtilsObjectNameInfoEXT
type must be XR_TYPE_DEBUG_UTILS_OBJECT_NAME_INFO_EXT
next must be NULL or a valid pointer to the next structure in a structure chain
objectType must be a valid XrObjectType value
If objectName is not NULL, objectName must be a null-terminated UTF-8 string

See Also

XR_EXT_debug_utils, XrDebugUtilsMessengerCallbackDataEXT, XrObjectType, XrStructureType, xrSetDebugUtilsObjectNameEXT

Document Notes

For more information, see the OpenXR Specification

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

Copyright

Copyright 2014-2024, The Khronos Group Inc.

This work is licensed under a Creative Commons Attribution 4.0 International License.