vkSetDebugUtilsObjectNameEXT - Give a user-friendly name to an object

Parameters

• device is the device that created the object.

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

Valid Usage

• pNameInfo->objectType must not be OBJECT_TYPE_UNKNOWN

• pNameInfo->objectHandle must not be NULL_HANDLE

Valid Usage (Implicit)

• device must be a valid Device handle

• pNameInfo must be a valid pointer to a valid DebugUtilsObjectNameInfoEXT structure

Host Synchronization

• Host access to pNameInfo.objectHandle must be externally synchronized

Return Codes

Success

• SUCCESS

Failure

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY

See Also

DebugUtilsObjectNameInfoEXT, Device

vkSetDebugUtilsObjectTagEXT - Attach arbitrary data to an object

Parameters

• device is the device that created the object.

• pTagInfo is a pointer to a DebugUtilsObjectTagInfoEXT structure specifying parameters of the tag to attach to the object.

Valid Usage (Implicit)

• device must be a valid Device handle

• pTagInfo must be a valid pointer to a valid DebugUtilsObjectTagInfoEXT structure

Host Synchronization

• Host access to pTagInfo.objectHandle must be externally synchronized

Return Codes

Success

• SUCCESS

Failure

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY

See Also

DebugUtilsObjectTagInfoEXT, Device

vkQueueBeginDebugUtilsLabelEXT - Open a queue debug label region

Parameters

• queue is the queue in which to start a debug label region.

• pLabelInfo is a pointer to a DebugUtilsLabelEXT structure specifying parameters of the label region to open.

Command Properties

'

See Also

DebugUtilsLabelEXT, Queue

vkQueueEndDebugUtilsLabelEXT - Close a queue debug label region

Parameters

• queue is the queue in which a debug label region should be closed.

Description

The calls to queueBeginDebugUtilsLabelEXT and queueEndDebugUtilsLabelEXT must be matched and balanced.

Valid Usage

• There must be an outstanding queueBeginDebugUtilsLabelEXT command prior to the queueEndDebugUtilsLabelEXT on the queue

Valid Usage (Implicit)

• queue must be a valid Queue handle

Command Properties

'

See Also

Queue

vkQueueInsertDebugUtilsLabelEXT - Insert a label into a queue

Parameters

• queue is the queue into which a debug label will be inserted.

• pLabelInfo is a pointer to a DebugUtilsLabelEXT structure specifying parameters of the label to insert.

Command Properties

'

See Also

DebugUtilsLabelEXT, Queue

vkCmdBeginDebugUtilsLabelEXT - Open a command buffer debug label region

Parameters

• commandBuffer is the command buffer into which the command is recorded.

• pLabelInfo is a pointer to a DebugUtilsLabelEXT structure specifying parameters of the label region to open.

Valid Usage (Implicit)

• commandBuffer must be a valid CommandBuffer handle

• pLabelInfo must be a valid pointer to a valid DebugUtilsLabelEXT structure
• commandBuffer must be in the recording state
• The CommandPool that commandBuffer was allocated from must support graphics, or compute operations

Host Synchronization

• Host access to the CommandPool that commandBuffer was allocated from must be externally synchronized

Command Properties

'

See Also

CommandBuffer, DebugUtilsLabelEXT

A safe wrapper for cmdBeginDebugUtilsLabelEXT and cmdEndDebugUtilsLabelEXT using bracket_

vkCmdEndDebugUtilsLabelEXT - Close a command buffer label region

Parameters

• commandBuffer is the command buffer into which the command is recorded.

Description

An application may open a debug label region in one command buffer and close it in another, or otherwise split debug label regions across multiple command buffers or multiple queue submissions. When viewed from the linear series of submissions to a single queue, the calls to cmdBeginDebugUtilsLabelEXT and cmdEndDebugUtilsLabelEXT must be matched and balanced.

Valid Usage

• There must be an outstanding cmdBeginDebugUtilsLabelEXT command prior to the cmdEndDebugUtilsLabelEXT on the queue that commandBuffer is submitted to

• If commandBuffer is a secondary command buffer, there must be an outstanding cmdBeginDebugUtilsLabelEXT command recorded to commandBuffer that has not previously been ended by a call to cmdEndDebugUtilsLabelEXT.

Valid Usage (Implicit)

• commandBuffer must be a valid CommandBuffer handle

• commandBuffer must be in the recording state
• The CommandPool that commandBuffer was allocated from must support graphics, or compute operations

Host Synchronization

• Host access to the CommandPool that commandBuffer was allocated from must be externally synchronized

Command Properties

'

See Also

CommandBuffer

vkCmdInsertDebugUtilsLabelEXT - Insert a label into a command buffer

Parameters

• commandBuffer is the command buffer into which the command is recorded.

• pInfo is a pointer to a DebugUtilsLabelEXT structure specifying parameters of the label to insert.

Valid Usage (Implicit)

• commandBuffer must be a valid CommandBuffer handle

• pLabelInfo must be a valid pointer to a valid DebugUtilsLabelEXT structure
• commandBuffer must be in the recording state
• The CommandPool that commandBuffer was allocated from must support graphics, or compute operations

Host Synchronization

• Host access to the CommandPool that commandBuffer was allocated from must be externally synchronized

Command Properties

'

See Also

CommandBuffer, DebugUtilsLabelEXT

vkCreateDebugUtilsMessengerEXT - Create a debug messenger object

Parameters

• instance the instance the messenger will be used with.

• pCreateInfo is a pointer to a DebugUtilsMessengerCreateInfoEXT structure containing the callback pointer, as well as defining conditions under which this messenger will trigger the callback.
• pAllocator controls host memory allocation as described in the Memory Allocation chapter.
• pMessenger is a pointer to a DebugUtilsMessengerEXT handle in which the created object is returned.

Valid Usage (Implicit)

• instance must be a valid Instance handle

• pCreateInfo must be a valid pointer to a valid DebugUtilsMessengerCreateInfoEXT structure
• If pAllocator is not NULL, pAllocator must be a valid pointer to a valid AllocationCallbacks structure
• pMessenger must be a valid pointer to a DebugUtilsMessengerEXT handle

Return Codes

Success

• SUCCESS

Failure

• ERROR_OUT_OF_HOST_MEMORY

The application must ensure that createDebugUtilsMessengerEXT is not executed in parallel with any Vulkan command that is also called with instance or child of instance as the dispatchable argument.

See Also

AllocationCallbacks, DebugUtilsMessengerCreateInfoEXT, DebugUtilsMessengerEXT, Instance

A safe wrapper for createDebugUtilsMessengerEXT and destroyDebugUtilsMessengerEXT using bracket

The allocated value must not be returned from the provided computation

vkDestroyDebugUtilsMessengerEXT - Destroy a debug messenger object

Parameters

• instance the instance where the callback was created.

• messenger the DebugUtilsMessengerEXT object to destroy. messenger is an externally synchronized object and must not be used on more than one thread at a time. This means that destroyDebugUtilsMessengerEXT must not be called when a callback is active.
• pAllocator controls host memory allocation as described in the Memory Allocation chapter.

Valid Usage

• If AllocationCallbacks were provided when messenger was created, a compatible set of callbacks must be provided here

• If no AllocationCallbacks were provided when messenger was created, pAllocator must be NULL

Valid Usage (Implicit)

• instance must be a valid Instance handle

• messenger must be a valid DebugUtilsMessengerEXT handle
• If pAllocator is not NULL, pAllocator must be a valid pointer to a valid AllocationCallbacks structure
• messenger must have been created, allocated, or retrieved from instance

Host Synchronization

• Host access to messenger must be externally synchronized

The application must ensure that destroyDebugUtilsMessengerEXT is not executed in parallel with any Vulkan command that is also called with instance or child of instance as the dispatchable argument.

See Also

AllocationCallbacks, DebugUtilsMessengerEXT, Instance

vkSubmitDebugUtilsMessageEXT - Inject a message into a debug stream

Parameters

• instance is the debug stream’s Instance.

• messageSeverity is the DebugUtilsMessageSeverityFlagBitsEXT severity of this event/message.
• messageTypes is a bitmask of DebugUtilsMessageTypeFlagBitsEXT specifying which type of event(s) to identify with this message.
• pCallbackData contains all the callback related data in the DebugUtilsMessengerCallbackDataEXT structure.

Description

The call will propagate through the layers and generate callback(s) as indicated by the message’s flags. The parameters are passed on to the callback in addition to the pUserData value that was defined at the time the messenger was registered.

Valid Usage

• The objectType member of each element of pCallbackData->pObjects must not be OBJECT_TYPE_UNKNOWN

Valid Usage (Implicit)

• instance must be a valid Instance handle

• messageSeverity must be a valid DebugUtilsMessageSeverityFlagBitsEXT value
• messageTypes must be a valid combination of DebugUtilsMessageTypeFlagBitsEXT values
• messageTypes must not be 0
• pCallbackData must be a valid pointer to a valid DebugUtilsMessengerCallbackDataEXT structure

See Also

DebugUtilsMessageSeverityFlagBitsEXT, DebugUtilsMessageTypeFlagsEXT, DebugUtilsMessengerCallbackDataEXT, Instance

VkDebugUtilsObjectNameInfoEXT - Specify parameters of a name to give to an object

Description

Applications may change the name associated with an object simply by calling setDebugUtilsObjectNameEXT again with a new string. If pObjectName is an empty string, then any previously set name is removed.

Valid Usage

• If objectType is OBJECT_TYPE_UNKNOWN, objectHandle must not be NULL_HANDLE

• If objectType is not OBJECT_TYPE_UNKNOWN, objectHandle must be NULL_HANDLE or a valid Vulkan handle of the type associated with objectType as defined in the VkObjectType and Vulkan Handle Relationship table

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_DEBUG_UTILS_OBJECT_NAME_INFO_EXT

• pNext must be NULL
• objectType must be a valid ObjectType value
• pObjectName must be a null-terminated UTF-8 string

See Also

DebugUtilsMessengerCallbackDataEXT, ObjectType, StructureType, setDebugUtilsObjectNameEXT

VkDebugUtilsObjectTagInfoEXT - Specify parameters of a tag to attach to an object

Description

The tagName parameter gives a name or identifier to the type of data being tagged. This can be used by debugging layers to easily filter for only data that can be used by that implementation.

Valid Usage (Implicit)

See Also

ObjectType, StructureType, setDebugUtilsObjectTagEXT

VkDebugUtilsLabelEXT - Specify parameters of a label region

Valid Usage (Implicit)

See Also

DebugUtilsMessengerCallbackDataEXT, StructureType, cmdBeginDebugUtilsLabelEXT, cmdInsertDebugUtilsLabelEXT, queueBeginDebugUtilsLabelEXT, queueInsertDebugUtilsLabelEXT

VkDebugUtilsMessengerCreateInfoEXT - Structure specifying parameters of a newly created debug messenger

Description

For each DebugUtilsMessengerEXT that is created the DebugUtilsMessengerCreateInfoEXT::messageSeverity and DebugUtilsMessengerCreateInfoEXT::messageType determine when that DebugUtilsMessengerCreateInfoEXT::pfnUserCallback is called. The process to determine if the user’s pfnUserCallback is triggered when an event occurs is as follows:

1. The implementation will perform a bitwise AND of the event’s DebugUtilsMessageSeverityFlagBitsEXT with the messageSeverity provided during creation of the DebugUtilsMessengerEXT object.

   1. If the value is 0, the message is skipped.

2. The implementation will perform bitwise AND of the event’s DebugUtilsMessageTypeFlagBitsEXT with the messageType provided during the creation of the DebugUtilsMessengerEXT object.

   1. If the value is 0, the message is skipped.
3. The callback will trigger a debug message for the current event

The callback will come directly from the component that detected the event, unless some other layer intercepts the calls for its own purposes (filter them in a different way, log to a system error log, etc.).

An application can receive multiple callbacks if multiple DebugUtilsMessengerEXT objects are created. A callback will always be executed in the same thread as the originating Vulkan call.

A callback can be called from multiple threads simultaneously (if the application is making Vulkan calls from multiple threads).

Valid Usage (Implicit)

See Also

PFN_vkDebugUtilsMessengerCallbackEXT, DebugUtilsMessageSeverityFlagsEXT, DebugUtilsMessageTypeFlagsEXT, DebugUtilsMessengerCreateFlagsEXT, StructureType, createDebugUtilsMessengerEXT

VkDebugUtilsMessengerCallbackDataEXT - Structure specifying parameters returned to the callback

Description

Note

This structure should only be considered valid during the lifetime of the triggered callback.

Since adding queue and command buffer labels behaves like pushing and popping onto a stack, the order of both pQueueLabels and pCmdBufLabels is based on the order the labels were defined. The result is that the first label in either pQueueLabels or pCmdBufLabels will be the first defined (and therefore the oldest) while the last label in each list will be the most recent.

Note

pQueueLabels will only be non-NULL if one of the objects in pObjects can be related directly to a defined Queue which has had one or more labels associated with it.

Likewise, pCmdBufLabels will only be non-NULL if one of the objects in pObjects can be related directly to a defined CommandBuffer which has had one or more labels associated with it. Additionally, while command buffer labels allow for beginning and ending across different command buffers, the debug messaging framework cannot guarantee that labels in pCmdBufLables will contain those defined outside of the associated command buffer. This is partially due to the fact that the association of one command buffer with another may not have been defined at the time the debug message is triggered.

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_DEBUG_UTILS_MESSENGER_CALLBACK_DATA_EXT

• pNext must be NULL
• flags must be 0
• If pMessageIdName is not NULL, pMessageIdName must be a null-terminated UTF-8 string
• pMessage must be a null-terminated UTF-8 string
• If queueLabelCount is not 0, pQueueLabels must be a valid pointer to an array of queueLabelCount valid DebugUtilsLabelEXT structures
• If cmdBufLabelCount is not 0, pCmdBufLabels must be a valid pointer to an array of cmdBufLabelCount valid DebugUtilsLabelEXT structures
• If objectCount is not 0, pObjects must be a valid pointer to an array of objectCount valid DebugUtilsObjectNameInfoEXT structures

See Also

DebugUtilsLabelEXT, DebugUtilsMessengerCallbackDataFlagsEXT, DebugUtilsObjectNameInfoEXT, StructureType, submitDebugUtilsMessageEXT

VkDebugUtilsMessageSeverityFlagBitsEXT - Bitmask specifying which severities of events cause a debug messenger callback

See Also

DebugUtilsMessageSeverityFlagsEXT, submitDebugUtilsMessageEXT

VkDebugUtilsMessageTypeFlagBitsEXT - Bitmask specifying which types of events cause a debug messenger callback

See Also

DebugUtilsMessageTypeFlagsEXT

PFN_vkDebugUtilsMessengerCallbackEXT - Application-defined debug messenger callback function

Parameters

• messageSeverity specifies the DebugUtilsMessageSeverityFlagBitsEXT that triggered this callback.

• messageTypes is a bitmask of DebugUtilsMessageTypeFlagBitsEXT specifying which type of event(s) triggered this callback.
• pCallbackData contains all the callback related data in the DebugUtilsMessengerCallbackDataEXT structure.
• pUserData is the user data provided when the DebugUtilsMessengerEXT was created.

Description

The callback must not call destroyDebugUtilsMessengerEXT.

The callback returns a Bool32, which is interpreted in a layer-specified manner. The application should always return FALSE. The TRUE value is reserved for use in layer development.

See Also

DebugUtilsMessengerCreateInfoEXT

VkDebugUtilsMessengerEXT - Opaque handle to a debug messenger object

Description

The debug messenger will provide detailed feedback on the application’s use of Vulkan when events of interest occur. When an event of interest does occur, the debug messenger will submit a debug message to the debug callback that was provided during its creation. Additionally, the debug messenger is responsible with filtering out debug messages that the callback is not interested in and will only provide desired debug messages.

See Also

createDebugUtilsMessengerEXT, destroyDebugUtilsMessengerEXT