Safe Haskell | None |
---|---|
Language | Haskell2010 |
Synopsis
- cmdWriteBufferMarkerAMD :: forall io. MonadIO io => CommandBuffer -> PipelineStageFlagBits -> ("dstBuffer" ::: Buffer) -> ("dstOffset" ::: DeviceSize) -> ("marker" ::: Word32) -> io ()
- type AMD_BUFFER_MARKER_SPEC_VERSION = 1
- pattern AMD_BUFFER_MARKER_SPEC_VERSION :: forall a. Integral a => a
- type AMD_BUFFER_MARKER_EXTENSION_NAME = "VK_AMD_buffer_marker"
- pattern AMD_BUFFER_MARKER_EXTENSION_NAME :: forall a. (Eq a, IsString a) => a
Documentation
cmdWriteBufferMarkerAMD :: forall io. MonadIO io => CommandBuffer -> PipelineStageFlagBits -> ("dstBuffer" ::: Buffer) -> ("dstOffset" ::: DeviceSize) -> ("marker" ::: Word32) -> io () Source #
vkCmdWriteBufferMarkerAMD - Execute a pipelined write of a marker value into a buffer
Parameters
commandBuffer
is the command buffer into which the command will be recorded.
pipelineStage
is one of thePipelineStageFlagBits
values, specifying the pipeline stage whose completion triggers the marker write.dstBuffer
is the buffer where the marker will be written to.dstOffset
is the byte offset into the buffer where the marker will be written to.marker
is the 32-bit value of the marker.
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
dstOffset
must be less than or equal to the size ofdstBuffer
minus4
dstBuffer
must have been created withBUFFER_USAGE_TRANSFER_DST_BIT
usage flag- If
dstBuffer
is non-sparse then it must be bound completely and contiguously to a singleDeviceMemory
object dstOffset
must be a multiple of4
Valid Usage (Implicit)
commandBuffer
must be a validCommandBuffer
handle
pipelineStage
must be a validPipelineStageFlagBits
valuedstBuffer
must be a validBuffer
handlecommandBuffer
must be in the recording state- The
CommandPool
thatcommandBuffer
was allocated from must support transfer, graphics, or compute operations - Both of
commandBuffer
, anddstBuffer
must have been created, allocated, or retrieved from the sameDevice
Host Synchronization
- Host access to
commandBuffer
must be externally synchronized
- Host access to the
CommandPool
thatcommandBuffer
was allocated from must be externally synchronized
Command Properties
'
Command Buffer Levels | Render Pass Scope | Supported Queue Types | Pipeline Type |
---|---|---|---|
Primary Secondary | Both | Transfer Graphics Compute | Transfer |
See Also
type AMD_BUFFER_MARKER_SPEC_VERSION = 1 Source #
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 #