Graphics.Vulkan.Extensions.VK_EXT_debug_marker

Documentation

pattern VK_STRUCTURE_TYPE_DEBUG_MARKER_OBJECT_NAME_INFO_EXT :: VkStructureType

pattern VK_STRUCTURE_TYPE_DEBUG_MARKER_OBJECT_TAG_INFO_EXT :: VkStructureType

pattern VK_STRUCTURE_TYPE_DEBUG_MARKER_MARKER_INFO_EXT :: VkStructureType

pattern VK_EXT_DEBUG_MARKER_SPEC_VERSION :: Integral a => a

pattern VK_EXT_DEBUG_MARKER_EXTENSION_NAME :: (Eq a, IsString a) => a

vkDebugMarkerSetObjectNameEXT :: ("device" ::: VkDevice) -> ("pNameInfo" ::: Ptr VkDebugMarkerObjectNameInfoEXT) -> IO VkResult

vkDebugMarkerSetObjectNameEXT - Give a user-friendly name to an object

Parameters

• device is the device that created the object.

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

Description

Valid Usage (Implicit)

• device must be a valid VkDevice handle

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

Host Synchronization

• Host access to pNameInfo.object must be externally synchronized

Return Codes

Success

- VK_SUCCESS

Failure

- VK_ERROR_OUT_OF_HOST_MEMORY

• VK_ERROR_OUT_OF_DEVICE_MEMORY

See Also

VkDebugMarkerObjectNameInfoEXT, VkDevice

vkDebugMarkerSetObjectTagEXT :: ("device" ::: VkDevice) -> ("pTagInfo" ::: Ptr VkDebugMarkerObjectTagInfoEXT) -> IO VkResult

vkDebugMarkerSetObjectTagEXT - Attach arbitrary data to an object

Parameters

• device is the device that created the object.

• pTagInfo is a pointer to an instance of the VkDebugMarkerObjectTagInfoEXT structure specifying the parameters of the tag to attach to the object.

Description

Valid Usage (Implicit)

• device must be a valid VkDevice handle

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

Host Synchronization

• Host access to pTagInfo.object must be externally synchronized

Return Codes

Success

- VK_SUCCESS

Failure

- VK_ERROR_OUT_OF_HOST_MEMORY

• VK_ERROR_OUT_OF_DEVICE_MEMORY

See Also

VkDebugMarkerObjectTagInfoEXT, VkDevice

vkCmdDebugMarkerBeginEXT :: ("commandBuffer" ::: VkCommandBuffer) -> ("pMarkerInfo" ::: Ptr VkDebugMarkerMarkerInfoEXT) -> IO ()

vkCmdDebugMarkerBeginEXT - Open a command buffer marker region

Parameters

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

• pMarkerInfo is a pointer to an instance of the VkDebugMarkerMarkerInfoEXT structure specifying the parameters of the marker region to open.

Description

Valid Usage (Implicit)

• commandBuffer must be a valid VkCommandBuffer handle

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

Host Synchronization

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

Command Properties

+-----------------+-----------------+-----------------+-----------------+
| <#VkCommandBuff | <#vkCmdBeginRen | <#VkQueueFlagBi | <#synchronizati |
| erLevel Command | derPass Render  | ts Supported Qu | on-pipeline-sta |
|  Buffer Levels> | Pass Scope>     | eue Types>      | ges-types Pipel |
|                 |                 |                 | ine Type>       |
+=================+=================+=================+=================+
| Primary         | Both            | Graphics        |                 |
| Secondary       |                 | Compute         |                 |
+-----------------+-----------------+-----------------+-----------------+

See Also

VkCommandBuffer, VkDebugMarkerMarkerInfoEXT

vkCmdDebugMarkerEndEXT :: ("commandBuffer" ::: VkCommandBuffer) -> IO ()

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 vkCmdDebugMarkerBeginEXT and vkCmdDebugMarkerEndEXT must be matched and balanced.

Valid Usage

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

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

Valid Usage (Implicit)

• commandBuffer must be a valid VkCommandBuffer handle

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

Host Synchronization

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

Command Properties

+-----------------+-----------------+-----------------+-----------------+
| <#VkCommandBuff | <#vkCmdBeginRen | <#VkQueueFlagBi | <#synchronizati |
| erLevel Command | derPass Render  | ts Supported Qu | on-pipeline-sta |
|  Buffer Levels> | Pass Scope>     | eue Types>      | ges-types Pipel |
|                 |                 |                 | ine Type>       |
+=================+=================+=================+=================+
| Primary         | Both            | Graphics        |                 |
| Secondary       |                 | Compute         |                 |
+-----------------+-----------------+-----------------+-----------------+

See Also

VkCommandBuffer

vkCmdDebugMarkerInsertEXT :: ("commandBuffer" ::: VkCommandBuffer) -> ("pMarkerInfo" ::: Ptr VkDebugMarkerMarkerInfoEXT) -> IO ()

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 an instance of the VkDebugMarkerMarkerInfoEXT structure specifying the parameters of the marker to insert.

Description

Valid Usage (Implicit)

• commandBuffer must be a valid VkCommandBuffer handle

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

Host Synchronization

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

Command Properties

+-----------------+-----------------+-----------------+-----------------+
| <#VkCommandBuff | <#vkCmdBeginRen | <#VkQueueFlagBi | <#synchronizati |
| erLevel Command | derPass Render  | ts Supported Qu | on-pipeline-sta |
|  Buffer Levels> | Pass Scope>     | eue Types>      | ges-types Pipel |
|                 |                 |                 | ine Type>       |
+=================+=================+=================+=================+
| Primary         | Both            | Graphics        |                 |
| Secondary       |                 | Compute         |                 |
+-----------------+-----------------+-----------------+-----------------+

See Also

VkCommandBuffer, VkDebugMarkerMarkerInfoEXT

data VkDebugMarkerObjectNameInfoEXT

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

Description

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

Valid Usage

• objectType must not be VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT

• object must not be VK_NULL_HANDLE
• object must be a Vulkan object of the type associated with objectType as defined in {html_spec_relative}#debug-report-object-types.

Valid Usage (Implicit)

• sType must be VK_STRUCTURE_TYPE_DEBUG_MARKER_OBJECT_NAME_INFO_EXT

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

See Also

VkDebugReportObjectTypeEXT, VkStructureType, vkDebugMarkerSetObjectNameEXT

Constructors

VkDebugMarkerObjectNameInfoEXT

Fields

• vkSType :: VkStructureType

  sType is the type of this structure.

• vkPNext :: Ptr ()

  pNext is NULL or a pointer to an extension-specific structure.

• vkObjectType :: VkDebugReportObjectTypeEXT

  objectType is a VkDebugReportObjectTypeEXT specifying the type of the object to be named.

• vkObject :: Word64

  object is the object to be named.

• vkPObjectName :: Ptr CChar

  pObjectName is a null-terminated UTF-8 string specifying the name to apply to object.

Instances

Eq VkDebugMarkerObjectNameInfoEXT

Methods

(==) :: VkDebugMarkerObjectNameInfoEXT -> VkDebugMarkerObjectNameInfoEXT -> Bool

(/=) :: VkDebugMarkerObjectNameInfoEXT -> VkDebugMarkerObjectNameInfoEXT -> Bool

Show VkDebugMarkerObjectNameInfoEXT

Methods

showsPrec :: Int -> VkDebugMarkerObjectNameInfoEXT -> ShowS

show :: VkDebugMarkerObjectNameInfoEXT -> String

showList :: [VkDebugMarkerObjectNameInfoEXT] -> ShowS

Storable VkDebugMarkerObjectNameInfoEXT

Methods

sizeOf :: VkDebugMarkerObjectNameInfoEXT -> Int

alignment :: VkDebugMarkerObjectNameInfoEXT -> Int

peekElemOff :: Ptr VkDebugMarkerObjectNameInfoEXT -> Int -> IO VkDebugMarkerObjectNameInfoEXT

pokeElemOff :: Ptr VkDebugMarkerObjectNameInfoEXT -> Int -> VkDebugMarkerObjectNameInfoEXT -> IO ()

peekByteOff :: Ptr b -> Int -> IO VkDebugMarkerObjectNameInfoEXT

pokeByteOff :: Ptr b -> Int -> VkDebugMarkerObjectNameInfoEXT -> IO ()

peek :: Ptr VkDebugMarkerObjectNameInfoEXT -> IO VkDebugMarkerObjectNameInfoEXT

poke :: Ptr VkDebugMarkerObjectNameInfoEXT -> VkDebugMarkerObjectNameInfoEXT -> IO ()

data VkDebugMarkerObjectTagInfoEXT

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

• objectType must not be VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT

• object must not be VK_NULL_HANDLE
• object must be a Vulkan object of the type associated with objectType as defined in {html_spec_relative}#debug-report-object-types.

Valid Usage (Implicit)

• sType must be VK_STRUCTURE_TYPE_DEBUG_MARKER_OBJECT_TAG_INFO_EXT

• pNext must be NULL
• objectType must be a valid VkDebugReportObjectTypeEXT value
• pTag must be a valid pointer to an array of tagSize bytes
• tagSize must be greater than 0

See Also

VkDebugReportObjectTypeEXT, VkStructureType, vkDebugMarkerSetObjectTagEXT

Constructors

VkDebugMarkerObjectTagInfoEXT

Fields

• vkSType :: VkStructureType

  sType is the type of this structure.

• vkPNext :: Ptr ()

  pNext is NULL or a pointer to an extension-specific structure.

• vkObjectType :: VkDebugReportObjectTypeEXT

  objectType is a VkDebugReportObjectTypeEXT specifying the type of the object to be named.

• vkObject :: Word64

  object is the object to be tagged.

• vkTagName :: Word64

  tagName is a numerical identifier of the tag.

• vkTagSize :: CSize

  tagSize is the number of bytes of data to attach to the object.

• vkPTag :: Ptr ()

  pTag is an array of tagSize bytes containing the data to be associated with the object.

Instances

Eq VkDebugMarkerObjectTagInfoEXT

Methods

(==) :: VkDebugMarkerObjectTagInfoEXT -> VkDebugMarkerObjectTagInfoEXT -> Bool

(/=) :: VkDebugMarkerObjectTagInfoEXT -> VkDebugMarkerObjectTagInfoEXT -> Bool

Show VkDebugMarkerObjectTagInfoEXT

Methods

showsPrec :: Int -> VkDebugMarkerObjectTagInfoEXT -> ShowS

show :: VkDebugMarkerObjectTagInfoEXT -> String

showList :: [VkDebugMarkerObjectTagInfoEXT] -> ShowS

Storable VkDebugMarkerObjectTagInfoEXT

Methods

sizeOf :: VkDebugMarkerObjectTagInfoEXT -> Int

alignment :: VkDebugMarkerObjectTagInfoEXT -> Int

peekElemOff :: Ptr VkDebugMarkerObjectTagInfoEXT -> Int -> IO VkDebugMarkerObjectTagInfoEXT

pokeElemOff :: Ptr VkDebugMarkerObjectTagInfoEXT -> Int -> VkDebugMarkerObjectTagInfoEXT -> IO ()

peekByteOff :: Ptr b -> Int -> IO VkDebugMarkerObjectTagInfoEXT

pokeByteOff :: Ptr b -> Int -> VkDebugMarkerObjectTagInfoEXT -> IO ()

peek :: Ptr VkDebugMarkerObjectTagInfoEXT -> IO VkDebugMarkerObjectTagInfoEXT

poke :: Ptr VkDebugMarkerObjectTagInfoEXT -> VkDebugMarkerObjectTagInfoEXT -> IO ()

data VkDebugMarkerMarkerInfoEXT

VkDebugMarkerMarkerInfoEXT - Specify parameters of a command buffer marker region

Description

Valid Usage (Implicit)

• sType must be VK_STRUCTURE_TYPE_DEBUG_MARKER_MARKER_INFO_EXT

• pNext must be NULL
• pMarkerName must be a null-terminated UTF-8 string

See Also

VkStructureType, vkCmdDebugMarkerBeginEXT, vkCmdDebugMarkerInsertEXT

Constructors

VkDebugMarkerMarkerInfoEXT

Fields

• vkSType :: VkStructureType

  sType is the type of this structure.

• vkPNext :: Ptr ()

  pNext is NULL or a pointer to an extension-specific structure.

• vkPMarkerName :: Ptr CChar

  pMarkerName is a pointer to a null-terminated UTF-8 string that contains the name of the marker.

• vkColor :: Vector 4 CFloat

  color is an optional RGBA color value that can be associated with the marker. A particular implementation may choose to ignore this color value. The values contain RGBA values in order, in the range 0.0 to 1.0. If all elements in color are set to 0.0 then it is ignored.

Instances

Eq VkDebugMarkerMarkerInfoEXT

Methods

(==) :: VkDebugMarkerMarkerInfoEXT -> VkDebugMarkerMarkerInfoEXT -> Bool

(/=) :: VkDebugMarkerMarkerInfoEXT -> VkDebugMarkerMarkerInfoEXT -> Bool

Show VkDebugMarkerMarkerInfoEXT

Methods

showsPrec :: Int -> VkDebugMarkerMarkerInfoEXT -> ShowS

show :: VkDebugMarkerMarkerInfoEXT -> String

showList :: [VkDebugMarkerMarkerInfoEXT] -> ShowS

Storable VkDebugMarkerMarkerInfoEXT

Methods

sizeOf :: VkDebugMarkerMarkerInfoEXT -> Int

alignment :: VkDebugMarkerMarkerInfoEXT -> Int

peekElemOff :: Ptr VkDebugMarkerMarkerInfoEXT -> Int -> IO VkDebugMarkerMarkerInfoEXT

pokeElemOff :: Ptr VkDebugMarkerMarkerInfoEXT -> Int -> VkDebugMarkerMarkerInfoEXT -> IO ()

peekByteOff :: Ptr b -> Int -> IO VkDebugMarkerMarkerInfoEXT

pokeByteOff :: Ptr b -> Int -> VkDebugMarkerMarkerInfoEXT -> IO ()

peek :: Ptr VkDebugMarkerMarkerInfoEXT -> IO VkDebugMarkerMarkerInfoEXT

poke :: Ptr VkDebugMarkerMarkerInfoEXT -> VkDebugMarkerMarkerInfoEXT -> IO ()