vulkan-3.26.1: Bindings to the Vulkan graphics API.
Safe HaskellSafe-Inferred
LanguageHaskell2010

Vulkan.Extensions.VK_AMD_buffer_marker

Description

Name

VK_AMD_buffer_marker - device extension

VK_AMD_buffer_marker

Name String
VK_AMD_buffer_marker
Extension Type
Device extension
Registered Extension Number
180
Revision
1
Ratification Status
Not ratified
Extension and Version Dependencies; Special Use
Contact

Other Extension Metadata

Last Modified Date
2018-01-26
IP Status
No known IP claims.
Contributors
  • Matthaeus G. Chajdas, AMD
  • Jaakko Konttinen, AMD
  • Daniel Rakos, AMD

Description

This extension adds a new operation to execute pipelined writes of small marker values into a Buffer object.

The primary purpose of these markers is to facilitate the development of debugging tools for tracking which pipelined command contributed to device loss.

New Commands

New Enum Constants

Examples

None.

Version History

  • Revision 1, 2018-01-26 (Jaakko Konttinen)

    • Initial revision

See Also

cmdWriteBufferMarkerAMD

Document Notes

For more information, see the Vulkan Specification

This page is a generated document. Fixes and changes should be made to the generator scripts, not directly.

Synopsis

Documentation

cmdWriteBufferMarkerAMD Source #

Arguments

:: forall io. MonadIO io 
=> CommandBuffer

commandBuffer is the command buffer into which the command will be recorded.

-> PipelineStageFlagBits

pipelineStage is a PipelineStageFlagBits value specifying the pipeline stage whose completion triggers the marker write.

-> ("dstBuffer" ::: Buffer)

dstBuffer is the buffer where the marker will be written to.

-> ("dstOffset" ::: DeviceSize)

dstOffset is the byte offset into the buffer where the marker will be written to.

-> ("marker" ::: Word32)

marker is the 32-bit value of the marker.

-> io () 

vkCmdWriteBufferMarkerAMD - Execute a pipelined write of a marker value into a buffer

Description

The command will write the 32-bit marker value into the buffer only after all preceding commands have finished executing up to at least the specified pipeline stage. This includes the completion of other preceding cmdWriteBufferMarkerAMD commands so long as their specified pipeline stages occur either at the same time or earlier than this command’s specified pipelineStage.

While consecutive buffer marker writes with the same pipelineStage parameter are implicitly complete in submission order, memory and execution dependencies between buffer marker writes and other operations must still be explicitly ordered using synchronization commands. The access scope for buffer marker writes falls under the ACCESS_TRANSFER_WRITE_BIT, and the pipeline stages for identifying the synchronization scope must include both pipelineStage and PIPELINE_STAGE_TRANSFER_BIT.

Note

Similar to cmdWriteTimestamp, if an implementation is unable to write a marker at any specific pipeline stage, it may instead do so at any logically later stage.

Note

Implementations may only support a limited number of pipelined marker write operations in flight at a given time, thus excessive number of marker write operations may degrade command execution performance.

Valid Usage

  • pipelineStage must be a valid stage for the queue family that was used to create the command pool that commandBuffer was allocated from

Valid Usage (Implicit)

  • If pipelineStage is not 0, pipelineStage must be a valid PipelineStageFlagBits value
  • dstBuffer must be a valid Buffer handle
  • commandBuffer must be in the recording state
  • The CommandPool that commandBuffer was allocated from must support transfer, graphics, or compute operations
  • This command must only be called outside of a video coding scope
  • Both of commandBuffer, and dstBuffer must have been created, allocated, or retrieved from the same Device

Host Synchronization

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

Command Properties

'

Command Buffer LevelsRender Pass ScopeVideo Coding ScopeSupported Queue TypesCommand Type
Primary Secondary Both Outside Transfer Graphics ComputeAction

See Also

VK_AMD_buffer_marker, Buffer, CommandBuffer, DeviceSize, PipelineStageFlagBits

pattern AMD_BUFFER_MARKER_SPEC_VERSION :: forall a. Integral a => a Source #

type AMD_BUFFER_MARKER_EXTENSION_NAME = "VK_AMD_buffer_marker" Source #

pattern AMD_BUFFER_MARKER_EXTENSION_NAME :: forall a. (Eq a, IsString a) => a Source #