C Specification
To record an indexed indirect draw, call:
// Provided by VK_VERSION_1_0
void vkCmdDrawIndexedIndirect(
VkCommandBuffer commandBuffer,
VkBuffer buffer,
VkDeviceSize offset,
uint32_t drawCount,
uint32_t stride);
Parameters
-
commandBuffer
is the command buffer into which the command is recorded. -
buffer
is the buffer containing draw parameters. -
offset
is the byte offset intobuffer
where parameters begin. -
drawCount
is the number of draws to execute, and can be zero. -
stride
is the byte stride between successive sets of draw parameters.
Description
vkCmdDrawIndexedIndirect
behaves similarly to vkCmdDrawIndexed
except that the parameters are read by the device from a buffer during
execution.
drawCount
draws are executed by the command, with parameters taken
from buffer
starting at offset
and increasing by stride
bytes for each successive draw.
The parameters of each draw are encoded in an array of
VkDrawIndexedIndirectCommand structures.
If drawCount
is less than or equal to one, stride
is ignored.
-
VUID-vkCmdDrawIndexedIndirect-None-02690
If aVkImageView
is sampled withVK_FILTER_LINEAR
as a result of this command, then the image view’s format features must containVK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT
-
VUID-vkCmdDrawIndexedIndirect-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-vkCmdDrawIndexedIndirect-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-vkCmdDrawIndexedIndirect-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-vkCmdDrawIndexedIndirect-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-vkCmdDrawIndexedIndirect-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-vkCmdDrawIndexedIndirect-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-vkCmdDrawIndexedIndirect-None-02698
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-vkCmdDrawIndexedIndirect-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-vkCmdDrawIndexedIndirect-None-02700
A valid pipeline must be bound to the pipeline bind point used by this command -
VUID-vkCmdDrawIndexedIndirect-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 forcommandBuffer
, and done so after any previously bound pipeline with the corresponding state not specified as dynamic -
VUID-vkCmdDrawIndexedIndirect-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-vkCmdDrawIndexedIndirect-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-vkCmdDrawIndexedIndirect-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-vkCmdDrawIndexedIndirect-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-vkCmdDrawIndexedIndirect-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-vkCmdDrawIndexedIndirect-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-vkCmdDrawIndexedIndirect-commandBuffer-02707
IfcommandBuffer
is an unprotected command buffer, any resource accessed by theVkPipeline
object bound to the pipeline bind point used by this command must not be a protected resource -
VUID-vkCmdDrawIndexedIndirect-None-04115
If aVkImageView
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-vkCmdDrawIndexedIndirect-renderPass-02684
The current render pass must be compatible with therenderPass
member of theVkGraphicsPipelineCreateInfo
structure specified when creating theVkPipeline
bound toVK_PIPELINE_BIND_POINT_GRAPHICS
-
VUID-vkCmdDrawIndexedIndirect-subpass-02685
The subpass index of the current render pass must be equal to thesubpass
member of theVkGraphicsPipelineCreateInfo
structure specified when creating theVkPipeline
bound toVK_PIPELINE_BIND_POINT_GRAPHICS
-
VUID-vkCmdDrawIndexedIndirect-None-02686
Every input attachment used by the current subpass must be bound to the pipeline via a descriptor set -
VUID-vkCmdDrawIndexedIndirect-None-02687
Image subresources used as attachments in the current render pass must not be accessed in any way other than as an attachment by this command -
VUID-vkCmdDrawIndexedIndirect-maxMultiviewInstanceIndex-02688
If the draw is recorded in a render pass instance with multiview enabled, the maximum instance index must be less than or equal to VkPhysicalDeviceMultiviewProperties::maxMultiviewInstanceIndex
-
VUID-vkCmdDrawIndexedIndirect-sampleLocationsEnable-02689
If the bound graphics pipeline was created with VkPipelineSampleLocationsStateCreateInfoEXT::sampleLocationsEnable
set toVK_TRUE
and the current subpass has a depth/stencil attachment, then that attachment must have been created with theVK_IMAGE_CREATE_SAMPLE_LOCATIONS_COMPATIBLE_DEPTH_BIT_EXT
bit set -
VUID-vkCmdDrawIndexedIndirect-viewportCount-03417
If the bound graphics pipeline state was created with theVK_DYNAMIC_STATE_VIEWPORT_WITH_COUNT_EXT
dynamic state enabled, but not theVK_DYNAMIC_STATE_SCISSOR_WITH_COUNT_EXT
dynamic state enabled, then vkCmdSetViewportWithCountEXT must have been called in the current command buffer prior to this draw command, and theviewportCount
parameter ofvkCmdSetViewportWithCountEXT
must match theVkPipelineViewportStateCreateInfo
::scissorCount
of the pipeline -
VUID-vkCmdDrawIndexedIndirect-scissorCount-03418
If the bound graphics pipeline state was created with theVK_DYNAMIC_STATE_SCISSOR_WITH_COUNT_EXT
dynamic state enabled, but not theVK_DYNAMIC_STATE_VIEWPORT_WITH_COUNT_EXT
dynamic state enabled, then vkCmdSetScissorWithCountEXT must have been called in the current command buffer prior to this draw command, and thescissorCount
parameter ofvkCmdSetScissorWithCountEXT
must match theVkPipelineViewportStateCreateInfo
::viewportCount
of the pipeline -
VUID-vkCmdDrawIndexedIndirect-viewportCount-03419
If the bound graphics pipeline state was created with both theVK_DYNAMIC_STATE_SCISSOR_WITH_COUNT_EXT
andVK_DYNAMIC_STATE_VIEWPORT_WITH_COUNT_EXT
dynamic states enabled then both vkCmdSetViewportWithCountEXT and vkCmdSetScissorWithCountEXT must have been called in the current command buffer prior to this draw command, and theviewportCount
parameter ofvkCmdSetViewportWithCountEXT
must match thescissorCount
parameter ofvkCmdSetScissorWithCountEXT
-
VUID-vkCmdDrawIndexedIndirect-viewportCount-04137
If the bound graphics pipeline state was created with theVK_DYNAMIC_STATE_VIEWPORT_WITH_COUNT_EXT
dynamic state enabled, but not theVK_DYNAMIC_STATE_VIEWPORT_W_SCALING_NV
dynamic state enabled, then the bound graphics pipeline must have been created with VkPipelineViewportWScalingStateCreateInfoNV::viewportCount
greater or equal to theviewportCount
parameter in the last call to vkCmdSetViewportWithCountEXT -
VUID-vkCmdDrawIndexedIndirect-viewportCount-04138
If the bound graphics pipeline state was created with theVK_DYNAMIC_STATE_VIEWPORT_WITH_COUNT_EXT
andVK_DYNAMIC_STATE_VIEWPORT_W_SCALING_NV
dynamic states enabled then theviewportCount
parameter in the last call to vkCmdSetViewportWScalingNV must be greater than or equal to theviewportCount
parameter in the last call to vkCmdSetViewportWithCountEXT -
VUID-vkCmdDrawIndexedIndirect-viewportCount-04139
If the bound graphics pipeline state was created with theVK_DYNAMIC_STATE_VIEWPORT_WITH_COUNT_EXT
dynamic state enabled, but not theVK_DYNAMIC_STATE_VIEWPORT_SHADING_RATE_PALETTE_NV
dynamic state enabled, then the bound graphics pipeline must have been created with VkPipelineViewportShadingRateImageStateCreateInfoNV::viewportCount
greater or equal to theviewportCount
parameter in the last call to vkCmdSetViewportWithCountEXT -
VUID-vkCmdDrawIndexedIndirect-viewportCount-04140
If the bound graphics pipeline state was created with theVK_DYNAMIC_STATE_VIEWPORT_WITH_COUNT_EXT
andVK_DYNAMIC_STATE_VIEWPORT_SHADING_RATE_PALETTE_NV
dynamic states enabled then theviewportCount
parameter in the last call to vkCmdSetViewportShadingRatePaletteNV must be greater than or equal to theviewportCount
parameter in the last call to vkCmdSetViewportWithCountEXT -
VUID-vkCmdDrawIndexedIndirect-VkPipelineVieportCreateInfo-04141
If the bound graphics pipeline state was created with theVK_DYNAMIC_STATE_VIEWPORT_WITH_COUNT_EXT
dynamic state enabled and an instance of VkPipelineViewportSwizzleStateCreateInfoNV chained fromVkPipelineVieportCreateInfo
, then the bound graphics pipeline must have been created with VkPipelineViewportSwizzleStateCreateInfoNV::viewportCount
greater or equal to theviewportCount
parameter in the last call to vkCmdSetViewportWithCountEXT -
VUID-vkCmdDrawIndexedIndirect-VkPipelineVieportCreateInfo-04142
If the bound graphics pipeline state was created with theVK_DYNAMIC_STATE_VIEWPORT_WITH_COUNT_EXT
dynamic state enabled and an instance of VkPipelineViewportExclusiveScissorStateCreateInfoNV chained fromVkPipelineVieportCreateInfo
, then the bound graphics pipeline must have been created with VkPipelineViewportExclusiveScissorStateCreateInfoNV::exclusiveScissorCount
greater or equal to theviewportCount
parameter in the last call to vkCmdSetViewportWithCountEXT -
VUID-vkCmdDrawIndexedIndirect-primitiveTopology-03420
If the bound graphics pipeline state was created with theVK_DYNAMIC_STATE_PRIMITIVE_TOPOLOGY_EXT
dynamic state enabled then vkCmdSetPrimitiveTopologyEXT must have been called in the current command buffer prior to this draw command, and theprimitiveTopology
parameter ofvkCmdSetPrimitiveTopologyEXT
must be of the same topology class as the pipeline VkPipelineInputAssemblyStateCreateInfo::topology
state
-
VUID-vkCmdDrawIndexedIndirect-None-04007
All vertex input bindings accessed via vertex input variables declared in the vertex shader entry point’s interface must have either valid or VK_NULL_HANDLE buffers bound -
VUID-vkCmdDrawIndexedIndirect-None-04008
If the nullDescriptor feature is not enabled, all vertex input bindings accessed via vertex input variables declared in the vertex shader entry point’s interface must not be VK_NULL_HANDLE -
VUID-vkCmdDrawIndexedIndirect-None-02721
For a given vertex buffer binding, any attribute data fetched must be entirely contained within the corresponding vertex buffer binding, as described in [fxvertex-input]
-
VUID-vkCmdDrawIndexedIndirect-buffer-02708
Ifbuffer
is non-sparse then it must be bound completely and contiguously to a singleVkDeviceMemory
object -
VUID-vkCmdDrawIndexedIndirect-buffer-02709
buffer
must have been created with theVK_BUFFER_USAGE_INDIRECT_BUFFER_BIT
bit set -
VUID-vkCmdDrawIndexedIndirect-offset-02710
offset
must be a multiple of4
-
VUID-vkCmdDrawIndexedIndirect-commandBuffer-02711
commandBuffer
must not be a protected command buffer
-
VUID-vkCmdDrawIndexedIndirect-drawCount-02718
If the multi-draw indirect feature is not enabled,drawCount
must be0
or1
-
VUID-vkCmdDrawIndexedIndirect-drawCount-02719
drawCount
must be less than or equal toVkPhysicalDeviceLimits
::maxDrawIndirectCount
-
VUID-vkCmdDrawIndexedIndirect-drawCount-00528
IfdrawCount
is greater than1
,stride
must be a multiple of4
and must be greater than or equal tosizeof
(VkDrawIndexedIndirectCommand
) -
VUID-vkCmdDrawIndexedIndirect-firstInstance-00530
If the drawIndirectFirstInstance feature is not enabled, all thefirstInstance
members of theVkDrawIndexedIndirectCommand
structures accessed by this command must be0
-
VUID-vkCmdDrawIndexedIndirect-drawCount-00539
IfdrawCount
is equal to1
, (offset
+sizeof
(VkDrawIndexedIndirectCommand
)) must be less than or equal to the size ofbuffer
-
VUID-vkCmdDrawIndexedIndirect-drawCount-00540
IfdrawCount
is greater than1
, (stride
× (drawCount
- 1) +offset
+sizeof
(VkDrawIndexedIndirectCommand
)) must be less than or equal to the size ofbuffer
-
VUID-vkCmdDrawIndexedIndirect-commandBuffer-parameter
commandBuffer
must be a valid VkCommandBuffer handle -
VUID-vkCmdDrawIndexedIndirect-buffer-parameter
buffer
must be a valid VkBuffer handle -
VUID-vkCmdDrawIndexedIndirect-commandBuffer-recording
commandBuffer
must be in the recording state -
VUID-vkCmdDrawIndexedIndirect-commandBuffer-cmdpool
TheVkCommandPool
thatcommandBuffer
was allocated from must support graphics operations -
VUID-vkCmdDrawIndexedIndirect-renderpass
This command must only be called inside of a render pass instance -
VUID-vkCmdDrawIndexedIndirect-commonparent
Both ofbuffer
, andcommandBuffer
must have been created, allocated, or retrieved from the same VkDevice
-
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 | Pipeline Type |
---|---|---|---|
Primary |
Inside |
Graphics |
Graphics |
See Also
VkBuffer, VkCommandBuffer, VkDeviceSize
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.