Package org.lwjgl.vulkan

Class AMDXShaderEnqueue

java.lang.Object

org.lwjgl.vulkan.AMDXShaderEnqueue

public class AMDXShaderEnqueue
extends Object

This extension adds the ability for developers to enqueue mesh and compute shader workgroups from other compute shaders.

Name String

VK_AMDX_shader_enqueue

Extension Type

Device extension

Registered Extension Number

135

Revision

2

Extension and Version Dependencies

VK_KHR_synchronization2 and VK_KHR_spirv_1_4 and VK_EXT_extended_dynamic_state or Version 1.3 and VK_KHR_maintenance5 and VK_KHR_pipeline_library

• This is a provisional extension and must be used with caution. See the description of provisional header files for enablement and stability details.

API Interactions

• Interacts with VK_VERSION_1_4
• Interacts with VK_EXT_mesh_shader
• Interacts with VK_KHR_maintenance5

SPIR-V Dependencies

• SPV_AMDX_shader_enqueue

Contact

• Tobias Hector tobski

Extension Proposal

VK_AMDX_shader_enqueue

Other Extension Metadata

Last Modified Date

2024-07-17

Provisional

This extension is provisional and should not be used in production applications. The functionality may change in ways that break backwards compatibility between revisions, and before final release.

Contributors

• Tobias Hector, AMD
• Matthaeus Chajdas, AMD
• Maciej Jesionowski, AMD
• Robert Martin, AMD
• Qun Lin, AMD
• Rex Xu, AMD
• Dominik Witczak, AMD
• Karthik Srinivasan, AMD
• Nicolai Haehnle, AMD
• Stuart Smith, AMD

Field Summary

Fields

Modifier and Type	Field	Description
static final String	VK_AMDX_SHADER_ENQUEUE_EXTENSION_NAME	The extension name.
static final int	VK_AMDX_SHADER_ENQUEUE_SPEC_VERSION	The extension specification version.
static final long	VK_BUFFER_USAGE_2_EXECUTION_GRAPH_SCRATCH_BIT_AMDX	Extends VkBufferUsageFlagBits2.
static final int	VK_BUFFER_USAGE_EXECUTION_GRAPH_SCRATCH_BIT_AMDX	Extends VkBufferUsageFlagBits.
static final int	VK_PIPELINE_BIND_POINT_EXECUTION_GRAPH_AMDX	Extends VkPipelineBindPoint.
static final long	VK_PIPELINE_CREATE_2_EXECUTION_GRAPH_BIT_AMDX	Extends VkPipelineCreateFlagBits2.
static final int	VK_SHADER_INDEX_UNUSED_AMDX	VK_SHADER_INDEX_UNUSED_AMDX
static final int	VK_STRUCTURE_TYPE_EXECUTION_GRAPH_PIPELINE_CREATE_INFO_AMDX	Extends VkStructureType.
static final int	VK_STRUCTURE_TYPE_EXECUTION_GRAPH_PIPELINE_SCRATCH_SIZE_AMDX	Extends VkStructureType.
static final int	VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_SHADER_ENQUEUE_FEATURES_AMDX	Extends VkStructureType.
static final int	VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_SHADER_ENQUEUE_PROPERTIES_AMDX	Extends VkStructureType.
static final int	VK_STRUCTURE_TYPE_PIPELINE_SHADER_STAGE_NODE_CREATE_INFO_AMDX	Extends VkStructureType.

Method Summary

Modifier and Type	Method	Description
static void	nvkCmdDispatchGraphAMDX(org.lwjgl.vulkan.VkCommandBuffer commandBuffer, long scratch, long scratchSize, long pCountInfo)	Unsafe version of: CmdDispatchGraphAMDX
static void	nvkCmdDispatchGraphIndirectAMDX(org.lwjgl.vulkan.VkCommandBuffer commandBuffer, long scratch, long scratchSize, long pCountInfo)	Unsafe version of: CmdDispatchGraphIndirectAMDX
static int	nvkCreateExecutionGraphPipelinesAMDX(org.lwjgl.vulkan.VkDevice device, long pipelineCache, int createInfoCount, long pCreateInfos, long pAllocator, long pPipelines)	Unsafe version of: CreateExecutionGraphPipelinesAMDX
static int	nvkGetExecutionGraphPipelineNodeIndexAMDX(org.lwjgl.vulkan.VkDevice device, long executionGraph, long pNodeInfo, long pNodeIndex)	Unsafe version of: GetExecutionGraphPipelineNodeIndexAMDX
static int	nvkGetExecutionGraphPipelineScratchSizeAMDX(org.lwjgl.vulkan.VkDevice device, long executionGraph, long pSizeInfo)	Unsafe version of: GetExecutionGraphPipelineScratchSizeAMDX
static void	vkCmdDispatchGraphAMDX(org.lwjgl.vulkan.VkCommandBuffer commandBuffer, long scratch, long scratchSize, VkDispatchGraphCountInfoAMDX pCountInfo)	Dispatch an execution graph.
static void	vkCmdDispatchGraphIndirectAMDX(org.lwjgl.vulkan.VkCommandBuffer commandBuffer, long scratch, long scratchSize, VkDispatchGraphCountInfoAMDX pCountInfo)	Dispatch an execution graph with node and payload parameters read on the device.
static void	vkCmdDispatchGraphIndirectCountAMDX(org.lwjgl.vulkan.VkCommandBuffer commandBuffer, long scratch, long scratchSize, long countInfo)	Dispatch an execution graph with all parameters read on the device.
static void	vkCmdInitializeGraphScratchMemoryAMDX(org.lwjgl.vulkan.VkCommandBuffer commandBuffer, long executionGraph, long scratch, long scratchSize)	Initialize scratch memory for an execution graph.
static int	vkCreateExecutionGraphPipelinesAMDX(org.lwjgl.vulkan.VkDevice device, long pipelineCache, VkExecutionGraphPipelineCreateInfoAMDX.Buffer pCreateInfos, @Nullable VkAllocationCallbacks pAllocator, long[] pPipelines)	Array version of: CreateExecutionGraphPipelinesAMDX
static int	vkCreateExecutionGraphPipelinesAMDX(org.lwjgl.vulkan.VkDevice device, long pipelineCache, VkExecutionGraphPipelineCreateInfoAMDX.Buffer pCreateInfos, @Nullable VkAllocationCallbacks pAllocator, LongBuffer pPipelines)	Creates a new execution graph pipeline object.
static int	vkGetExecutionGraphPipelineNodeIndexAMDX(org.lwjgl.vulkan.VkDevice device, long executionGraph, VkPipelineShaderStageNodeCreateInfoAMDX pNodeInfo, int[] pNodeIndex)	Array version of: GetExecutionGraphPipelineNodeIndexAMDX
static int	vkGetExecutionGraphPipelineNodeIndexAMDX(org.lwjgl.vulkan.VkDevice device, long executionGraph, VkPipelineShaderStageNodeCreateInfoAMDX pNodeInfo, IntBuffer pNodeIndex)	Query internal id of a node in an execution graph.
static int	vkGetExecutionGraphPipelineScratchSizeAMDX(org.lwjgl.vulkan.VkDevice device, long executionGraph, VkExecutionGraphPipelineScratchSizeAMDX pSizeInfo)	Query scratch space required to dispatch an execution graph.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

VK_AMDX_SHADER_ENQUEUE_SPEC_VERSION

public static final int VK_AMDX_SHADER_ENQUEUE_SPEC_VERSION

The extension specification version.

See Also:

• Constant Field Values

VK_AMDX_SHADER_ENQUEUE_EXTENSION_NAME

public static final String VK_AMDX_SHADER_ENQUEUE_EXTENSION_NAME

The extension name.

See Also:

• Constant Field Values

VK_SHADER_INDEX_UNUSED_AMDX

public static final int VK_SHADER_INDEX_UNUSED_AMDX

VK_SHADER_INDEX_UNUSED_AMDX

See Also:

• Constant Field Values

VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_SHADER_ENQUEUE_FEATURES_AMDX

public static final int VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_SHADER_ENQUEUE_FEATURES_AMDX

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_PHYSICAL_DEVICE_SHADER_ENQUEUE_FEATURES_AMDX
• STRUCTURE_TYPE_PHYSICAL_DEVICE_SHADER_ENQUEUE_PROPERTIES_AMDX
• STRUCTURE_TYPE_EXECUTION_GRAPH_PIPELINE_SCRATCH_SIZE_AMDX
• STRUCTURE_TYPE_EXECUTION_GRAPH_PIPELINE_CREATE_INFO_AMDX
• STRUCTURE_TYPE_PIPELINE_SHADER_STAGE_NODE_CREATE_INFO_AMDX

See Also:

• Constant Field Values

VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_SHADER_ENQUEUE_PROPERTIES_AMDX

public static final int VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_SHADER_ENQUEUE_PROPERTIES_AMDX

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_PHYSICAL_DEVICE_SHADER_ENQUEUE_FEATURES_AMDX
• STRUCTURE_TYPE_PHYSICAL_DEVICE_SHADER_ENQUEUE_PROPERTIES_AMDX
• STRUCTURE_TYPE_EXECUTION_GRAPH_PIPELINE_SCRATCH_SIZE_AMDX
• STRUCTURE_TYPE_EXECUTION_GRAPH_PIPELINE_CREATE_INFO_AMDX
• STRUCTURE_TYPE_PIPELINE_SHADER_STAGE_NODE_CREATE_INFO_AMDX

See Also:

• Constant Field Values

VK_STRUCTURE_TYPE_EXECUTION_GRAPH_PIPELINE_SCRATCH_SIZE_AMDX

public static final int VK_STRUCTURE_TYPE_EXECUTION_GRAPH_PIPELINE_SCRATCH_SIZE_AMDX

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_PHYSICAL_DEVICE_SHADER_ENQUEUE_FEATURES_AMDX
• STRUCTURE_TYPE_PHYSICAL_DEVICE_SHADER_ENQUEUE_PROPERTIES_AMDX
• STRUCTURE_TYPE_EXECUTION_GRAPH_PIPELINE_SCRATCH_SIZE_AMDX
• STRUCTURE_TYPE_EXECUTION_GRAPH_PIPELINE_CREATE_INFO_AMDX
• STRUCTURE_TYPE_PIPELINE_SHADER_STAGE_NODE_CREATE_INFO_AMDX

See Also:

• Constant Field Values

VK_STRUCTURE_TYPE_EXECUTION_GRAPH_PIPELINE_CREATE_INFO_AMDX

public static final int VK_STRUCTURE_TYPE_EXECUTION_GRAPH_PIPELINE_CREATE_INFO_AMDX

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_PHYSICAL_DEVICE_SHADER_ENQUEUE_FEATURES_AMDX
• STRUCTURE_TYPE_PHYSICAL_DEVICE_SHADER_ENQUEUE_PROPERTIES_AMDX
• STRUCTURE_TYPE_EXECUTION_GRAPH_PIPELINE_SCRATCH_SIZE_AMDX
• STRUCTURE_TYPE_EXECUTION_GRAPH_PIPELINE_CREATE_INFO_AMDX
• STRUCTURE_TYPE_PIPELINE_SHADER_STAGE_NODE_CREATE_INFO_AMDX

See Also:

• Constant Field Values

VK_STRUCTURE_TYPE_PIPELINE_SHADER_STAGE_NODE_CREATE_INFO_AMDX

public static final int VK_STRUCTURE_TYPE_PIPELINE_SHADER_STAGE_NODE_CREATE_INFO_AMDX

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_PHYSICAL_DEVICE_SHADER_ENQUEUE_FEATURES_AMDX
• STRUCTURE_TYPE_PHYSICAL_DEVICE_SHADER_ENQUEUE_PROPERTIES_AMDX
• STRUCTURE_TYPE_EXECUTION_GRAPH_PIPELINE_SCRATCH_SIZE_AMDX
• STRUCTURE_TYPE_EXECUTION_GRAPH_PIPELINE_CREATE_INFO_AMDX
• STRUCTURE_TYPE_PIPELINE_SHADER_STAGE_NODE_CREATE_INFO_AMDX

See Also:

• Constant Field Values

VK_BUFFER_USAGE_EXECUTION_GRAPH_SCRATCH_BIT_AMDX

public static final int VK_BUFFER_USAGE_EXECUTION_GRAPH_SCRATCH_BIT_AMDX

Extends VkBufferUsageFlagBits.

See Also:

• Constant Field Values

VK_PIPELINE_BIND_POINT_EXECUTION_GRAPH_AMDX

public static final int VK_PIPELINE_BIND_POINT_EXECUTION_GRAPH_AMDX

Extends VkPipelineBindPoint.

See Also:

• Constant Field Values

VK_BUFFER_USAGE_2_EXECUTION_GRAPH_SCRATCH_BIT_AMDX

public static final long VK_BUFFER_USAGE_2_EXECUTION_GRAPH_SCRATCH_BIT_AMDX

Extends VkBufferUsageFlagBits2.

See Also:

• Constant Field Values

VK_PIPELINE_CREATE_2_EXECUTION_GRAPH_BIT_AMDX

public static final long VK_PIPELINE_CREATE_2_EXECUTION_GRAPH_BIT_AMDX

Extends VkPipelineCreateFlagBits2.

See Also:

• Constant Field Values

Method Details

nvkCreateExecutionGraphPipelinesAMDX

public static int nvkCreateExecutionGraphPipelinesAMDX(org.lwjgl.vulkan.VkDevice device,
 long pipelineCache,
 int createInfoCount,
 long pCreateInfos,
 long pAllocator,
 long pPipelines)

Unsafe version of: CreateExecutionGraphPipelinesAMDX

Parameters:

createInfoCount - the length of the pCreateInfos and pPipelines arrays.

vkCreateExecutionGraphPipelinesAMDX

public static int vkCreateExecutionGraphPipelinesAMDX(org.lwjgl.vulkan.VkDevice device,
 long pipelineCache,
 VkExecutionGraphPipelineCreateInfoAMDX.Buffer pCreateInfos,
 @Nullable VkAllocationCallbacks pAllocator,
 LongBuffer pPipelines)

Creates a new execution graph pipeline object.

C Specification

To create execution graph pipelines, call:

 VkResult vkCreateExecutionGraphPipelinesAMDX(
     VkDevice                                    device,
     VkPipelineCache                             pipelineCache,
     uint32_t                                    createInfoCount,
     const VkExecutionGraphPipelineCreateInfoAMDX* pCreateInfos,
     const VkAllocationCallbacks*                pAllocator,
     VkPipeline*                                 pPipelines);

Description

Pipelines are created and returned as described for Multiple Pipeline Creation.

Valid Usage

• The shaderEnqueue feature must be enabled
• If the flags member of any element of pCreateInfos contains the PIPELINE_CREATE_DERIVATIVE_BIT flag, and the basePipelineIndex member of that same element is not -1, basePipelineIndex must be less than the index into pCreateInfos that corresponds to that element
• If the flags member of any element of pCreateInfos contains the PIPELINE_CREATE_DERIVATIVE_BIT flag, the base pipeline must have been created with the PIPELINE_CREATE_ALLOW_DERIVATIVES_BIT flag set
• If pipelineCache was created with PIPELINE_CACHE_CREATE_EXTERNALLY_SYNCHRONIZED_BIT, host access to pipelineCache must be externally synchronized

• If VkPipelineBinaryInfoKHR::binaryCount is not 0 for any element of pCreateInfos, pipelineCache must be NULL_HANDLE
• If a VkPipelineCreateFlags2CreateInfoKHR structure with the PIPELINE_CREATE_2_CAPTURE_DATA_BIT_KHR flag set is included in the pNext chain of any element of pCreateInfos, pipelineCache must be NULL_HANDLE
• If VkPipelineBinaryInfoKHR::binaryCount is not 0 for any element of pCreateInfos, PIPELINE_CREATION_FEEDBACK_APPLICATION_PIPELINE_CACHE_HIT_BIT must not be set in the flags of that element
• If VkPipelineBinaryInfoKHR::binaryCount is not 0 for any element of pCreateInfos, PIPELINE_CREATION_FEEDBACK_BASE_PIPELINE_ACCELERATION_BIT must not be set in the flags of that element
• If VkPipelineBinaryInfoKHR::binaryCount is not 0 for any element of pCreateInfos, PIPELINE_CREATE_FAIL_ON_PIPELINE_COMPILE_REQUIRED_BIT_EXT must not be set in the flags of that element

Valid Usage (Implicit)

• device must be a valid VkDevice handle
• If pipelineCache is not NULL_HANDLE, pipelineCache must be a valid VkPipelineCache handle
• pCreateInfos must be a valid pointer to an array of createInfoCount valid VkExecutionGraphPipelineCreateInfoAMDX structures
• If pAllocator is not NULL, pAllocator must be a valid pointer to a valid VkAllocationCallbacks structure
• pPipelines must be a valid pointer to an array of createInfoCount VkPipeline handles
• createInfoCount must be greater than 0
• If pipelineCache is a valid handle, it must have been created, allocated, or retrieved from device

Return Codes

On success, this command returns

• SUCCESS
• PIPELINE_COMPILE_REQUIRED_EXT

On failure, this command returns

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY

See Also

VkAllocationCallbacks, VkExecutionGraphPipelineCreateInfoAMDX

Parameters:

device - the logical device that creates the execution graph pipelines.

pipelineCache - either NULL_HANDLE, indicating that pipeline caching is disabled; or the handle of a valid pipeline cache object, in which case use of that cache is enabled for the duration of the command.

pCreateInfos - a pointer to an array of VkExecutionGraphPipelineCreateInfoAMDX structures.

pAllocator - controls host memory allocation as described in the Memory Allocation chapter.

pPipelines - a pointer to an array of VkPipeline handles in which the resulting execution graph pipeline objects are returned.

nvkGetExecutionGraphPipelineScratchSizeAMDX

public static int nvkGetExecutionGraphPipelineScratchSizeAMDX(org.lwjgl.vulkan.VkDevice device,
 long executionGraph,
 long pSizeInfo)

Unsafe version of: GetExecutionGraphPipelineScratchSizeAMDX

vkGetExecutionGraphPipelineScratchSizeAMDX

public static int vkGetExecutionGraphPipelineScratchSizeAMDX(org.lwjgl.vulkan.VkDevice device,
 long executionGraph,
 VkExecutionGraphPipelineScratchSizeAMDX pSizeInfo)

Query scratch space required to dispatch an execution graph.

C Specification

To query the scratch space required to dispatch an execution graph, call:

 VkResult vkGetExecutionGraphPipelineScratchSizeAMDX(
     VkDevice                                    device,
     VkPipeline                                  executionGraph,
     VkExecutionGraphPipelineScratchSizeAMDX*    pSizeInfo);

Description

After this function returns, information about the scratch space required will be returned in pSizeInfo.

Valid Usage (Implicit)

• device must be a valid VkDevice handle
• executionGraph must be a valid VkPipeline handle
• pSizeInfo must be a valid pointer to a VkExecutionGraphPipelineScratchSizeAMDX structure
• executionGraph must have been created, allocated, or retrieved from device

Return Codes

On success, this command returns

• SUCCESS

On failure, this command returns

• ERROR_OUT_OF_HOST_MEMORY

See Also

VkExecutionGraphPipelineScratchSizeAMDX

Parameters:

device - the logical device that executionGraph was created on.

executionGraph - the execution graph pipeline to query the scratch space for.

pSizeInfo - a pointer to a VkExecutionGraphPipelineScratchSizeAMDX structure that will contain the required scratch size.

nvkGetExecutionGraphPipelineNodeIndexAMDX

public static int nvkGetExecutionGraphPipelineNodeIndexAMDX(org.lwjgl.vulkan.VkDevice device,
 long executionGraph,
 long pNodeInfo,
 long pNodeIndex)

Unsafe version of: GetExecutionGraphPipelineNodeIndexAMDX

vkGetExecutionGraphPipelineNodeIndexAMDX

public static int vkGetExecutionGraphPipelineNodeIndexAMDX(org.lwjgl.vulkan.VkDevice device,
 long executionGraph,
 VkPipelineShaderStageNodeCreateInfoAMDX pNodeInfo,
 IntBuffer pNodeIndex)

Query internal id of a node in an execution graph.

C Specification

To query the internal node index for a particular node in an execution graph, call:

 VkResult vkGetExecutionGraphPipelineNodeIndexAMDX(
     VkDevice                                    device,
     VkPipeline                                  executionGraph,
     const VkPipelineShaderStageNodeCreateInfoAMDX* pNodeInfo,
     uint32_t*                                   pNodeIndex);

Description

Once this function returns, the contents of pNodeIndex contain the internal node index of the identified node.

Valid Usage

• pNodeInfo→pName must not be NULL
• pNodeInfo→index must not be SHADER_INDEX_UNUSED_AMDX
• There must be a node in executionGraph with a shader name and index equal to pNodeInfo→pName and pNodeInfo→index

Valid Usage (Implicit)

• device must be a valid VkDevice handle
• executionGraph must be a valid VkPipeline handle
• pNodeInfo must be a valid pointer to a valid VkPipelineShaderStageNodeCreateInfoAMDX structure
• pNodeIndex must be a valid pointer to a uint32_t value
• executionGraph must have been created, allocated, or retrieved from device

Return Codes

On success, this command returns

• SUCCESS

On failure, this command returns

• ERROR_OUT_OF_HOST_MEMORY

See Also

VkPipelineShaderStageNodeCreateInfoAMDX

Parameters:

device - the logical device that executionGraph was created on.

executionGraph - the execution graph pipeline to query the internal node index for.

pNodeInfo - a pointer to a VkPipelineShaderStageNodeCreateInfoAMDX structure identifying the name and index of the node to query.

pNodeIndex - the returned internal node index of the identified node.

vkCmdInitializeGraphScratchMemoryAMDX

public static void vkCmdInitializeGraphScratchMemoryAMDX(org.lwjgl.vulkan.VkCommandBuffer commandBuffer,
 long executionGraph,
 long scratch,
 long scratchSize)

Initialize scratch memory for an execution graph.

C Specification

To initialize scratch memory for a particular execution graph, call:

 void vkCmdInitializeGraphScratchMemoryAMDX(
     VkCommandBuffer                             commandBuffer,
     VkPipeline                                  executionGraph,
     VkDeviceAddress                             scratch,
     VkDeviceSize                                scratchSize);

Description

This command must be called before using scratch to dispatch the bound execution graph pipeline.

Execution of this command may modify any memory locations in the range [scratch,scratch + scratchSize). Accesses to this memory range are performed in the PIPELINE_STAGE_2_COMPUTE_SHADER_BIT pipeline stage with the ACCESS_2_SHADER_STORAGE_READ_BIT and ACCESS_2_SHADER_STORAGE_WRITE_BIT access flags.

If any portion of scratch is modified by any command other than CmdDispatchGraphAMDX, CmdDispatchGraphIndirectAMDX, CmdDispatchGraphIndirectCountAMDX, or CmdInitializeGraphScratchMemoryAMDX with the same execution graph, it must be reinitialized for the execution graph again before dispatching against it.

Valid Usage

• scratch must be the device address of an allocated memory range at least as large as scratchSize
• scratchSize must be greater than or equal to VkExecutionGraphPipelineScratchSizeAMDX::minSize returned by GetExecutionGraphPipelineScratchSizeAMDX for the bound execution graph pipeline
• scratch must be a multiple of 64

Valid Usage (Implicit)

• commandBuffer must be a valid VkCommandBuffer handle
• executionGraph must be a valid VkPipeline handle
• commandBuffer must be in the recording state
• The VkCommandPool that commandBuffer was allocated from must support graphics, or compute operations
• This command must only be called outside of a video coding scope
• commandBuffer must be a primary VkCommandBuffer
• Both of commandBuffer, and executionGraph must have been created, allocated, or retrieved from the same VkDevice

Host Synchronization

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

Command Properties

Command Buffer Levels	Render Pass Scope	Video Coding Scope	Supported Queue Types	Command Type
Primary	Both	Outside	Graphics Compute	Action

Parameters:

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

executionGraph - the execution graph pipeline to initialize the scratch memory for.

scratch - the address of scratch memory to be initialized.

scratchSize - a range in bytes of scratch memory to be initialized.

nvkCmdDispatchGraphAMDX

public static void nvkCmdDispatchGraphAMDX(org.lwjgl.vulkan.VkCommandBuffer commandBuffer,
 long scratch,
 long scratchSize,
 long pCountInfo)

Unsafe version of: CmdDispatchGraphAMDX

vkCmdDispatchGraphAMDX

public static void vkCmdDispatchGraphAMDX(org.lwjgl.vulkan.VkCommandBuffer commandBuffer,
 long scratch,
 long scratchSize,
 VkDispatchGraphCountInfoAMDX pCountInfo)

Dispatch an execution graph.

C Specification

To record an execution graph dispatch, call:

 void vkCmdDispatchGraphAMDX(
     VkCommandBuffer                             commandBuffer,
     VkDeviceAddress                             scratch,
     VkDeviceSize                                scratchSize,
     const VkDispatchGraphCountInfoAMDX*         pCountInfo);

Description

When this command is executed, the nodes specified in pCountInfo are executed. Nodes executed as part of this command are not implicitly synchronized in any way against each other once they are dispatched. There are no rasterization order guarantees between separately dispatched graphics nodes, though individual primitives within a single dispatch do adhere to rasterization order. Draw calls executed before or after the execution graph also execute relative to each graphics node with respect to rasterization order.

For this command, all device/host pointers in substructures are treated as host pointers and read only during host execution of this command. Once this command returns, no reference to the original pointers is retained.

Execution of this command may modify any memory locations in the range [scratch,scratch + scratchSize). Accesses to this memory range are performed in the PIPELINE_STAGE_2_COMPUTE_SHADER_BIT pipeline stage with the ACCESS_2_SHADER_STORAGE_READ_BIT and ACCESS_2_SHADER_STORAGE_WRITE_BIT access flags.

This command captures command buffer state for mesh nodes similarly to draw commands.

Valid Usage

• If a VkSampler created with magFilter or minFilter equal to FILTER_LINEAR, reductionMode equal to SAMPLER_REDUCTION_MODE_WEIGHTED_AVERAGE, and compareEnable equal to FALSE is used to sample a VkImageView as a result of this command, then the image view’s format features must contain FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT
• If a VkSampler created with magFilter or minFilter equal to FILTER_LINEAR and reductionMode equal to either SAMPLER_REDUCTION_MODE_MIN or SAMPLER_REDUCTION_MODE_MAX is used to sample a VkImageView as a result of this command, then the image view’s format features must contain FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_MINMAX_BIT
• If a VkSampler created with mipmapMode equal to SAMPLER_MIPMAP_MODE_LINEAR, reductionMode equal to SAMPLER_REDUCTION_MODE_WEIGHTED_AVERAGE, and compareEnable equal to FALSE is used to sample a VkImageView as a result of this command, then the image view’s format features must contain FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT
• If a VkSampler created with mipmapMode equal to SAMPLER_MIPMAP_MODE_LINEAR and reductionMode equal to either SAMPLER_REDUCTION_MODE_MIN or SAMPLER_REDUCTION_MODE_MAX is used to sample a VkImageView as a result of this command, then the image view’s format features must contain FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_MINMAX_BIT
• If a VkSampler created with unnormalizedCoordinates equal to TRUE is used to sample a VkImageView as a result of this command, then the image view’s levelCount and layerCount must be 1
• If a VkSampler created with unnormalizedCoordinates equal to TRUE is used to sample a VkImageView as a result of this command, then the image view’s viewType must be IMAGE_VIEW_TYPE_1D or IMAGE_VIEW_TYPE_2D
• If a VkSampler created with unnormalizedCoordinates equal to TRUE is used to sample a VkImageView as a result of this command, then the sampler must not be used with any of the SPIR-V OpImageSample* or OpImageSparseSample* instructions with ImplicitLod, Dref or Proj in their name
• If a VkSampler created with unnormalizedCoordinates equal to TRUE is used to sample a VkImageView as a result of this command, then the sampler must not be used with any of the SPIR-V OpImageSample* or OpImageSparseSample* instructions that includes a LOD bias or any offset values
• If a VkImageView is sampled with depth comparison, the image view’s format features must contain FORMAT_FEATURE_2_SAMPLED_IMAGE_DEPTH_COMPARISON_BIT
• If a VkImageView is accessed using atomic operations as a result of this command, then the image view’s format features must contain FORMAT_FEATURE_STORAGE_IMAGE_ATOMIC_BIT
• If a DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER descriptor is accessed using atomic operations as a result of this command, then the storage texel buffer’s format features must contain FORMAT_FEATURE_STORAGE_TEXEL_BUFFER_ATOMIC_BIT
• If a VkImageView is sampled with FILTER_CUBIC_EXT as a result of this command, then the image view’s format features must contain FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_EXT
• If the VK_EXT_filter_cubic extension is not enabled and any VkImageView is sampled with FILTER_CUBIC_EXT as a result of this command, it must not have a VkImageViewType of IMAGE_VIEW_TYPE_3D, IMAGE_VIEW_TYPE_CUBE, or IMAGE_VIEW_TYPE_CUBE_ARRAY
• Any VkImageView being sampled with FILTER_CUBIC_EXT as a result of this command must have a VkImageViewType and format that supports cubic filtering, as specified by VkFilterCubicImageViewImageFormatPropertiesEXT::filterCubic returned by GetPhysicalDeviceImageFormatProperties2
• Any VkImageView being sampled with FILTER_CUBIC_EXT with a reduction mode of either SAMPLER_REDUCTION_MODE_MIN or SAMPLER_REDUCTION_MODE_MAX as a result of this command must have a VkImageViewType and format that supports cubic filtering together with minmax filtering, as specified by VkFilterCubicImageViewImageFormatPropertiesEXT::filterCubicMinmax returned by GetPhysicalDeviceImageFormatProperties2
• If the cubicRangeClamp feature is not enabled, then any VkImageView being sampled with FILTER_CUBIC_EXT as a result of this command must not have a VkSamplerReductionModeCreateInfo::reductionMode equal to SAMPLER_REDUCTION_MODE_WEIGHTED_AVERAGE_RANGECLAMP_QCOM
• Any VkImageView being sampled with a VkSamplerReductionModeCreateInfo::reductionMode equal to SAMPLER_REDUCTION_MODE_WEIGHTED_AVERAGE_RANGECLAMP_QCOM as a result of this command must sample with FILTER_CUBIC_EXT
• If the selectableCubicWeights feature is not enabled, then any VkImageView being sampled with FILTER_CUBIC_EXT as a result of this command must have VkSamplerCubicWeightsCreateInfoQCOM::cubicWeights equal to CUBIC_FILTER_WEIGHTS_CATMULL_ROM_QCOM
• Any VkImage created with a VkImageCreateInfo::flags containing IMAGE_CREATE_CORNER_SAMPLED_BIT_NV sampled as a result of this command must only be sampled using a VkSamplerAddressMode of SAMPLER_ADDRESS_MODE_CLAMP_TO_EDGE
• For any VkImageView being written as a storage image where the image format field of the OpTypeImage is Unknown, the view’s format features must contain FORMAT_FEATURE_2_STORAGE_WRITE_WITHOUT_FORMAT_BIT
• For any VkImageView being read as a storage image where the image format field of the OpTypeImage is Unknown, the view’s format features must contain FORMAT_FEATURE_2_STORAGE_READ_WITHOUT_FORMAT_BIT
• For any VkBufferView being written as a storage texel buffer where the image format field of the OpTypeImage is Unknown, the view’s buffer features must contain FORMAT_FEATURE_2_STORAGE_WRITE_WITHOUT_FORMAT_BIT
• Any VkBufferView being read as a storage texel buffer where the image format field of the OpTypeImage is Unknown then the view’s buffer features must contain FORMAT_FEATURE_2_STORAGE_READ_WITHOUT_FORMAT_BIT
• For each set n that is statically used by a bound shader, a descriptor set must have been bound to n at the same pipeline bind point, with a VkPipelineLayout that is compatible for set n, with the VkPipelineLayout used to create the current VkPipeline or the VkDescriptorSetLayout array used to create the current VkShaderEXT , as described in Pipeline Layout Compatibility
• For each push constant that is statically used by a bound shader, a push constant value must have been set for the same pipeline bind point, with a VkPipelineLayout that is compatible for push constants, with the VkPipelineLayout used to create the current VkPipeline or the VkDescriptorSetLayout array used to create the current VkShaderEXT , as described in Pipeline Layout Compatibility
• For each array of resources that is used by a bound shader, the indices used to access members of the array must be less than the descriptor count for the identified binding in the descriptor sets used by this command
• If the maintenance4 feature is not enabled, then for each push constant that is statically used by a bound shader, a push constant value must have been set for the same pipeline bind point, with a VkPipelineLayout that is compatible for push constants, with the VkPipelineLayout used to create the current VkPipeline or the VkDescriptorSetLayout and VkPushConstantRange arrays used to create the current VkShaderEXT , as described in Pipeline Layout Compatibility
• Descriptors in each bound descriptor set, specified via CmdBindDescriptorSets, must be valid as described by descriptor validity if they are statically used by the VkPipeline bound to the pipeline bind point used by this command and the bound VkPipeline was not created with PIPELINE_CREATE_DESCRIPTOR_BUFFER_BIT_EXT
• If the descriptors used by the VkPipeline bound to the pipeline bind point were specified via CmdBindDescriptorSets, the bound VkPipeline must have been created without PIPELINE_CREATE_DESCRIPTOR_BUFFER_BIT_EXT
• Descriptors in bound descriptor buffers, specified via CmdSetDescriptorBufferOffsetsEXT, must be valid if they are dynamically used by the VkPipeline bound to the pipeline bind point used by this command and the bound VkPipeline was created with PIPELINE_CREATE_DESCRIPTOR_BUFFER_BIT_EXT
• Descriptors in bound descriptor buffers, specified via CmdSetDescriptorBufferOffsetsEXT, must be valid if they are dynamically used by any VkShaderEXT bound to a stage corresponding to the pipeline bind point used by this command
• If the descriptors used by the VkPipeline bound to the pipeline bind point were specified via CmdSetDescriptorBufferOffsetsEXT, the bound VkPipeline must have been created with PIPELINE_CREATE_DESCRIPTOR_BUFFER_BIT_EXT
• If a descriptor is dynamically used with a VkPipeline created with PIPELINE_CREATE_DESCRIPTOR_BUFFER_BIT_EXT, the descriptor memory must be resident
• If a descriptor is dynamically used with a VkShaderEXT created with a VkDescriptorSetLayout that was created with DESCRIPTOR_SET_LAYOUT_CREATE_DESCRIPTOR_BUFFER_BIT_EXT, the descriptor memory must be resident
• If the shaderObject feature is not enabled, a valid pipeline must be bound to the pipeline bind point used by this command
• If a pipeline is bound to the pipeline bind point used by this command, there must not have been any calls to dynamic state setting commands for any state specified statically in the VkPipeline object bound to the pipeline bind point used by this command, since that pipeline was bound
• If the shaderObject feature is enabled, either a valid pipeline must be bound to the pipeline bind point used by this command, or a valid combination of valid and NULL_HANDLE shader objects must be bound to every supported shader stage corresponding to the pipeline bind point used by this command
• If any stage of the VkPipeline object bound to the pipeline bind point used by this command accesses a uniform buffer, and that stage was created without enabling either PIPELINE_ROBUSTNESS_BUFFER_BEHAVIOR_ROBUST_BUFFER_ACCESS or PIPELINE_ROBUSTNESS_BUFFER_BEHAVIOR_ROBUST_BUFFER_ACCESS_2 for uniformBuffers, and the robustBufferAccess feature is not enabled, that stage must not access values outside of the range of the buffer as specified in the descriptor set bound to the same pipeline bind point
• If the robustBufferAccess feature is not enabled, and any VkShaderEXT bound to a stage corresponding to the pipeline bind point used by this command accesses a uniform buffer, it must not access values outside of the range of the buffer as specified in the descriptor set bound to the same pipeline bind point
• If any stage of the VkPipeline object bound to the pipeline bind point used by this command accesses a storage buffer, and that stage was created without enabling either PIPELINE_ROBUSTNESS_BUFFER_BEHAVIOR_ROBUST_BUFFER_ACCESS or PIPELINE_ROBUSTNESS_BUFFER_BEHAVIOR_ROBUST_BUFFER_ACCESS_2 for storageBuffers, and the robustBufferAccess feature is not enabled, that stage must not access values outside of the range of the buffer as specified in the descriptor set bound to the same pipeline bind point
• If the robustBufferAccess feature is not enabled, and any VkShaderEXT bound to a stage corresponding to the pipeline bind point used by this command accesses a storage buffer, it must not access values outside of the range of the buffer as specified in the descriptor set bound to the same pipeline bind point
• If commandBuffer is an unprotected command buffer and protectedNoFault is not supported, any resource accessed by bound shaders must not be a protected resource
• If a bound shader accesses a VkSampler or VkImageView object that enables sampler Y′C_BC_R conversion, that object must only be used with OpImageSample* or OpImageSparseSample* instructions
• If a bound shader accesses a VkSampler or VkImageView object that enables sampler Y′C_BC_R conversion, that object must not use the ConstOffset and Offset operands
• If a VkImageView is accessed as a result of this command, then the image view’s viewType must match the Dim operand of the OpTypeImage as described in Compatibility Between SPIR-V Image Dimensions and Vulkan ImageView Types
• If a VkImageView is accessed as a result of this command, then the numeric type of the image view’s format and the Sampled Type operand of the OpTypeImage must match
• If a VkImageView created with a format other than FORMAT_A8_UNORM is accessed using OpImageWrite as a result of this command, then the Type of the Texel operand of that instruction must have at least as many components as the image view’s format
• If a VkImageView created with the format FORMAT_A8_UNORM is accessed using OpImageWrite as a result of this command, then the Type of the Texel operand of that instruction must have four components
• If a VkBufferView is accessed using OpImageWrite as a result of this command, then the Type of the Texel operand of that instruction must have at least as many components as the buffer view’s format
• If a VkImageView with a VkFormat that has a 64-bit component width is accessed as a result of this command, the SampledType of the OpTypeImage operand of that instruction must have a Width of 64
• If a VkImageView with a VkFormat that has a component width less than 64-bit is accessed as a result of this command, the SampledType of the OpTypeImage operand of that instruction must have a Width of 32
• If a VkBufferView with a VkFormat that has a 64-bit component width is accessed as a result of this command, the SampledType of the OpTypeImage operand of that instruction must have a Width of 64
• If a VkBufferView with a VkFormat that has a component width less than 64-bit is accessed as a result of this command, the SampledType of the OpTypeImage operand of that instruction must have a Width of 32
• If the sparseImageInt64Atomics feature is not enabled, VkImage objects created with the IMAGE_CREATE_SPARSE_RESIDENCY_BIT flag must not be accessed by atomic instructions through an OpTypeImage with a SampledType with a Width of 64 by this command
• If the sparseImageInt64Atomics feature is not enabled, VkBuffer objects created with the BUFFER_CREATE_SPARSE_RESIDENCY_BIT flag must not be accessed by atomic instructions through an OpTypeImage with a SampledType with a Width of 64 by this command
• If OpImageWeightedSampleQCOM is used to sample a VkImageView as a result of this command, then the image view’s format features must contain FORMAT_FEATURE_2_WEIGHT_SAMPLED_IMAGE_BIT_QCOM
• If OpImageWeightedSampleQCOM uses a VkImageView as a sample weight image as a result of this command, then the image view’s format features must contain FORMAT_FEATURE_2_WEIGHT_IMAGE_BIT_QCOM
• If OpImageBoxFilterQCOM is used to sample a VkImageView as a result of this command, then the image view’s format features must contain FORMAT_FEATURE_2_BOX_FILTER_SAMPLED_BIT_QCOM
• If OpImageBlockMatchSSDQCOM is used to read from an VkImageView as a result of this command, then the image view’s format features must contain FORMAT_FEATURE_2_BLOCK_MATCHING_BIT_QCOM
• If OpImageBlockMatchSADQCOM is used to read from an VkImageView as a result of this command, then the image view’s format features must contain FORMAT_FEATURE_2_BLOCK_MATCHING_BIT_QCOM
• If OpImageBlockMatchSADQCOM or OpImageBlockMatchSSDQCOM is used to read from a reference image as result of this command, then the specified reference coordinates must not fail integer texel coordinate validation
• If OpImageWeightedSampleQCOM, OpImageBoxFilterQCOM, OpImageBlockMatchWindowSSDQCOM, OpImageBlockMatchWindowSADQCOM, OpImageBlockMatchGatherSSDQCOM, OpImageBlockMatchGatherSADQCOM, OpImageBlockMatchSSDQCOM, or OpImageBlockMatchSADQCOM uses a VkSampler as a result of this command, then the sampler must have been created with SAMPLER_CREATE_IMAGE_PROCESSING_BIT_QCOM
• If any command other than OpImageWeightedSampleQCOM, OpImageBoxFilterQCOM, OpImageBlockMatchWindowSSDQCOM, OpImageBlockMatchWindowSADQCOM, OpImageBlockMatchGatherSSDQCOM, OpImageBlockMatchGatherSADQCOM, OpImageBlockMatchSSDQCOM, or OpImageBlockMatchSADQCOM uses a VkSampler as a result of this command, then the sampler must not have been created with SAMPLER_CREATE_IMAGE_PROCESSING_BIT_QCOM
• If a OpImageBlockMatchWindow*QCOM or OpImageBlockMatchGather*QCOM instruction is used to read from an VkImageView as a result of this command, then the image view’s format features must contain FORMAT_FEATURE_2_BLOCK_MATCHING_BIT_QCOM
• If a OpImageBlockMatchWindow*QCOM or OpImageBlockMatchGather*QCOM instruction is used to read from an VkImageView as a result of this command, then the image view’s format must be a single-component format
• If a OpImageBlockMatchWindow*QCOM or OpImageBlockMatchGather*QCOM read from a reference image as result of this command, then the specified reference coordinates must not fail integer texel coordinate validation
• Any shader invocation executed by this command must terminate
• If a descriptor with type equal to any of DESCRIPTOR_TYPE_SAMPLE_WEIGHT_IMAGE_QCOM, DESCRIPTOR_TYPE_BLOCK_MATCH_IMAGE_QCOM, DESCRIPTOR_TYPE_SAMPLED_IMAGE, DESCRIPTOR_TYPE_STORAGE_IMAGE, or DESCRIPTOR_TYPE_INPUT_ATTACHMENT is accessed as a result of this command, the image subresource identified by that descriptor must be in the image layout identified when the descriptor was written
• commandBuffer must not be a protected command buffer
• commandBuffer must be a primary command buffer
• scratch must be the device address of an allocated memory range at least as large as scratchSize
• scratchSize must be greater than or equal to VkExecutionGraphPipelineScratchSizeAMDX::minSize returned by GetExecutionGraphPipelineScratchSizeAMDX for the bound execution graph pipeline
• scratch must be a device address within a VkBuffer created with the BUFFER_USAGE_EXECUTION_GRAPH_SCRATCH_BIT_AMDX or BUFFER_USAGE_2_EXECUTION_GRAPH_SCRATCH_BIT_AMDX flag
• The device memory range [scratch,scratch scratchSize] must have been initialized with CmdInitializeGraphScratchMemoryAMDX using the bound execution graph pipeline, and not modified after that by anything other than another execution graph dispatch command
• Execution of this command must not cause a node to be dispatched with a larger number of workgroups than that specified by either a MaxNumWorkgroupsAMDX decoration in the dispatched node or maxComputeWorkGroupCount
• Execution of this command must not cause any shader to initialize more than maxExecutionGraphShaderPayloadCount output payloads
• Execution of this command must not cause any shader that declares NodeMaxPayloadsAMDX to initialize more output payloads than specified by the max number of payloads for that decoration. This requirement applies to each NodeMaxPayloadsAMDX decoration separately
• If the bound execution graph pipeline includes draw nodes, this command must be called within a render pass instance that is compatible with the graphics pipeline used to create each of those nodes
• pCountInfo→infos must be a host pointer to a memory allocation at least as large as the product of count and stride
• Host memory locations at indexes in the range [infos, infos + (count*stride)), at a granularity of stride must contain valid VkDispatchGraphInfoAMDX structures in the first 24 bytes
• For each VkDispatchGraphInfoAMDX structure in pCountInfo→infos, payloads must be a host pointer to a memory allocation at least as large as the product of payloadCount and payloadStride
• For each VkDispatchGraphInfoAMDX structure in pCountInfo→infos, nodeIndex must be a valid node index in the bound execution graph pipeline, as returned by GetExecutionGraphPipelineNodeIndexAMDX
• For each VkDispatchGraphInfoAMDX structure in pCountInfo→infos, host memory locations at indexes in the range [payloads, payloads + (payloadCount * payloadStride)), at a granularity of payloadStride must contain a payload matching the size of the input payload expected by the node in nodeIndex in the first bytes

Valid Usage (Implicit)

• commandBuffer must be a valid VkCommandBuffer handle
• pCountInfo must be a valid pointer to a valid VkDispatchGraphCountInfoAMDX structure
• commandBuffer must be in the recording state
• The VkCommandPool that commandBuffer was allocated from must support graphics, or compute operations
• This command must only be called outside of a video coding scope
• commandBuffer must be a primary VkCommandBuffer

Host Synchronization

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

Command Properties

Command Buffer Levels	Render Pass Scope	Video Coding Scope	Supported Queue Types	Command Type
Primary	Both	Outside	Graphics Compute	Action

See Also

VkDispatchGraphCountInfoAMDX

Parameters:

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

scratch - the address of scratch memory to be used.

scratchSize - a range in bytes of scratch memory to be used.

pCountInfo - a host pointer to a VkDispatchGraphCountInfoAMDX structure defining the nodes which will be initially executed.

nvkCmdDispatchGraphIndirectAMDX

public static void nvkCmdDispatchGraphIndirectAMDX(org.lwjgl.vulkan.VkCommandBuffer commandBuffer,
 long scratch,
 long scratchSize,
 long pCountInfo)

Unsafe version of: CmdDispatchGraphIndirectAMDX

vkCmdDispatchGraphIndirectAMDX

public static void vkCmdDispatchGraphIndirectAMDX(org.lwjgl.vulkan.VkCommandBuffer commandBuffer,
 long scratch,
 long scratchSize,
 VkDispatchGraphCountInfoAMDX pCountInfo)

Dispatch an execution graph with node and payload parameters read on the device.

C Specification

To record an execution graph dispatch with node and payload parameters read on device, call:

 void vkCmdDispatchGraphIndirectAMDX(
     VkCommandBuffer                             commandBuffer,
     VkDeviceAddress                             scratch,
     VkDeviceSize                                scratchSize,
     const VkDispatchGraphCountInfoAMDX*         pCountInfo);

Description

When this command is executed, the nodes specified in pCountInfo are executed. Nodes executed as part of this command are not implicitly synchronized in any way against each other once they are dispatched. There are no rasterization order guarantees between separately dispatched graphics nodes, though individual primitives within a single dispatch do adhere to rasterization order. Draw calls executed before or after the execution graph also execute relative to each graphics node with respect to rasterization order.

For this command, all device/host pointers in substructures are treated as device pointers and read during device execution of this command. The allocation and contents of these pointers only needs to be valid during device execution. All of these addresses will be read in the PIPELINE_STAGE_2_COMPUTE_SHADER_BIT pipeline stage with the ACCESS_2_SHADER_STORAGE_READ_BIT access flag.

Execution of this command may modify any memory locations in the range [scratch,scratch + scratchSize). Accesses to this memory range are performed in the PIPELINE_STAGE_2_COMPUTE_SHADER_BIT pipeline stage with the ACCESS_2_SHADER_STORAGE_READ_BIT and ACCESS_2_SHADER_STORAGE_WRITE_BIT access flags.

This command captures command buffer state for mesh nodes similarly to draw commands.

Valid Usage

• If a VkSampler created with magFilter or minFilter equal to FILTER_LINEAR, reductionMode equal to SAMPLER_REDUCTION_MODE_WEIGHTED_AVERAGE, and compareEnable equal to FALSE is used to sample a VkImageView as a result of this command, then the image view’s format features must contain FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT
• If a VkSampler created with magFilter or minFilter equal to FILTER_LINEAR and reductionMode equal to either SAMPLER_REDUCTION_MODE_MIN or SAMPLER_REDUCTION_MODE_MAX is used to sample a VkImageView as a result of this command, then the image view’s format features must contain FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_MINMAX_BIT
• If a VkSampler created with mipmapMode equal to SAMPLER_MIPMAP_MODE_LINEAR, reductionMode equal to SAMPLER_REDUCTION_MODE_WEIGHTED_AVERAGE, and compareEnable equal to FALSE is used to sample a VkImageView as a result of this command, then the image view’s format features must contain FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT
• If a VkSampler created with mipmapMode equal to SAMPLER_MIPMAP_MODE_LINEAR and reductionMode equal to either SAMPLER_REDUCTION_MODE_MIN or SAMPLER_REDUCTION_MODE_MAX is used to sample a VkImageView as a result of this command, then the image view’s format features must contain FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_MINMAX_BIT
• If a VkSampler created with unnormalizedCoordinates equal to TRUE is used to sample a VkImageView as a result of this command, then the image view’s levelCount and layerCount must be 1
• If a VkSampler created with unnormalizedCoordinates equal to TRUE is used to sample a VkImageView as a result of this command, then the image view’s viewType must be IMAGE_VIEW_TYPE_1D or IMAGE_VIEW_TYPE_2D
• If a VkSampler created with unnormalizedCoordinates equal to TRUE is used to sample a VkImageView as a result of this command, then the sampler must not be used with any of the SPIR-V OpImageSample* or OpImageSparseSample* instructions with ImplicitLod, Dref or Proj in their name
• If a VkSampler created with unnormalizedCoordinates equal to TRUE is used to sample a VkImageView as a result of this command, then the sampler must not be used with any of the SPIR-V OpImageSample* or OpImageSparseSample* instructions that includes a LOD bias or any offset values
• If a VkImageView is sampled with depth comparison, the image view’s format features must contain FORMAT_FEATURE_2_SAMPLED_IMAGE_DEPTH_COMPARISON_BIT
• If a VkImageView is accessed using atomic operations as a result of this command, then the image view’s format features must contain FORMAT_FEATURE_STORAGE_IMAGE_ATOMIC_BIT
• If a DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER descriptor is accessed using atomic operations as a result of this command, then the storage texel buffer’s format features must contain FORMAT_FEATURE_STORAGE_TEXEL_BUFFER_ATOMIC_BIT
• If a VkImageView is sampled with FILTER_CUBIC_EXT as a result of this command, then the image view’s format features must contain FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_EXT
• If the VK_EXT_filter_cubic extension is not enabled and any VkImageView is sampled with FILTER_CUBIC_EXT as a result of this command, it must not have a VkImageViewType of IMAGE_VIEW_TYPE_3D, IMAGE_VIEW_TYPE_CUBE, or IMAGE_VIEW_TYPE_CUBE_ARRAY
• Any VkImageView being sampled with FILTER_CUBIC_EXT as a result of this command must have a VkImageViewType and format that supports cubic filtering, as specified by VkFilterCubicImageViewImageFormatPropertiesEXT::filterCubic returned by GetPhysicalDeviceImageFormatProperties2
• Any VkImageView being sampled with FILTER_CUBIC_EXT with a reduction mode of either SAMPLER_REDUCTION_MODE_MIN or SAMPLER_REDUCTION_MODE_MAX as a result of this command must have a VkImageViewType and format that supports cubic filtering together with minmax filtering, as specified by VkFilterCubicImageViewImageFormatPropertiesEXT::filterCubicMinmax returned by GetPhysicalDeviceImageFormatProperties2
• If the cubicRangeClamp feature is not enabled, then any VkImageView being sampled with FILTER_CUBIC_EXT as a result of this command must not have a VkSamplerReductionModeCreateInfo::reductionMode equal to SAMPLER_REDUCTION_MODE_WEIGHTED_AVERAGE_RANGECLAMP_QCOM
• Any VkImageView being sampled with a VkSamplerReductionModeCreateInfo::reductionMode equal to SAMPLER_REDUCTION_MODE_WEIGHTED_AVERAGE_RANGECLAMP_QCOM as a result of this command must sample with FILTER_CUBIC_EXT
• If the selectableCubicWeights feature is not enabled, then any VkImageView being sampled with FILTER_CUBIC_EXT as a result of this command must have VkSamplerCubicWeightsCreateInfoQCOM::cubicWeights equal to CUBIC_FILTER_WEIGHTS_CATMULL_ROM_QCOM
• Any VkImage created with a VkImageCreateInfo::flags containing IMAGE_CREATE_CORNER_SAMPLED_BIT_NV sampled as a result of this command must only be sampled using a VkSamplerAddressMode of SAMPLER_ADDRESS_MODE_CLAMP_TO_EDGE
• For any VkImageView being written as a storage image where the image format field of the OpTypeImage is Unknown, the view’s format features must contain FORMAT_FEATURE_2_STORAGE_WRITE_WITHOUT_FORMAT_BIT
• For any VkImageView being read as a storage image where the image format field of the OpTypeImage is Unknown, the view’s format features must contain FORMAT_FEATURE_2_STORAGE_READ_WITHOUT_FORMAT_BIT
• For any VkBufferView being written as a storage texel buffer where the image format field of the OpTypeImage is Unknown, the view’s buffer features must contain FORMAT_FEATURE_2_STORAGE_WRITE_WITHOUT_FORMAT_BIT
• Any VkBufferView being read as a storage texel buffer where the image format field of the OpTypeImage is Unknown then the view’s buffer features must contain FORMAT_FEATURE_2_STORAGE_READ_WITHOUT_FORMAT_BIT
• For each set n that is statically used by a bound shader, a descriptor set must have been bound to n at the same pipeline bind point, with a VkPipelineLayout that is compatible for set n, with the VkPipelineLayout used to create the current VkPipeline or the VkDescriptorSetLayout array used to create the current VkShaderEXT , as described in Pipeline Layout Compatibility
• For each push constant that is statically used by a bound shader, a push constant value must have been set for the same pipeline bind point, with a VkPipelineLayout that is compatible for push constants, with the VkPipelineLayout used to create the current VkPipeline or the VkDescriptorSetLayout array used to create the current VkShaderEXT , as described in Pipeline Layout Compatibility
• For each array of resources that is used by a bound shader, the indices used to access members of the array must be less than the descriptor count for the identified binding in the descriptor sets used by this command
• If the maintenance4 feature is not enabled, then for each push constant that is statically used by a bound shader, a push constant value must have been set for the same pipeline bind point, with a VkPipelineLayout that is compatible for push constants, with the VkPipelineLayout used to create the current VkPipeline or the VkDescriptorSetLayout and VkPushConstantRange arrays used to create the current VkShaderEXT , as described in Pipeline Layout Compatibility
• Descriptors in each bound descriptor set, specified via CmdBindDescriptorSets, must be valid as described by descriptor validity if they are statically used by the VkPipeline bound to the pipeline bind point used by this command and the bound VkPipeline was not created with PIPELINE_CREATE_DESCRIPTOR_BUFFER_BIT_EXT
• If the descriptors used by the VkPipeline bound to the pipeline bind point were specified via CmdBindDescriptorSets, the bound VkPipeline must have been created without PIPELINE_CREATE_DESCRIPTOR_BUFFER_BIT_EXT
• Descriptors in bound descriptor buffers, specified via CmdSetDescriptorBufferOffsetsEXT, must be valid if they are dynamically used by the VkPipeline bound to the pipeline bind point used by this command and the bound VkPipeline was created with PIPELINE_CREATE_DESCRIPTOR_BUFFER_BIT_EXT
• Descriptors in bound descriptor buffers, specified via CmdSetDescriptorBufferOffsetsEXT, must be valid if they are dynamically used by any VkShaderEXT bound to a stage corresponding to the pipeline bind point used by this command
• If the descriptors used by the VkPipeline bound to the pipeline bind point were specified via CmdSetDescriptorBufferOffsetsEXT, the bound VkPipeline must have been created with PIPELINE_CREATE_DESCRIPTOR_BUFFER_BIT_EXT
• If a descriptor is dynamically used with a VkPipeline created with PIPELINE_CREATE_DESCRIPTOR_BUFFER_BIT_EXT, the descriptor memory must be resident
• If a descriptor is dynamically used with a VkShaderEXT created with a VkDescriptorSetLayout that was created with DESCRIPTOR_SET_LAYOUT_CREATE_DESCRIPTOR_BUFFER_BIT_EXT, the descriptor memory must be resident
• If the shaderObject feature is not enabled, a valid pipeline must be bound to the pipeline bind point used by this command
• If a pipeline is bound to the pipeline bind point used by this command, there must not have been any calls to dynamic state setting commands for any state specified statically in the VkPipeline object bound to the pipeline bind point used by this command, since that pipeline was bound
• If the shaderObject feature is enabled, either a valid pipeline must be bound to the pipeline bind point used by this command, or a valid combination of valid and NULL_HANDLE shader objects must be bound to every supported shader stage corresponding to the pipeline bind point used by this command
• If any stage of the VkPipeline object bound to the pipeline bind point used by this command accesses a uniform buffer, and that stage was created without enabling either PIPELINE_ROBUSTNESS_BUFFER_BEHAVIOR_ROBUST_BUFFER_ACCESS or PIPELINE_ROBUSTNESS_BUFFER_BEHAVIOR_ROBUST_BUFFER_ACCESS_2 for uniformBuffers, and the robustBufferAccess feature is not enabled, that stage must not access values outside of the range of the buffer as specified in the descriptor set bound to the same pipeline bind point
• If the robustBufferAccess feature is not enabled, and any VkShaderEXT bound to a stage corresponding to the pipeline bind point used by this command accesses a uniform buffer, it must not access values outside of the range of the buffer as specified in the descriptor set bound to the same pipeline bind point
• If any stage of the VkPipeline object bound to the pipeline bind point used by this command accesses a storage buffer, and that stage was created without enabling either PIPELINE_ROBUSTNESS_BUFFER_BEHAVIOR_ROBUST_BUFFER_ACCESS or PIPELINE_ROBUSTNESS_BUFFER_BEHAVIOR_ROBUST_BUFFER_ACCESS_2 for storageBuffers, and the robustBufferAccess feature is not enabled, that stage must not access values outside of the range of the buffer as specified in the descriptor set bound to the same pipeline bind point
• If the robustBufferAccess feature is not enabled, and any VkShaderEXT bound to a stage corresponding to the pipeline bind point used by this command accesses a storage buffer, it must not access values outside of the range of the buffer as specified in the descriptor set bound to the same pipeline bind point
• If commandBuffer is an unprotected command buffer and protectedNoFault is not supported, any resource accessed by bound shaders must not be a protected resource
• If a bound shader accesses a VkSampler or VkImageView object that enables sampler Y′C_BC_R conversion, that object must only be used with OpImageSample* or OpImageSparseSample* instructions
• If a bound shader accesses a VkSampler or VkImageView object that enables sampler Y′C_BC_R conversion, that object must not use the ConstOffset and Offset operands
• If a VkImageView is accessed as a result of this command, then the image view’s viewType must match the Dim operand of the OpTypeImage as described in Compatibility Between SPIR-V Image Dimensions and Vulkan ImageView Types
• If a VkImageView is accessed as a result of this command, then the numeric type of the image view’s format and the Sampled Type operand of the OpTypeImage must match
• If a VkImageView created with a format other than FORMAT_A8_UNORM is accessed using OpImageWrite as a result of this command, then the Type of the Texel operand of that instruction must have at least as many components as the image view’s format
• If a VkImageView created with the format FORMAT_A8_UNORM is accessed using OpImageWrite as a result of this command, then the Type of the Texel operand of that instruction must have four components
• If a VkBufferView is accessed using OpImageWrite as a result of this command, then the Type of the Texel operand of that instruction must have at least as many components as the buffer view’s format
• If a VkImageView with a VkFormat that has a 64-bit component width is accessed as a result of this command, the SampledType of the OpTypeImage operand of that instruction must have a Width of 64
• If a VkImageView with a VkFormat that has a component width less than 64-bit is accessed as a result of this command, the SampledType of the OpTypeImage operand of that instruction must have a Width of 32
• If a VkBufferView with a VkFormat that has a 64-bit component width is accessed as a result of this command, the SampledType of the OpTypeImage operand of that instruction must have a Width of 64
• If a VkBufferView with a VkFormat that has a component width less than 64-bit is accessed as a result of this command, the SampledType of the OpTypeImage operand of that instruction must have a Width of 32
• If the sparseImageInt64Atomics feature is not enabled, VkImage objects created with the IMAGE_CREATE_SPARSE_RESIDENCY_BIT flag must not be accessed by atomic instructions through an OpTypeImage with a SampledType with a Width of 64 by this command
• If the sparseImageInt64Atomics feature is not enabled, VkBuffer objects created with the BUFFER_CREATE_SPARSE_RESIDENCY_BIT flag must not be accessed by atomic instructions through an OpTypeImage with a SampledType with a Width of 64 by this command
• If OpImageWeightedSampleQCOM is used to sample a VkImageView as a result of this command, then the image view’s format features must contain FORMAT_FEATURE_2_WEIGHT_SAMPLED_IMAGE_BIT_QCOM
• If OpImageWeightedSampleQCOM uses a VkImageView as a sample weight image as a result of this command, then the image view’s format features must contain FORMAT_FEATURE_2_WEIGHT_IMAGE_BIT_QCOM
• If OpImageBoxFilterQCOM is used to sample a VkImageView as a result of this command, then the image view’s format features must contain FORMAT_FEATURE_2_BOX_FILTER_SAMPLED_BIT_QCOM
• If OpImageBlockMatchSSDQCOM is used to read from an VkImageView as a result of this command, then the image view’s format features must contain FORMAT_FEATURE_2_BLOCK_MATCHING_BIT_QCOM
• If OpImageBlockMatchSADQCOM is used to read from an VkImageView as a result of this command, then the image view’s format features must contain FORMAT_FEATURE_2_BLOCK_MATCHING_BIT_QCOM
• If OpImageBlockMatchSADQCOM or OpImageBlockMatchSSDQCOM is used to read from a reference image as result of this command, then the specified reference coordinates must not fail integer texel coordinate validation
• If OpImageWeightedSampleQCOM, OpImageBoxFilterQCOM, OpImageBlockMatchWindowSSDQCOM, OpImageBlockMatchWindowSADQCOM, OpImageBlockMatchGatherSSDQCOM, OpImageBlockMatchGatherSADQCOM, OpImageBlockMatchSSDQCOM, or OpImageBlockMatchSADQCOM uses a VkSampler as a result of this command, then the sampler must have been created with SAMPLER_CREATE_IMAGE_PROCESSING_BIT_QCOM
• If any command other than OpImageWeightedSampleQCOM, OpImageBoxFilterQCOM, OpImageBlockMatchWindowSSDQCOM, OpImageBlockMatchWindowSADQCOM, OpImageBlockMatchGatherSSDQCOM, OpImageBlockMatchGatherSADQCOM, OpImageBlockMatchSSDQCOM, or OpImageBlockMatchSADQCOM uses a VkSampler as a result of this command, then the sampler must not have been created with SAMPLER_CREATE_IMAGE_PROCESSING_BIT_QCOM
• If a OpImageBlockMatchWindow*QCOM or OpImageBlockMatchGather*QCOM instruction is used to read from an VkImageView as a result of this command, then the image view’s format features must contain FORMAT_FEATURE_2_BLOCK_MATCHING_BIT_QCOM
• If a OpImageBlockMatchWindow*QCOM or OpImageBlockMatchGather*QCOM instruction is used to read from an VkImageView as a result of this command, then the image view’s format must be a single-component format
• If a OpImageBlockMatchWindow*QCOM or OpImageBlockMatchGather*QCOM read from a reference image as result of this command, then the specified reference coordinates must not fail integer texel coordinate validation
• Any shader invocation executed by this command must terminate
• If a descriptor with type equal to any of DESCRIPTOR_TYPE_SAMPLE_WEIGHT_IMAGE_QCOM, DESCRIPTOR_TYPE_BLOCK_MATCH_IMAGE_QCOM, DESCRIPTOR_TYPE_SAMPLED_IMAGE, DESCRIPTOR_TYPE_STORAGE_IMAGE, or DESCRIPTOR_TYPE_INPUT_ATTACHMENT is accessed as a result of this command, the image subresource identified by that descriptor must be in the image layout identified when the descriptor was written
• commandBuffer must not be a protected command buffer
• commandBuffer must be a primary command buffer
• scratch must be the device address of an allocated memory range at least as large as scratchSize
• scratchSize must be greater than or equal to VkExecutionGraphPipelineScratchSizeAMDX::minSize returned by GetExecutionGraphPipelineScratchSizeAMDX for the bound execution graph pipeline
• scratch must be a device address within a VkBuffer created with the BUFFER_USAGE_EXECUTION_GRAPH_SCRATCH_BIT_AMDX or BUFFER_USAGE_2_EXECUTION_GRAPH_SCRATCH_BIT_AMDX flag
• The device memory range [scratch,scratch scratchSize] must have been initialized with CmdInitializeGraphScratchMemoryAMDX using the bound execution graph pipeline, and not modified after that by anything other than another execution graph dispatch command
• Execution of this command must not cause a node to be dispatched with a larger number of workgroups than that specified by either a MaxNumWorkgroupsAMDX decoration in the dispatched node or maxComputeWorkGroupCount
• Execution of this command must not cause any shader to initialize more than maxExecutionGraphShaderPayloadCount output payloads
• Execution of this command must not cause any shader that declares NodeMaxPayloadsAMDX to initialize more output payloads than specified by the max number of payloads for that decoration. This requirement applies to each NodeMaxPayloadsAMDX decoration separately
• If the bound execution graph pipeline includes draw nodes, this command must be called within a render pass instance that is compatible with the graphics pipeline used to create each of those nodes
• pCountInfo→infos must be a device pointer to a memory allocation at least as large as the product of count and stride when this command is executed on the device
• pCountInfo→infos must be a device address within a VkBuffer created with the BUFFER_USAGE_INDIRECT_BUFFER_BIT flag
• pCountInfo→infos must be a multiple of executionGraphDispatchAddressAlignment
• Device memory locations at indexes in the range [infos, infos + (count*stride)), at a granularity of stride must contain valid VkDispatchGraphInfoAMDX structures in the first 24 bytes when this command is executed on the device
• For each VkDispatchGraphInfoAMDX structure in pCountInfo→infos, payloads must be a device pointer to a memory allocation at least as large as the product of payloadCount and payloadStride when this command is executed on the device
• For each VkDispatchGraphInfoAMDX structure in pCountInfo→infos, payloads must be a device address within a VkBuffer created with the BUFFER_USAGE_INDIRECT_BUFFER_BIT flag
• For each VkDispatchGraphInfoAMDX structure in pCountInfo→infos, payloads must be a multiple of executionGraphDispatchAddressAlignment
• For each VkDispatchGraphInfoAMDX structure in pCountInfo→infos, nodeIndex must be a valid node index in the bound execution graph pipeline, as returned by GetExecutionGraphPipelineNodeIndexAMDX when this command is executed on the device
• For each VkDispatchGraphInfoAMDX structure in pCountInfo→infos, device memory locations at indexes in the range [payloads, payloads + (payloadCount * payloadStride)), at a granularity of payloadStride must contain a payload matching the size of the input payload expected by the node in nodeIndex in the first bytes when this command is executed on the device

Valid Usage (Implicit)

• commandBuffer must be a valid VkCommandBuffer handle
• pCountInfo must be a valid pointer to a valid VkDispatchGraphCountInfoAMDX structure
• commandBuffer must be in the recording state
• The VkCommandPool that commandBuffer was allocated from must support graphics, or compute operations
• This command must only be called outside of a video coding scope
• commandBuffer must be a primary VkCommandBuffer

Host Synchronization

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

Command Properties

Command Buffer Levels	Render Pass Scope	Video Coding Scope	Supported Queue Types	Command Type
Primary	Both	Outside	Graphics Compute	Action

See Also

VkDispatchGraphCountInfoAMDX

Parameters:

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

scratch - the address of scratch memory to be used.

scratchSize - a range in bytes of scratch memory to be used.

pCountInfo - a host pointer to a VkDispatchGraphCountInfoAMDX structure defining the nodes which will be initially executed.

vkCmdDispatchGraphIndirectCountAMDX

public static void vkCmdDispatchGraphIndirectCountAMDX(org.lwjgl.vulkan.VkCommandBuffer commandBuffer,
 long scratch,
 long scratchSize,
 long countInfo)

Dispatch an execution graph with all parameters read on the device.

C Specification

To record an execution graph dispatch with all parameters read on device, call:

 void vkCmdDispatchGraphIndirectCountAMDX(
     VkCommandBuffer                             commandBuffer,
     VkDeviceAddress                             scratch,
     VkDeviceSize                                scratchSize,
     VkDeviceAddress                             countInfo);

Description

When this command is executed, the nodes specified in countInfo are executed. Nodes executed as part of this command are not implicitly synchronized in any way against each other once they are dispatched.

For this command, all pointers in substructures are treated as device pointers and read during device execution of this command. The allocation and contents of these pointers only needs to be valid during device execution. All of these addresses will be read in the PIPELINE_STAGE_2_COMPUTE_SHADER_BIT pipeline stage with the ACCESS_2_SHADER_STORAGE_READ_BIT access flag.

Execution of this command may modify any memory locations in the range [scratch,scratch + scratchSize). Accesses to this memory range are performed in the PIPELINE_STAGE_2_COMPUTE_SHADER_BIT pipeline stage with the ACCESS_2_SHADER_STORAGE_READ_BIT and ACCESS_2_SHADER_STORAGE_WRITE_BIT access flags.

Valid Usage

• If a VkSampler created with magFilter or minFilter equal to FILTER_LINEAR, reductionMode equal to SAMPLER_REDUCTION_MODE_WEIGHTED_AVERAGE, and compareEnable equal to FALSE is used to sample a VkImageView as a result of this command, then the image view’s format features must contain FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT
• If a VkSampler created with magFilter or minFilter equal to FILTER_LINEAR and reductionMode equal to either SAMPLER_REDUCTION_MODE_MIN or SAMPLER_REDUCTION_MODE_MAX is used to sample a VkImageView as a result of this command, then the image view’s format features must contain FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_MINMAX_BIT
• If a VkSampler created with mipmapMode equal to SAMPLER_MIPMAP_MODE_LINEAR, reductionMode equal to SAMPLER_REDUCTION_MODE_WEIGHTED_AVERAGE, and compareEnable equal to FALSE is used to sample a VkImageView as a result of this command, then the image view’s format features must contain FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT
• If a VkSampler created with mipmapMode equal to SAMPLER_MIPMAP_MODE_LINEAR and reductionMode equal to either SAMPLER_REDUCTION_MODE_MIN or SAMPLER_REDUCTION_MODE_MAX is used to sample a VkImageView as a result of this command, then the image view’s format features must contain FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_MINMAX_BIT
• If a VkSampler created with unnormalizedCoordinates equal to TRUE is used to sample a VkImageView as a result of this command, then the image view’s levelCount and layerCount must be 1
• If a VkSampler created with unnormalizedCoordinates equal to TRUE is used to sample a VkImageView as a result of this command, then the image view’s viewType must be IMAGE_VIEW_TYPE_1D or IMAGE_VIEW_TYPE_2D
• If a VkSampler created with unnormalizedCoordinates equal to TRUE is used to sample a VkImageView as a result of this command, then the sampler must not be used with any of the SPIR-V OpImageSample* or OpImageSparseSample* instructions with ImplicitLod, Dref or Proj in their name
• If a VkSampler created with unnormalizedCoordinates equal to TRUE is used to sample a VkImageView as a result of this command, then the sampler must not be used with any of the SPIR-V OpImageSample* or OpImageSparseSample* instructions that includes a LOD bias or any offset values
• If a VkImageView is sampled with depth comparison, the image view’s format features must contain FORMAT_FEATURE_2_SAMPLED_IMAGE_DEPTH_COMPARISON_BIT
• If a VkImageView is accessed using atomic operations as a result of this command, then the image view’s format features must contain FORMAT_FEATURE_STORAGE_IMAGE_ATOMIC_BIT
• If a DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER descriptor is accessed using atomic operations as a result of this command, then the storage texel buffer’s format features must contain FORMAT_FEATURE_STORAGE_TEXEL_BUFFER_ATOMIC_BIT
• If a VkImageView is sampled with FILTER_CUBIC_EXT as a result of this command, then the image view’s format features must contain FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_EXT
• If the VK_EXT_filter_cubic extension is not enabled and any VkImageView is sampled with FILTER_CUBIC_EXT as a result of this command, it must not have a VkImageViewType of IMAGE_VIEW_TYPE_3D, IMAGE_VIEW_TYPE_CUBE, or IMAGE_VIEW_TYPE_CUBE_ARRAY
• Any VkImageView being sampled with FILTER_CUBIC_EXT as a result of this command must have a VkImageViewType and format that supports cubic filtering, as specified by VkFilterCubicImageViewImageFormatPropertiesEXT::filterCubic returned by GetPhysicalDeviceImageFormatProperties2
• Any VkImageView being sampled with FILTER_CUBIC_EXT with a reduction mode of either SAMPLER_REDUCTION_MODE_MIN or SAMPLER_REDUCTION_MODE_MAX as a result of this command must have a VkImageViewType and format that supports cubic filtering together with minmax filtering, as specified by VkFilterCubicImageViewImageFormatPropertiesEXT::filterCubicMinmax returned by GetPhysicalDeviceImageFormatProperties2
• If the cubicRangeClamp feature is not enabled, then any VkImageView being sampled with FILTER_CUBIC_EXT as a result of this command must not have a VkSamplerReductionModeCreateInfo::reductionMode equal to SAMPLER_REDUCTION_MODE_WEIGHTED_AVERAGE_RANGECLAMP_QCOM
• Any VkImageView being sampled with a VkSamplerReductionModeCreateInfo::reductionMode equal to SAMPLER_REDUCTION_MODE_WEIGHTED_AVERAGE_RANGECLAMP_QCOM as a result of this command must sample with FILTER_CUBIC_EXT
• If the selectableCubicWeights feature is not enabled, then any VkImageView being sampled with FILTER_CUBIC_EXT as a result of this command must have VkSamplerCubicWeightsCreateInfoQCOM::cubicWeights equal to CUBIC_FILTER_WEIGHTS_CATMULL_ROM_QCOM
• Any VkImage created with a VkImageCreateInfo::flags containing IMAGE_CREATE_CORNER_SAMPLED_BIT_NV sampled as a result of this command must only be sampled using a VkSamplerAddressMode of SAMPLER_ADDRESS_MODE_CLAMP_TO_EDGE
• For any VkImageView being written as a storage image where the image format field of the OpTypeImage is Unknown, the view’s format features must contain FORMAT_FEATURE_2_STORAGE_WRITE_WITHOUT_FORMAT_BIT
• For any VkImageView being read as a storage image where the image format field of the OpTypeImage is Unknown, the view’s format features must contain FORMAT_FEATURE_2_STORAGE_READ_WITHOUT_FORMAT_BIT
• For any VkBufferView being written as a storage texel buffer where the image format field of the OpTypeImage is Unknown, the view’s buffer features must contain FORMAT_FEATURE_2_STORAGE_WRITE_WITHOUT_FORMAT_BIT
• Any VkBufferView being read as a storage texel buffer where the image format field of the OpTypeImage is Unknown then the view’s buffer features must contain FORMAT_FEATURE_2_STORAGE_READ_WITHOUT_FORMAT_BIT
• For each set n that is statically used by a bound shader, a descriptor set must have been bound to n at the same pipeline bind point, with a VkPipelineLayout that is compatible for set n, with the VkPipelineLayout used to create the current VkPipeline or the VkDescriptorSetLayout array used to create the current VkShaderEXT , as described in Pipeline Layout Compatibility
• For each push constant that is statically used by a bound shader, a push constant value must have been set for the same pipeline bind point, with a VkPipelineLayout that is compatible for push constants, with the VkPipelineLayout used to create the current VkPipeline or the VkDescriptorSetLayout array used to create the current VkShaderEXT , as described in Pipeline Layout Compatibility
• For each array of resources that is used by a bound shader, the indices used to access members of the array must be less than the descriptor count for the identified binding in the descriptor sets used by this command
• If the maintenance4 feature is not enabled, then for each push constant that is statically used by a bound shader, a push constant value must have been set for the same pipeline bind point, with a VkPipelineLayout that is compatible for push constants, with the VkPipelineLayout used to create the current VkPipeline or the VkDescriptorSetLayout and VkPushConstantRange arrays used to create the current VkShaderEXT , as described in Pipeline Layout Compatibility
• Descriptors in each bound descriptor set, specified via CmdBindDescriptorSets, must be valid as described by descriptor validity if they are statically used by the VkPipeline bound to the pipeline bind point used by this command and the bound VkPipeline was not created with PIPELINE_CREATE_DESCRIPTOR_BUFFER_BIT_EXT
• If the descriptors used by the VkPipeline bound to the pipeline bind point were specified via CmdBindDescriptorSets, the bound VkPipeline must have been created without PIPELINE_CREATE_DESCRIPTOR_BUFFER_BIT_EXT
• Descriptors in bound descriptor buffers, specified via CmdSetDescriptorBufferOffsetsEXT, must be valid if they are dynamically used by the VkPipeline bound to the pipeline bind point used by this command and the bound VkPipeline was created with PIPELINE_CREATE_DESCRIPTOR_BUFFER_BIT_EXT
• Descriptors in bound descriptor buffers, specified via CmdSetDescriptorBufferOffsetsEXT, must be valid if they are dynamically used by any VkShaderEXT bound to a stage corresponding to the pipeline bind point used by this command
• If the descriptors used by the VkPipeline bound to the pipeline bind point were specified via CmdSetDescriptorBufferOffsetsEXT, the bound VkPipeline must have been created with PIPELINE_CREATE_DESCRIPTOR_BUFFER_BIT_EXT
• If a descriptor is dynamically used with a VkPipeline created with PIPELINE_CREATE_DESCRIPTOR_BUFFER_BIT_EXT, the descriptor memory must be resident
• If a descriptor is dynamically used with a VkShaderEXT created with a VkDescriptorSetLayout that was created with DESCRIPTOR_SET_LAYOUT_CREATE_DESCRIPTOR_BUFFER_BIT_EXT, the descriptor memory must be resident
• If the shaderObject feature is not enabled, a valid pipeline must be bound to the pipeline bind point used by this command
• If a pipeline is bound to the pipeline bind point used by this command, there must not have been any calls to dynamic state setting commands for any state specified statically in the VkPipeline object bound to the pipeline bind point used by this command, since that pipeline was bound
• If the shaderObject feature is enabled, either a valid pipeline must be bound to the pipeline bind point used by this command, or a valid combination of valid and NULL_HANDLE shader objects must be bound to every supported shader stage corresponding to the pipeline bind point used by this command
• If any stage of the VkPipeline object bound to the pipeline bind point used by this command accesses a uniform buffer, and that stage was created without enabling either PIPELINE_ROBUSTNESS_BUFFER_BEHAVIOR_ROBUST_BUFFER_ACCESS or PIPELINE_ROBUSTNESS_BUFFER_BEHAVIOR_ROBUST_BUFFER_ACCESS_2 for uniformBuffers, and the robustBufferAccess feature is not enabled, that stage must not access values outside of the range of the buffer as specified in the descriptor set bound to the same pipeline bind point
• If the robustBufferAccess feature is not enabled, and any VkShaderEXT bound to a stage corresponding to the pipeline bind point used by this command accesses a uniform buffer, it must not access values outside of the range of the buffer as specified in the descriptor set bound to the same pipeline bind point
• If any stage of the VkPipeline object bound to the pipeline bind point used by this command accesses a storage buffer, and that stage was created without enabling either PIPELINE_ROBUSTNESS_BUFFER_BEHAVIOR_ROBUST_BUFFER_ACCESS or PIPELINE_ROBUSTNESS_BUFFER_BEHAVIOR_ROBUST_BUFFER_ACCESS_2 for storageBuffers, and the robustBufferAccess feature is not enabled, that stage must not access values outside of the range of the buffer as specified in the descriptor set bound to the same pipeline bind point
• If the robustBufferAccess feature is not enabled, and any VkShaderEXT bound to a stage corresponding to the pipeline bind point used by this command accesses a storage buffer, it must not access values outside of the range of the buffer as specified in the descriptor set bound to the same pipeline bind point
• If commandBuffer is an unprotected command buffer and protectedNoFault is not supported, any resource accessed by bound shaders must not be a protected resource
• If a bound shader accesses a VkSampler or VkImageView object that enables sampler Y′C_BC_R conversion, that object must only be used with OpImageSample* or OpImageSparseSample* instructions
• If a bound shader accesses a VkSampler or VkImageView object that enables sampler Y′C_BC_R conversion, that object must not use the ConstOffset and Offset operands
• If a VkImageView is accessed as a result of this command, then the image view’s viewType must match the Dim operand of the OpTypeImage as described in Compatibility Between SPIR-V Image Dimensions and Vulkan ImageView Types
• If a VkImageView is accessed as a result of this command, then the numeric type of the image view’s format and the Sampled Type operand of the OpTypeImage must match
• If a VkImageView created with a format other than FORMAT_A8_UNORM is accessed using OpImageWrite as a result of this command, then the Type of the Texel operand of that instruction must have at least as many components as the image view’s format
• If a VkImageView created with the format FORMAT_A8_UNORM is accessed using OpImageWrite as a result of this command, then the Type of the Texel operand of that instruction must have four components
• If a VkBufferView is accessed using OpImageWrite as a result of this command, then the Type of the Texel operand of that instruction must have at least as many components as the buffer view’s format
• If a VkImageView with a VkFormat that has a 64-bit component width is accessed as a result of this command, the SampledType of the OpTypeImage operand of that instruction must have a Width of 64
• If a VkImageView with a VkFormat that has a component width less than 64-bit is accessed as a result of this command, the SampledType of the OpTypeImage operand of that instruction must have a Width of 32
• If a VkBufferView with a VkFormat that has a 64-bit component width is accessed as a result of this command, the SampledType of the OpTypeImage operand of that instruction must have a Width of 64
• If a VkBufferView with a VkFormat that has a component width less than 64-bit is accessed as a result of this command, the SampledType of the OpTypeImage operand of that instruction must have a Width of 32
• If the sparseImageInt64Atomics feature is not enabled, VkImage objects created with the IMAGE_CREATE_SPARSE_RESIDENCY_BIT flag must not be accessed by atomic instructions through an OpTypeImage with a SampledType with a Width of 64 by this command
• If the sparseImageInt64Atomics feature is not enabled, VkBuffer objects created with the BUFFER_CREATE_SPARSE_RESIDENCY_BIT flag must not be accessed by atomic instructions through an OpTypeImage with a SampledType with a Width of 64 by this command
• If OpImageWeightedSampleQCOM is used to sample a VkImageView as a result of this command, then the image view’s format features must contain FORMAT_FEATURE_2_WEIGHT_SAMPLED_IMAGE_BIT_QCOM
• If OpImageWeightedSampleQCOM uses a VkImageView as a sample weight image as a result of this command, then the image view’s format features must contain FORMAT_FEATURE_2_WEIGHT_IMAGE_BIT_QCOM
• If OpImageBoxFilterQCOM is used to sample a VkImageView as a result of this command, then the image view’s format features must contain FORMAT_FEATURE_2_BOX_FILTER_SAMPLED_BIT_QCOM
• If OpImageBlockMatchSSDQCOM is used to read from an VkImageView as a result of this command, then the image view’s format features must contain FORMAT_FEATURE_2_BLOCK_MATCHING_BIT_QCOM
• If OpImageBlockMatchSADQCOM is used to read from an VkImageView as a result of this command, then the image view’s format features must contain FORMAT_FEATURE_2_BLOCK_MATCHING_BIT_QCOM
• If OpImageBlockMatchSADQCOM or OpImageBlockMatchSSDQCOM is used to read from a reference image as result of this command, then the specified reference coordinates must not fail integer texel coordinate validation
• If OpImageWeightedSampleQCOM, OpImageBoxFilterQCOM, OpImageBlockMatchWindowSSDQCOM, OpImageBlockMatchWindowSADQCOM, OpImageBlockMatchGatherSSDQCOM, OpImageBlockMatchGatherSADQCOM, OpImageBlockMatchSSDQCOM, or OpImageBlockMatchSADQCOM uses a VkSampler as a result of this command, then the sampler must have been created with SAMPLER_CREATE_IMAGE_PROCESSING_BIT_QCOM
• If any command other than OpImageWeightedSampleQCOM, OpImageBoxFilterQCOM, OpImageBlockMatchWindowSSDQCOM, OpImageBlockMatchWindowSADQCOM, OpImageBlockMatchGatherSSDQCOM, OpImageBlockMatchGatherSADQCOM, OpImageBlockMatchSSDQCOM, or OpImageBlockMatchSADQCOM uses a VkSampler as a result of this command, then the sampler must not have been created with SAMPLER_CREATE_IMAGE_PROCESSING_BIT_QCOM
• If a OpImageBlockMatchWindow*QCOM or OpImageBlockMatchGather*QCOM instruction is used to read from an VkImageView as a result of this command, then the image view’s format features must contain FORMAT_FEATURE_2_BLOCK_MATCHING_BIT_QCOM
• If a OpImageBlockMatchWindow*QCOM or OpImageBlockMatchGather*QCOM instruction is used to read from an VkImageView as a result of this command, then the image view’s format must be a single-component format
• If a OpImageBlockMatchWindow*QCOM or OpImageBlockMatchGather*QCOM read from a reference image as result of this command, then the specified reference coordinates must not fail integer texel coordinate validation
• Any shader invocation executed by this command must terminate
• If a descriptor with type equal to any of DESCRIPTOR_TYPE_SAMPLE_WEIGHT_IMAGE_QCOM, DESCRIPTOR_TYPE_BLOCK_MATCH_IMAGE_QCOM, DESCRIPTOR_TYPE_SAMPLED_IMAGE, DESCRIPTOR_TYPE_STORAGE_IMAGE, or DESCRIPTOR_TYPE_INPUT_ATTACHMENT is accessed as a result of this command, the image subresource identified by that descriptor must be in the image layout identified when the descriptor was written
• commandBuffer must not be a protected command buffer
• commandBuffer must be a primary command buffer
• scratch must be the device address of an allocated memory range at least as large as scratchSize
• scratchSize must be greater than or equal to VkExecutionGraphPipelineScratchSizeAMDX::minSize returned by GetExecutionGraphPipelineScratchSizeAMDX for the bound execution graph pipeline
• scratch must be a device address within a VkBuffer created with the BUFFER_USAGE_EXECUTION_GRAPH_SCRATCH_BIT_AMDX or BUFFER_USAGE_2_EXECUTION_GRAPH_SCRATCH_BIT_AMDX flag
• The device memory range [scratch,scratch scratchSize] must have been initialized with CmdInitializeGraphScratchMemoryAMDX using the bound execution graph pipeline, and not modified after that by anything other than another execution graph dispatch command
• Execution of this command must not cause a node to be dispatched with a larger number of workgroups than that specified by either a MaxNumWorkgroupsAMDX decoration in the dispatched node or maxComputeWorkGroupCount
• Execution of this command must not cause any shader to initialize more than maxExecutionGraphShaderPayloadCount output payloads
• Execution of this command must not cause any shader that declares NodeMaxPayloadsAMDX to initialize more output payloads than specified by the max number of payloads for that decoration. This requirement applies to each NodeMaxPayloadsAMDX decoration separately
• If the bound execution graph pipeline includes draw nodes, this command must be called within a render pass instance that is compatible with the graphics pipeline used to create each of those nodes
• countInfo must be a device pointer to a memory allocation containing a valid VkDispatchGraphCountInfoAMDX structure when this command is executed on the device
• countInfo must be a device address within a VkBuffer created with the BUFFER_USAGE_INDIRECT_BUFFER_BIT flag
• countInfo must be a multiple of executionGraphDispatchAddressAlignment
• countInfo→infos must be a device pointer to a memory allocation at least as large as the product of count and stride when this command is executed on the device
• countInfo→infos must be a device address within a VkBuffer created with the BUFFER_USAGE_INDIRECT_BUFFER_BIT flag
• countInfo→infos must be a multiple of executionGraphDispatchAddressAlignment
• Device memory locations at indexes in the range [infos, infos + (count*stride)), at a granularity of stride must contain valid VkDispatchGraphInfoAMDX structures in the first 24 bytes when this command is executed on the device
• For each VkDispatchGraphInfoAMDX structure in countInfo→infos, payloads must be a device pointer to a memory allocation at least as large as the product of payloadCount and payloadStride when this command is executed on the device
• For each VkDispatchGraphInfoAMDX structure in countInfo→infos, payloads must be a device address within a VkBuffer created with the BUFFER_USAGE_INDIRECT_BUFFER_BIT flag
• For each VkDispatchGraphInfoAMDX structure in countInfo→infos, payloads must be a multiple of executionGraphDispatchAddressAlignment
• For each VkDispatchGraphInfoAMDX structure in countInfo→infos, nodeIndex must be a valid node index in the bound execution graph pipeline, as returned by GetExecutionGraphPipelineNodeIndexAMDX when this command is executed on the device
• For each VkDispatchGraphInfoAMDX structure in countInfo→infos, device memory locations at indexes in the range [payloads, payloads + (payloadCount * payloadStride)), at a granularity of payloadStride must contain a payload matching the size of the input payload expected by the node in nodeIndex in the first bytes when this command is executed on the device

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
• This command must only be called outside of a video coding scope
• commandBuffer must be a primary VkCommandBuffer

Host Synchronization

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

Command Properties

Command Buffer Levels	Render Pass Scope	Video Coding Scope	Supported Queue Types	Command Type
Primary	Both	Outside	Graphics Compute	Action

Parameters:

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

scratch - the address of scratch memory to be used.

scratchSize - a range in bytes of scratch memory to be used.

countInfo - a device address of a VkDispatchGraphCountInfoAMDX structure defining the nodes which will be initially executed.

vkCreateExecutionGraphPipelinesAMDX

public static int vkCreateExecutionGraphPipelinesAMDX(org.lwjgl.vulkan.VkDevice device,
 long pipelineCache,
 VkExecutionGraphPipelineCreateInfoAMDX.Buffer pCreateInfos,
 @Nullable VkAllocationCallbacks pAllocator,
 long[] pPipelines)

Array version of: CreateExecutionGraphPipelinesAMDX

vkGetExecutionGraphPipelineNodeIndexAMDX

public static int vkGetExecutionGraphPipelineNodeIndexAMDX(org.lwjgl.vulkan.VkDevice device,
 long executionGraph,
 VkPipelineShaderStageNodeCreateInfoAMDX pNodeInfo,
 int[] pNodeIndex)

Array version of: GetExecutionGraphPipelineNodeIndexAMDX