Top Description Fields Constructors Methods
org.lwjgl.vulkan

public Class AMDBufferMarker

extends Object
Class Inheritance
Imports
org.lwjgl.system.*
This extension adds a new operation to execute pipelined writes of small marker values into a VkBuffer object.

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

Examples

None.

VK_AMD_buffer_marker
Name String
VK_AMD_buffer_marker
Extension Type
Device extension
Registered Extension Number
180
Revision
1
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

Field Summary

Modifier and TypeField and Description
public static final String
VK_AMD_BUFFER_MARKER_EXTENSION_NAME

The extension name.

public static final int
VK_AMD_BUFFER_MARKER_SPEC_VERSION

The extension specification version.

Constructor Summary

AccessConstructor and Description
protected
AMDBufferMarker()

Method Summary

Modifier and TypeMethod and Description
public static void
vkCmdWriteBufferMarkerAMD(VkCommandBuffer
the command buffer into which the command will be recorded.
commandBuffer, int
a VkPipelineStageFlagBits value specifying the pipeline stage whose completion triggers the marker write.
pipelineStage, long
the buffer where the marker will be written to.
dstBuffer, long
the byte offset into the buffer where the marker will be written to.
dstOffset, int
the 32-bit value of the marker.
marker)

Execute a pipelined write of a marker value into a buffer.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

VK_AMD_BUFFER_MARKER_EXTENSION_NAMEback to summary
public static final String VK_AMD_BUFFER_MARKER_EXTENSION_NAME

The extension name.

VK_AMD_BUFFER_MARKER_SPEC_VERSIONback to summary
public static final int VK_AMD_BUFFER_MARKER_SPEC_VERSION

The extension specification version.

Constructor Detail

AMDBufferMarkerback to summary
protected AMDBufferMarker()

Method Detail

vkCmdWriteBufferMarkerAMDback to summary
public static void vkCmdWriteBufferMarkerAMD(VkCommandBuffer commandBuffer, int pipelineStage, long dstBuffer, long dstOffset, int marker)

Execute a pipelined write of a marker value into a buffer.

C Specification

To write a 32-bit marker value into a buffer as a pipelined operation, call:


void vkCmdWriteBufferMarkerAMD(
    VkCommandBuffer                             commandBuffer,
    VkPipelineStageFlagBits                     pipelineStage,
    VkBuffer                                    dstBuffer,
    VkDeviceSize                                dstOffset,
    uint32_t                                    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 vkCmdWriteBufferMarkerAMD 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 vkCmdWriteTimestamp, 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
Valid Usage (Implicit)
  • commandBuffer must be a valid VkCommandBuffer handle
  • If pipelineStage is not 0, pipelineStage must be a valid VkPipelineStageFlagBits value
  • dstBuffer must be a valid VkBuffer handle
  • commandBuffer must be in the recording state
  • The VkCommandPool 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 VkDevice
Host Synchronization
  • Host access to commandBuffer must be externally synchronized
  • Host access to the VkCommandPool that commandBuffer was allocated from must be externally synchronized
Command Properties
Command Buffer LevelsRender Pass ScopeVideo Coding ScopeSupported Queue TypesCommand Type
Primary SecondaryBothOutsideTransfer Graphics ComputeAction
Parameters
commandBuffer:VkCommandBuffer

the command buffer into which the command will be recorded.

pipelineStage:int

a VkPipelineStageFlagBits value specifying the pipeline stage whose completion triggers the marker write.

dstBuffer:long

the buffer where the marker will be written to.

dstOffset:long

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

marker:int

the 32-bit value of the marker.