C Specification
To record a dispatch, call:
// Provided by VK_VERSION_1_0
void vkCmdDispatch(
VkCommandBuffer commandBuffer,
uint32_t groupCountX,
uint32_t groupCountY,
uint32_t groupCountZ);
Parameters
-
commandBuffer
is the command buffer into which the command will be recorded. -
groupCountX
is the number of local workgroups to dispatch in the X dimension. -
groupCountY
is the number of local workgroups to dispatch in the Y dimension. -
groupCountZ
is the number of local workgroups to dispatch in the Z dimension.
Description
When the command is executed, a global workgroup consisting of
groupCountX
× groupCountY
× groupCountZ
local workgroups is assembled.
-
VUID-vkCmdDispatch-magFilter-04553
If a VkSampler created withmagFilter
orminFilter
equal toVK_FILTER_LINEAR
andcompareEnable
equal toVK_FALSE
is used to sample a VkImageView as a result of this command, then the image view’s format features must containVK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT
-
VUID-vkCmdDispatch-mipmapMode-04770
If a VkSampler created withmipmapMode
equal toVK_SAMPLER_MIPMAP_MODE_LINEAR
andcompareEnable
equal toVK_FALSE
is used to sample a VkImageView as a result of this command, then the image view’s format features must containVK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT
-
VUID-vkCmdDispatch-None-06479
If a VkImageView is sampled with depth comparison, the image view’s format features must containVK_FORMAT_FEATURE_2_SAMPLED_IMAGE_DEPTH_COMPARISON_BIT
-
VUID-vkCmdDispatch-None-02691
If aVkImageView
is accessed using atomic operations as a result of this command, then the image view’s format features must containVK_FORMAT_FEATURE_STORAGE_IMAGE_ATOMIC_BIT
-
VUID-vkCmdDispatch-None-02692
If aVkImageView
is sampled withVK_FILTER_CUBIC_EXT
as a result of this command, then the image view’s format features must containVK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_EXT
-
VUID-vkCmdDispatch-filterCubic-02694
Any VkImageView being sampled withVK_FILTER_CUBIC_EXT
as a result of this command must have a VkImageViewType and format that supports cubic filtering, as specified byVkFilterCubicImageViewImageFormatPropertiesEXT
::filterCubic
returned byvkGetPhysicalDeviceImageFormatProperties2
-
VUID-vkCmdDispatch-filterCubicMinmax-02695
Any VkImageView being sampled withVK_FILTER_CUBIC_EXT
with a reduction mode of eitherVK_SAMPLER_REDUCTION_MODE_MIN
orVK_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 byVkFilterCubicImageViewImageFormatPropertiesEXT
::filterCubicMinmax
returned byvkGetPhysicalDeviceImageFormatProperties2
-
VUID-vkCmdDispatch-flags-02696
Any VkImage created with a VkImageCreateInfo::flags
containingVK_IMAGE_CREATE_CORNER_SAMPLED_BIT_NV
sampled as a result of this command must only be sampled using a VkSamplerAddressMode ofVK_SAMPLER_ADDRESS_MODE_CLAMP_TO_EDGE
-
VUID-vkCmdDispatch-OpTypeImage-06423
Any VkImageView or VkBufferView being written as a storage image or storage texel buffer where the image format field of theOpTypeImage
isUnknown
then the view’s format feature must containVK_FORMAT_FEATURE_2_STORAGE_WRITE_WITHOUT_FORMAT_BIT
-
VUID-vkCmdDispatch-OpTypeImage-06424
Any VkImageView or VkBufferView being read as a storage image or storage texel buffer where the image format field of theOpTypeImage
isUnknown
then the view’s format feature must containVK_FORMAT_FEATURE_2_STORAGE_READ_WITHOUT_FORMAT_BIT
-
VUID-vkCmdDispatch-None-02697
For each set n that is statically used by theVkPipeline
bound to the pipeline bind point used by this command, a descriptor set must have been bound to n at the same pipeline bind point, with aVkPipelineLayout
that is compatible for set n, with theVkPipelineLayout
used to create the currentVkPipeline
, as described in [descriptorsets-compatibility] -
VUID-vkCmdDispatch-maintenance4-06425
If themaintenance4
feature is not enabled, then for each push constant that is statically used by theVkPipeline
bound to the pipeline bind point used by this command, a push constant value must have been set for the same pipeline bind point, with aVkPipelineLayout
that is compatible for push constants, with theVkPipelineLayout
used to create the currentVkPipeline
, as described in [descriptorsets-compatibility] -
VUID-vkCmdDispatch-None-02699
Descriptors in each bound descriptor set, specified viavkCmdBindDescriptorSets
, must be valid if they are statically used by theVkPipeline
bound to the pipeline bind point used by this command -
VUID-vkCmdDispatch-None-02700
A valid pipeline must be bound to the pipeline bind point used by this command -
VUID-vkCmdDispatch-commandBuffer-02701
If theVkPipeline
object bound to the pipeline bind point used by this command requires any dynamic state, that state must have been set or inherited (if theVK_NV_inherited_viewport_scissor
extension is enabled) forcommandBuffer
, and done so after any previously bound pipeline with the corresponding state not specified as dynamic -
VUID-vkCmdDispatch-None-02859
There must not have been any calls to dynamic state setting commands for any state not specified as dynamic in theVkPipeline
object bound to the pipeline bind point used by this command, since that pipeline was bound -
VUID-vkCmdDispatch-None-02702
If theVkPipeline
object bound to the pipeline bind point used by this command accesses aVkSampler
object that uses unnormalized coordinates, that sampler must not be used to sample from anyVkImage
with aVkImageView
of the typeVK_IMAGE_VIEW_TYPE_3D
,VK_IMAGE_VIEW_TYPE_CUBE
,VK_IMAGE_VIEW_TYPE_1D_ARRAY
,VK_IMAGE_VIEW_TYPE_2D_ARRAY
orVK_IMAGE_VIEW_TYPE_CUBE_ARRAY
, in any shader stage -
VUID-vkCmdDispatch-None-02703
If theVkPipeline
object bound to the pipeline bind point used by this command accesses aVkSampler
object that uses unnormalized coordinates, that sampler must not be used with any of the SPIR-VOpImageSample*
orOpImageSparseSample*
instructions withImplicitLod
,Dref
orProj
in their name, in any shader stage -
VUID-vkCmdDispatch-None-02704
If theVkPipeline
object bound to the pipeline bind point used by this command accesses aVkSampler
object that uses unnormalized coordinates, that sampler must not be used with any of the SPIR-VOpImageSample*
orOpImageSparseSample*
instructions that includes a LOD bias or any offset values, in any shader stage -
VUID-vkCmdDispatch-None-02705
If the robust buffer access feature is not enabled, and if theVkPipeline
object bound 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 -
VUID-vkCmdDispatch-None-02706
If the robust buffer access feature is not enabled, and if theVkPipeline
object bound 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 -
VUID-vkCmdDispatch-commandBuffer-02707
IfcommandBuffer
is an unprotected command buffer andprotectedNoFault
is not supported, any resource accessed by the VkPipeline object bound to the pipeline bind point used by this command must not be a protected resource -
VUID-vkCmdDispatch-None-06550
If theVkPipeline
object bound to the pipeline bind point used by this command accesses aVkSampler
orVkImageView
object that enables sampler Y′CBCR conversion, that object must only be used withOpImageSample*
orOpImageSparseSample*
instructions -
VUID-vkCmdDispatch-ConstOffset-06551
If theVkPipeline
object bound to the pipeline bind point used by this command accesses aVkSampler
orVkImageView
object that enables sampler Y′CBCR conversion, that object must not use theConstOffset
andOffset
operands -
VUID-vkCmdDispatch-None-04115
If a VkImageView is accessed usingOpImageWrite
as a result of this command, then theType
of theTexel
operand of that instruction must have at least as many components as the image view’s format -
VUID-vkCmdDispatch-OpImageWrite-04469
If a VkBufferView is accessed usingOpImageWrite
as a result of this command, then theType
of theTexel
operand of that instruction must have at least as many components as the buffer view’s format -
VUID-vkCmdDispatch-SampledType-04470
If a VkImageView with a VkFormat that has a 64-bit component width is accessed as a result of this command, theSampledType
of theOpTypeImage
operand of that instruction must have aWidth
of 64 -
VUID-vkCmdDispatch-SampledType-04471
If a VkImageView with a VkFormat that has a component width less than 64-bit is accessed as a result of this command, theSampledType
of theOpTypeImage
operand of that instruction must have aWidth
of 32 -
VUID-vkCmdDispatch-SampledType-04472
If a VkBufferView with a VkFormat that has a 64-bit component width is accessed as a result of this command, theSampledType
of theOpTypeImage
operand of that instruction must have aWidth
of 64 -
VUID-vkCmdDispatch-SampledType-04473
If a VkBufferView with a VkFormat that has a component width less than 64-bit is accessed as a result of this command, theSampledType
of theOpTypeImage
operand of that instruction must have aWidth
of 32 -
VUID-vkCmdDispatch-sparseImageInt64Atomics-04474
If thesparseImageInt64Atomics
feature is not enabled, VkImage objects created with theVK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT
flag must not be accessed by atomic instructions through anOpTypeImage
with aSampledType
with aWidth
of 64 by this command -
VUID-vkCmdDispatch-sparseImageInt64Atomics-04475
If thesparseImageInt64Atomics
feature is not enabled, VkBuffer objects created with theVK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT
flag must not be accessed by atomic instructions through anOpTypeImage
with aSampledType
with aWidth
of 64 by this command
-
VUID-vkCmdDispatch-commandBuffer-02712
IfcommandBuffer
is a protected command buffer andprotectedNoFault
is not supported, any resource written to by theVkPipeline
object bound to the pipeline bind point used by this command must not be an unprotected resource -
VUID-vkCmdDispatch-commandBuffer-02713
IfcommandBuffer
is a protected command buffer andprotectedNoFault
is not supported, pipeline stages other than the framebuffer-space and compute stages in theVkPipeline
object bound to the pipeline bind point used by this command must not write to any resource -
VUID-vkCmdDispatch-commandBuffer-04617
If any of the shader stages of theVkPipeline
bound to the pipeline bind point used by this command uses the RayQueryKHR capability, thencommandBuffer
must not be a protected command buffer -
VUID-vkCmdDispatch-groupCountX-00386
groupCountX
must be less than or equal toVkPhysicalDeviceLimits
::maxComputeWorkGroupCount
[0] -
VUID-vkCmdDispatch-groupCountY-00387
groupCountY
must be less than or equal toVkPhysicalDeviceLimits
::maxComputeWorkGroupCount
[1] -
VUID-vkCmdDispatch-groupCountZ-00388
groupCountZ
must be less than or equal toVkPhysicalDeviceLimits
::maxComputeWorkGroupCount
[2]
-
VUID-vkCmdDispatch-commandBuffer-parameter
commandBuffer
must be a valid VkCommandBuffer handle -
VUID-vkCmdDispatch-commandBuffer-recording
commandBuffer
must be in the recording state -
VUID-vkCmdDispatch-commandBuffer-cmdpool
TheVkCommandPool
thatcommandBuffer
was allocated from must support compute operations -
VUID-vkCmdDispatch-renderpass
This command must only be called outside of a render pass instance
-
Host access to
commandBuffer
must be externally synchronized -
Host access to the
VkCommandPool
thatcommandBuffer
was allocated from must be externally synchronized
Command Buffer Levels | Render Pass Scope | Supported Queue Types |
---|---|---|
Primary |
Outside |
Compute |
Document Notes
For more information, see the Vulkan Specification
This page is extracted from the Vulkan Specification. Fixes and changes should be made to the Specification, not directly.