vkDebugMarkerSetObjectNameEXT - Give a user-friendly name to an object

Parameters

• device is the device that created the object.

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

Valid Usage (Implicit)

• device must be a valid Device handle

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

Host Synchronization

• Host access to pNameInfo.object must be externally synchronized

Return Codes

Success

• SUCCESS

Failure

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY

See Also

DebugMarkerObjectNameInfoEXT, Device

vkDebugMarkerSetObjectTagEXT - Attach arbitrary data to an object

Parameters

• device is the device that created the object.

• pTagInfo is a pointer to a DebugMarkerObjectTagInfoEXT structure specifying the 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 DebugMarkerObjectTagInfoEXT structure

Host Synchronization

• Host access to pTagInfo.object must be externally synchronized

Return Codes

Success

• SUCCESS

Failure

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY

See Also

DebugMarkerObjectTagInfoEXT, Device

vkCmdDebugMarkerBeginEXT - Open a command buffer marker region

Parameters

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

• pMarkerInfo is a pointer to a DebugMarkerMarkerInfoEXT structure specifying the parameters of the marker region to open.

Valid Usage (Implicit)

• commandBuffer must be a valid CommandBuffer handle

• pMarkerInfo must be a valid pointer to a valid DebugMarkerMarkerInfoEXT 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, DebugMarkerMarkerInfoEXT

vkCmdDebugMarkerEndEXT - Close a command buffer marker region

Parameters

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

Description

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

Valid Usage

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

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

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

vkCmdDebugMarkerInsertEXT - Insert a marker label into a command buffer

Parameters

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

• pMarkerInfo is a pointer to a DebugMarkerMarkerInfoEXT structure specifying the parameters of the marker to insert.

Valid Usage (Implicit)

• commandBuffer must be a valid CommandBuffer handle

• pMarkerInfo must be a valid pointer to a valid DebugMarkerMarkerInfoEXT 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, DebugMarkerMarkerInfoEXT

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

Description

Applications may change the name associated with an object simply by calling debugMarkerSetObjectNameEXT again with a new string. To remove a previously set name, pObjectName should be set to an empty string.

Valid Usage (Implicit)

See Also

DebugReportObjectTypeEXT, StructureType, debugMarkerSetObjectNameEXT

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

DebugReportObjectTypeEXT, StructureType, debugMarkerSetObjectTagEXT

VkDebugMarkerMarkerInfoEXT - Specify parameters of a command buffer marker region

Valid Usage (Implicit)

See Also

StructureType, cmdDebugMarkerBeginEXT, cmdDebugMarkerInsertEXT

VkDebugReportObjectTypeEXT - Specify the type of an object handle

Description

'

VkDebugReportObjectTypeEXT and Vulkan Handle Relationship

Note

The primary expected use of ERROR_VALIDATION_FAILED_EXT is for validation layer testing. It is not expected that an application would see this error code during normal use of the validation layers.

See Also

DebugMarkerObjectNameInfoEXT, DebugMarkerObjectTagInfoEXT, debugReportMessageEXT