C Specification
To record an indexed draw, call:
// Provided by VK_VERSION_1_0
void vkCmdDrawIndexed(
VkCommandBuffer commandBuffer,
uint32_t indexCount,
uint32_t instanceCount,
uint32_t firstIndex,
int32_t vertexOffset,
uint32_t firstInstance);
Parameters
-
commandBufferis the command buffer into which the command is recorded. -
indexCountis the number of vertices to draw. -
instanceCountis the number of instances to draw. -
firstIndexis the base index within the index buffer. -
vertexOffsetis the value added to the vertex index before indexing into the vertex buffer. -
firstInstanceis the instance ID of the first instance to draw.
Description
When the command is executed, primitives are assembled using the current
primitive topology and indexCount vertices whose indices are retrieved
from the index buffer.
The index buffer is treated as an array of tightly packed unsigned integers
of size defined by the vkCmdBindIndexBuffer::indexType parameter
with which the buffer was bound.
The first vertex index is at an offset of firstIndex ×
indexSize + offset within the bound index buffer, where
offset is the offset specified by vkCmdBindIndexBuffer and
indexSize is the byte size of the type specified by indexType.
Subsequent index values are retrieved from consecutive locations in the
index buffer.
Indices are first compared to the primitive restart value, then zero
extended to 32 bits (if the indexType is
VK_INDEX_TYPE_UINT8_EXT or
VK_INDEX_TYPE_UINT16) and have vertexOffset added to them,
before being supplied as the vertexIndex value.
The primitives are drawn instanceCount times with instanceIndex
starting with firstInstance and increasing sequentially for each
instance.
The assembled primitives execute the bound graphics pipeline.
-
VUID-vkCmdDrawIndexed-magFilter-04553
If a VkSampler created withmagFilterorminFilterequal toVK_FILTER_LINEARandcompareEnableequal toVK_FALSEis 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-vkCmdDrawIndexed-None-02691
If aVkImageViewis 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-vkCmdDrawIndexed-None-02692
If aVkImageViewis sampled withVK_FILTER_CUBIC_EXTas a result of this command, then the image view’s format features must containVK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_EXT -
VUID-vkCmdDrawIndexed-filterCubic-02694
Any VkImageView being sampled withVK_FILTER_CUBIC_EXTas a result of this command must have a VkImageViewType and format that supports cubic filtering, as specified byVkFilterCubicImageViewImageFormatPropertiesEXT::filterCubicreturned byvkGetPhysicalDeviceImageFormatProperties2 -
VUID-vkCmdDrawIndexed-filterCubicMinmax-02695
Any VkImageView being sampled withVK_FILTER_CUBIC_EXTwith a reduction mode of eitherVK_SAMPLER_REDUCTION_MODE_MINorVK_SAMPLER_REDUCTION_MODE_MAXas a result of this command must have a VkImageViewType and format that supports cubic filtering together with minmax filtering, as specified byVkFilterCubicImageViewImageFormatPropertiesEXT::filterCubicMinmaxreturned byvkGetPhysicalDeviceImageFormatProperties2 -
VUID-vkCmdDrawIndexed-flags-02696
Any VkImage created with a VkImageCreateInfo::flagscontainingVK_IMAGE_CREATE_CORNER_SAMPLED_BIT_NVsampled as a result of this command must only be sampled using a VkSamplerAddressMode ofVK_SAMPLER_ADDRESS_MODE_CLAMP_TO_EDGE -
VUID-vkCmdDrawIndexed-None-02697
For each set n that is statically used by theVkPipelinebound 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 aVkPipelineLayoutthat is compatible for set n, with theVkPipelineLayoutused to create the currentVkPipeline, as described in [descriptorsets-compatibility] -
VUID-vkCmdDrawIndexed-None-02698
For each push constant that is statically used by theVkPipelinebound to the pipeline bind point used by this command, a push constant value must have been set for the same pipeline bind point, with aVkPipelineLayoutthat is compatible for push constants, with theVkPipelineLayoutused to create the currentVkPipeline, as described in [descriptorsets-compatibility] -
VUID-vkCmdDrawIndexed-None-02699
Descriptors in each bound descriptor set, specified viavkCmdBindDescriptorSets, must be valid if they are statically used by theVkPipelinebound to the pipeline bind point used by this command -
VUID-vkCmdDrawIndexed-None-02700
A valid pipeline must be bound to the pipeline bind point used by this command -
VUID-vkCmdDrawIndexed-commandBuffer-02701
If theVkPipelineobject 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-vkCmdDrawIndexed-None-02859
There must not have been any calls to dynamic state setting commands for any state not specified as dynamic in theVkPipelineobject bound to the pipeline bind point used by this command, since that pipeline was bound -
VUID-vkCmdDrawIndexed-None-02702
If theVkPipelineobject bound to the pipeline bind point used by this command accesses aVkSamplerobject that uses unnormalized coordinates, that sampler must not be used to sample from anyVkImagewith aVkImageViewof the typeVK_IMAGE_VIEW_TYPE_3D,VK_IMAGE_VIEW_TYPE_CUBE,VK_IMAGE_VIEW_TYPE_1D_ARRAY,VK_IMAGE_VIEW_TYPE_2D_ARRAYorVK_IMAGE_VIEW_TYPE_CUBE_ARRAY, in any shader stage -
VUID-vkCmdDrawIndexed-None-02703
If theVkPipelineobject bound to the pipeline bind point used by this command accesses aVkSamplerobject that uses unnormalized coordinates, that sampler must not be used with any of the SPIR-VOpImageSample*orOpImageSparseSample*instructions withImplicitLod,DreforProjin their name, in any shader stage -
VUID-vkCmdDrawIndexed-None-02704
If theVkPipelineobject bound to the pipeline bind point used by this command accesses aVkSamplerobject 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-vkCmdDrawIndexed-None-02705
If the robust buffer access feature is not enabled, and if theVkPipelineobject 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-vkCmdDrawIndexed-None-02706
If the robust buffer access feature is not enabled, and if theVkPipelineobject 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-vkCmdDrawIndexed-commandBuffer-02707
IfcommandBufferis an unprotected command buffer, any resource accessed by theVkPipelineobject bound to the pipeline bind point used by this command must not be a protected resource -
VUID-vkCmdDrawIndexed-None-04115
If a VkImageView is accessed usingOpImageWriteas a result of this command, then theTypeof theTexeloperand of that instruction must have at least as many components as the image view’s format. -
VUID-vkCmdDrawIndexed-OpImageWrite-04469
If a VkBufferView is accessed usingOpImageWriteas a result of this command, then theTypeof theTexeloperand of that instruction must have at least as many components as the image view’s format. -
VUID-vkCmdDrawIndexed-SampledType-04470
If a VkImageView with a VkFormat that has a 64-bit channel width is accessed as a result of this command, theSampledTypeof theOpTypeImageoperand of that instruction must have aWidthof 64. -
VUID-vkCmdDrawIndexed-SampledType-04471
If a VkImageView with a VkFormat that has a channel width less than 64-bit is accessed as a result of this command, theSampledTypeof theOpTypeImageoperand of that instruction must have aWidthof 32. -
VUID-vkCmdDrawIndexed-SampledType-04472
If a VkBufferView with a VkFormat that has a 64-bit channel width is accessed as a result of this command, theSampledTypeof theOpTypeImageoperand of that instruction must have aWidthof 64. -
VUID-vkCmdDrawIndexed-SampledType-04473
If a VkBufferView with a VkFormat that has a channel width less than 64-bit is accessed as a result of this command, theSampledTypeof theOpTypeImageoperand of that instruction must have aWidthof 32. -
VUID-vkCmdDrawIndexed-sparseImageInt64Atomics-04474
If thesparseImageInt64Atomicsfeature is not enabled, VkImage objects created with theVK_IMAGE_CREATE_SPARSE_RESIDENCY_BITflag must not be accessed by atomic instructions through anOpTypeImagewith aSampledTypewith aWidthof 64 by this command. -
VUID-vkCmdDrawIndexed-sparseImageInt64Atomics-04475
If thesparseImageInt64Atomicsfeature is not enabled, VkBuffer objects created with theVK_BUFFER_CREATE_SPARSE_RESIDENCY_BITflag must not be accessed by atomic instructions through anOpTypeImagewith aSampledTypewith aWidthof 64 by this command. -
VUID-vkCmdDrawIndexed-renderPass-02684
The current render pass must be compatible with therenderPassmember of theVkGraphicsPipelineCreateInfostructure specified when creating theVkPipelinebound toVK_PIPELINE_BIND_POINT_GRAPHICS -
VUID-vkCmdDrawIndexed-subpass-02685
The subpass index of the current render pass must be equal to thesubpassmember of theVkGraphicsPipelineCreateInfostructure specified when creating theVkPipelinebound toVK_PIPELINE_BIND_POINT_GRAPHICS -
VUID-vkCmdDrawIndexed-None-02686
Every input attachment used by the current subpass must be bound to the pipeline via a descriptor set -
VUID-vkCmdDrawIndexed-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-vkCmdDrawIndexed-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-vkCmdDrawIndexed-sampleLocationsEnable-02689
If the bound graphics pipeline was created with VkPipelineSampleLocationsStateCreateInfoEXT::sampleLocationsEnableset toVK_TRUEand the current subpass has a depth/stencil attachment, then that attachment must have been created with theVK_IMAGE_CREATE_SAMPLE_LOCATIONS_COMPATIBLE_DEPTH_BIT_EXTbit set -
VUID-vkCmdDrawIndexed-viewportCount-03417
If the bound graphics pipeline state was created with theVK_DYNAMIC_STATE_VIEWPORT_WITH_COUNT_EXTdynamic state enabled, but not theVK_DYNAMIC_STATE_SCISSOR_WITH_COUNT_EXTdynamic state enabled, then vkCmdSetViewportWithCountEXT must have been called in the current command buffer prior to this draw command, and theviewportCountparameter ofvkCmdSetViewportWithCountEXTmust match theVkPipelineViewportStateCreateInfo::scissorCountof the pipeline -
VUID-vkCmdDrawIndexed-scissorCount-03418
If the bound graphics pipeline state was created with theVK_DYNAMIC_STATE_SCISSOR_WITH_COUNT_EXTdynamic state enabled, but not theVK_DYNAMIC_STATE_VIEWPORT_WITH_COUNT_EXTdynamic state enabled, then vkCmdSetScissorWithCountEXT must have been called in the current command buffer prior to this draw command, and thescissorCountparameter ofvkCmdSetScissorWithCountEXTmust match theVkPipelineViewportStateCreateInfo::viewportCountof the pipeline -
VUID-vkCmdDrawIndexed-viewportCount-03419
If the bound graphics pipeline state was created with both theVK_DYNAMIC_STATE_SCISSOR_WITH_COUNT_EXTandVK_DYNAMIC_STATE_VIEWPORT_WITH_COUNT_EXTdynamic states enabled then both vkCmdSetViewportWithCountEXT and vkCmdSetScissorWithCountEXT must have been called in the current command buffer prior to this draw command, and theviewportCountparameter ofvkCmdSetViewportWithCountEXTmust match thescissorCountparameter ofvkCmdSetScissorWithCountEXT -
VUID-vkCmdDrawIndexed-viewportCount-04137
If the bound graphics pipeline state was created with theVK_DYNAMIC_STATE_VIEWPORT_WITH_COUNT_EXTdynamic state enabled, but not theVK_DYNAMIC_STATE_VIEWPORT_W_SCALING_NVdynamic state enabled, then the bound graphics pipeline must have been created with VkPipelineViewportWScalingStateCreateInfoNV::viewportCountgreater or equal to theviewportCountparameter in the last call to vkCmdSetViewportWithCountEXT -
VUID-vkCmdDrawIndexed-viewportCount-04138
If the bound graphics pipeline state was created with theVK_DYNAMIC_STATE_VIEWPORT_WITH_COUNT_EXTandVK_DYNAMIC_STATE_VIEWPORT_W_SCALING_NVdynamic states enabled then theviewportCountparameter in the last call to vkCmdSetViewportWScalingNV must be greater than or equal to theviewportCountparameter in the last call to vkCmdSetViewportWithCountEXT -
VUID-vkCmdDrawIndexed-viewportCount-04139
If the bound graphics pipeline state was created with theVK_DYNAMIC_STATE_VIEWPORT_WITH_COUNT_EXTdynamic state enabled, but not theVK_DYNAMIC_STATE_VIEWPORT_SHADING_RATE_PALETTE_NVdynamic state enabled, then the bound graphics pipeline must have been created with VkPipelineViewportShadingRateImageStateCreateInfoNV::viewportCountgreater or equal to theviewportCountparameter in the last call to vkCmdSetViewportWithCountEXT -
VUID-vkCmdDrawIndexed-viewportCount-04140
If the bound graphics pipeline state was created with theVK_DYNAMIC_STATE_VIEWPORT_WITH_COUNT_EXTandVK_DYNAMIC_STATE_VIEWPORT_SHADING_RATE_PALETTE_NVdynamic states enabled then theviewportCountparameter in the last call to vkCmdSetViewportShadingRatePaletteNV must be greater than or equal to theviewportCountparameter in the last call to vkCmdSetViewportWithCountEXT -
VUID-vkCmdDrawIndexed-VkPipelineVieportCreateInfo-04141
If the bound graphics pipeline state was created with theVK_DYNAMIC_STATE_VIEWPORT_WITH_COUNT_EXTdynamic state enabled and an instance of VkPipelineViewportSwizzleStateCreateInfoNV chained fromVkPipelineVieportCreateInfo, then the bound graphics pipeline must have been created with VkPipelineViewportSwizzleStateCreateInfoNV::viewportCountgreater or equal to theviewportCountparameter in the last call to vkCmdSetViewportWithCountEXT -
VUID-vkCmdDrawIndexed-VkPipelineVieportCreateInfo-04142
If the bound graphics pipeline state was created with theVK_DYNAMIC_STATE_VIEWPORT_WITH_COUNT_EXTdynamic state enabled and an instance of VkPipelineViewportExclusiveScissorStateCreateInfoNV chained fromVkPipelineVieportCreateInfo, then the bound graphics pipeline must have been created with VkPipelineViewportExclusiveScissorStateCreateInfoNV::exclusiveScissorCountgreater or equal to theviewportCountparameter in the last call to vkCmdSetViewportWithCountEXT -
VUID-vkCmdDrawIndexed-primitiveTopology-03420
If the bound graphics pipeline state was created with theVK_DYNAMIC_STATE_PRIMITIVE_TOPOLOGY_EXTdynamic state enabled then vkCmdSetPrimitiveTopologyEXT must have been called in the current command buffer prior to this draw command, and theprimitiveTopologyparameter ofvkCmdSetPrimitiveTopologyEXTmust be of the same topology class as the pipeline VkPipelineInputAssemblyStateCreateInfo::topologystate -
VUID-vkCmdDrawIndexed-primitiveFragmentShadingRateWithMultipleViewports-04552
If theprimitiveFragmentShadingRateWithMultipleViewportslimit is not supported, the bound graphics pipeline was created with theVK_DYNAMIC_STATE_VIEWPORT_WITH_COUNT_EXTdynamic state enabled, and any of the shader stages of the bound graphics pipeline write to thePrimitiveShadingRateKHRbuilt-in, then vkCmdSetViewportWithCountEXT must have been called in the current command buffer prior to this draw command, and theviewportCountparameter ofvkCmdSetViewportWithCountEXTmust be1
-
VUID-vkCmdDrawIndexed-commandBuffer-02712
IfcommandBufferis a protected command buffer, any resource written to by theVkPipelineobject bound to the pipeline bind point used by this command must not be an unprotected resource -
VUID-vkCmdDrawIndexed-commandBuffer-02713
IfcommandBufferis a protected command buffer, pipeline stages other than the framebuffer-space and compute stages in theVkPipelineobject bound to the pipeline bind point must not write to any resource
-
VUID-vkCmdDrawIndexed-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-vkCmdDrawIndexed-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-vkCmdDrawIndexed-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-vkCmdDrawIndexed-indexSize-00463
(indexSize× (firstIndex+indexCount) +offset) must be less than or equal to the size of the bound index buffer, withindexSizebeing based on the type specified byindexType, where the index buffer,indexType, andoffsetare specified viavkCmdBindIndexBuffer
-
VUID-vkCmdDrawIndexed-commandBuffer-parameter
commandBuffermust be a valid VkCommandBuffer handle -
VUID-vkCmdDrawIndexed-commandBuffer-recording
commandBuffermust be in the recording state -
VUID-vkCmdDrawIndexed-commandBuffer-cmdpool
TheVkCommandPoolthatcommandBufferwas allocated from must support graphics operations -
VUID-vkCmdDrawIndexed-renderpass
This command must only be called inside of a render pass instance
-
Host access to
commandBuffermust be externally synchronized -
Host access to the
VkCommandPoolthatcommandBufferwas allocated from must be externally synchronized
| Command Buffer Levels | Render Pass Scope | Supported Queue Types | Pipeline Type |
|---|---|---|---|
Primary |
Inside |
Graphics |
Graphics |
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.