Vulkan.Extensions.VK_EXT_multi_draw

Name

VK_EXT_multi_draw - device extension

VK_EXT_multi_draw

Name String

VK_EXT_multi_draw

Extension Type

Device extension

Registered Extension Number

393

Revision

1

Extension and Version Dependencies

• Requires Vulkan 1.0

Contact

• Mike Blumenkrantz @zmike%0A<<Here describe the issue or question you have about the VK_EXT_multi_draw extension> >

Other Extension Metadata

Last Modified Date

2021-05-19

IP Status

No known IP claims.

Contributors

• Mike Blumenkrantz, VALVE
• Piers Daniell, NVIDIA
• Jason Ekstrand, INTEL
• Spencer Fricke, SAMSUNG
• Ricardo Garcia, IGALIA
• Jon Leech, KHRONOS
• Stu Smith, AMD

Description

Processing multiple draw commands in sequence incurs measurable overhead within drivers due to repeated state checks and updates during dispatch. This extension enables passing the entire sequence of draws directly to the driver in order to avoid any such overhead, using an array of MultiDrawInfoEXT or MultiDrawIndexedInfoEXT structs with cmdDrawMultiEXT or cmdDrawMultiIndexedEXT, respectively. These functions could be used any time multiple draw commands are being recorded without any state changes between them in order to maximize performance.

New Commands

• cmdDrawMultiEXT

• cmdDrawMultiIndexedEXT

New Structures

• MultiDrawIndexedInfoEXT

• MultiDrawInfoEXT

• Extending PhysicalDeviceFeatures2, DeviceCreateInfo:

  • PhysicalDeviceMultiDrawFeaturesEXT

• Extending PhysicalDeviceProperties2:

  • PhysicalDeviceMultiDrawPropertiesEXT

New Enum Constants

• EXT_MULTI_DRAW_EXTENSION_NAME

• EXT_MULTI_DRAW_SPEC_VERSION

• Extending StructureType:

  • STRUCTURE_TYPE_PHYSICAL_DEVICE_MULTI_DRAW_FEATURES_EXT
  • STRUCTURE_TYPE_PHYSICAL_DEVICE_MULTI_DRAW_PROPERTIES_EXT

New or Modified Built-In Variables

• (modified)DrawIndex

Version History

• Revision 1, 2021-01-20 (Mike Blumenkrantz)

  • Initial version

See Also

MultiDrawIndexedInfoEXT, MultiDrawInfoEXT, PhysicalDeviceMultiDrawFeaturesEXT, PhysicalDeviceMultiDrawPropertiesEXT, cmdDrawMultiEXT, cmdDrawMultiIndexedEXT

Document Notes

For more information, see the Vulkan Specification

This page is a generated document. Fixes and changes should be made to the generator scripts, not directly.

Documentation

cmdDrawMultiEXT

Arguments

:: forall io. MonadIO io

=> CommandBuffer

commandBuffer is the command buffer into which the command is recorded.

-> ("vertexInfo" ::: Vector MultiDrawInfoEXT)

pVertexInfo is a pointer to an array of MultiDrawInfoEXT with vertex information to be drawn.

-> ("instanceCount" ::: Word32)

instanceCount is the number of instances to draw.

-> ("firstInstance" ::: Word32)

firstInstance is the instance ID of the first instance to draw.

-> ("stride" ::: Word32)

stride is the byte stride between consecutive elements of pVertexInfo.

-> io ()

vkCmdDrawMultiEXT - Draw primitives

Description

drawCount draws are executed with parameters taken from pVertexInfo. The number of draw commands recorded is drawCount, with each command reading, sequentially, a firstVertex and a vertexCount from pVertexInfo.

Valid Usage

• If a Sampler created with magFilter or minFilter equal to FILTER_LINEAR and compareEnable equal to FALSE is used to sample a ImageView as a result of this command, then the image view’s format features must contain FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT

• If a Sampler created with mipmapMode equal to SAMPLER_MIPMAP_MODE_LINEAR and compareEnable equal to FALSE is used to sample a ImageView as a result of this command, then the image view’s format features must contain FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT
• If a ImageView 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 ImageView 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
• Any ImageView being sampled with FILTER_CUBIC_EXT as a result of this command must have a ImageViewType and format that supports cubic filtering, as specified by FilterCubicImageViewImageFormatPropertiesEXT::filterCubic returned by getPhysicalDeviceImageFormatProperties2
• Any ImageView 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 ImageViewType and format that supports cubic filtering together with minmax filtering, as specified by FilterCubicImageViewImageFormatPropertiesEXT::filterCubicMinmax returned by getPhysicalDeviceImageFormatProperties2
• Any Image created with a ImageCreateInfo::flags containing IMAGE_CREATE_CORNER_SAMPLED_BIT_NV sampled as a result of this command must only be sampled using a SamplerAddressMode of SAMPLER_ADDRESS_MODE_CLAMP_TO_EDGE
• Any ImageView or BufferView being written as a storage image or storage texel buffer where the image format field of the OpTypeImage is Unknown must have image format features that support FORMAT_FEATURE_2_STORAGE_WRITE_WITHOUT_FORMAT_BIT_KHR
• Any ImageView or BufferView being read as a storage image or storage texel buffer where the image format field of the OpTypeImage is Unknown must have image format features that support FORMAT_FEATURE_2_STORAGE_READ_WITHOUT_FORMAT_BIT_KHR
• For each set n that is statically used by the Pipeline 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 a PipelineLayout that is compatible for set n, with the PipelineLayout used to create the current Pipeline, as described in ???
• If the maintenance4 feature is not enabled, then for each push constant that is statically used by the Pipeline 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 a PipelineLayout that is compatible for push constants, with the PipelineLayout used to create the current Pipeline, as described in ???
• Descriptors in each bound descriptor set, specified via cmdBindDescriptorSets, must be valid if they are statically used by the Pipeline bound to the pipeline bind point used by this command
• A valid pipeline must be bound to the pipeline bind point used by this command
• If the Pipeline object bound to the pipeline bind point used by this command requires any dynamic state, that state must have been set or inherited (if the VK_NV_inherited_viewport_scissor extension is enabled) for commandBuffer, and done so after any previously bound pipeline with the corresponding state not specified as dynamic
• There must not have been any calls to dynamic state setting commands for any state not specified as dynamic in the Pipeline object bound to the pipeline bind point used by this command, since that pipeline was bound
• If the Pipeline object bound to the pipeline bind point used by this command accesses a Sampler object that uses unnormalized coordinates, that sampler must not be used to sample from any Image with a ImageView of the type IMAGE_VIEW_TYPE_3D, IMAGE_VIEW_TYPE_CUBE, IMAGE_VIEW_TYPE_1D_ARRAY, IMAGE_VIEW_TYPE_2D_ARRAY or IMAGE_VIEW_TYPE_CUBE_ARRAY, in any shader stage
• If the Pipeline object bound to the pipeline bind point used by this command accesses a Sampler object that uses unnormalized coordinates, that sampler must not be used with any of the SPIR-V OpImageSample* or OpImageSparseSample* instructions with ImplicitLod, Dref or Proj in their name, in any shader stage
• If the Pipeline object bound to the pipeline bind point used by this command accesses a Sampler object that uses unnormalized coordinates, that sampler must not be used with any of the SPIR-V OpImageSample* or OpImageSparseSample* instructions that includes a LOD bias or any offset values, in any shader stage
• If the robust buffer access feature is not enabled, and if the Pipeline 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
• If the robust buffer access feature is not enabled, and if the Pipeline 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
• If commandBuffer is an unprotected command buffer, any resource accessed by the Pipeline object bound to the pipeline bind point used by this command must not be a protected resource
• If a ImageView 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 BufferView 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 ImageView with a Format 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 ImageView with a Format 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 BufferView with a Format 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 BufferView with a Format 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, Image 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, Buffer 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
• The current render pass must be compatible with the renderPass member of the GraphicsPipelineCreateInfo structure specified when creating the Pipeline bound to PIPELINE_BIND_POINT_GRAPHICS
• The subpass index of the current render pass must be equal to the subpass member of the GraphicsPipelineCreateInfo structure specified when creating the Pipeline bound to PIPELINE_BIND_POINT_GRAPHICS
• Every input attachment used by the current subpass must be bound to the pipeline via a descriptor set
• 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, except for cases involving read-only access to depth/stencil attachments as described in the Render Pass chapter
• If the draw is recorded in a render pass instance with multiview enabled, the maximum instance index must be less than or equal to PhysicalDeviceMultiviewProperties::maxMultiviewInstanceIndex
• If the bound graphics pipeline was created with PipelineSampleLocationsStateCreateInfoEXT::sampleLocationsEnable set to TRUE and the current subpass has a depth/stencil attachment, then that attachment must have been created with the IMAGE_CREATE_SAMPLE_LOCATIONS_COMPATIBLE_DEPTH_BIT_EXT bit set
• If the bound graphics pipeline state was created with the DYNAMIC_STATE_VIEWPORT_WITH_COUNT_EXT dynamic state enabled, but not the DYNAMIC_STATE_SCISSOR_WITH_COUNT_EXT dynamic state enabled, then cmdSetViewportWithCountEXT must have been called in the current command buffer prior to this drawing command, and the viewportCount parameter of cmdSetViewportWithCountEXT must match the PipelineViewportStateCreateInfo::scissorCount of the pipeline
• If the bound graphics pipeline state was created with the DYNAMIC_STATE_SCISSOR_WITH_COUNT_EXT dynamic state enabled, but not the DYNAMIC_STATE_VIEWPORT_WITH_COUNT_EXT dynamic state enabled, then cmdSetScissorWithCountEXT must have been called in the current command buffer prior to this drawing command, and the scissorCount parameter of cmdSetScissorWithCountEXT must match the PipelineViewportStateCreateInfo::viewportCount of the pipeline
• If the bound graphics pipeline state was created with both the DYNAMIC_STATE_SCISSOR_WITH_COUNT_EXT and DYNAMIC_STATE_VIEWPORT_WITH_COUNT_EXT dynamic states enabled then both cmdSetViewportWithCountEXT and cmdSetScissorWithCountEXT must have been called in the current command buffer prior to this drawing command, and the viewportCount parameter of cmdSetViewportWithCountEXT must match the scissorCount parameter of cmdSetScissorWithCountEXT
• If the bound graphics pipeline state was created with the DYNAMIC_STATE_VIEWPORT_WITH_COUNT_EXT dynamic state enabled, but not the DYNAMIC_STATE_VIEWPORT_W_SCALING_NV dynamic state enabled, then the bound graphics pipeline must have been created with PipelineViewportWScalingStateCreateInfoNV::viewportCount greater or equal to the viewportCount parameter in the last call to cmdSetViewportWithCountEXT
• If the bound graphics pipeline state was created with the DYNAMIC_STATE_VIEWPORT_WITH_COUNT_EXT and DYNAMIC_STATE_VIEWPORT_W_SCALING_NV dynamic states enabled then the viewportCount parameter in the last call to cmdSetViewportWScalingNV must be greater than or equal to the viewportCount parameter in the last call to cmdSetViewportWithCountEXT
• If the bound graphics pipeline state was created with the DYNAMIC_STATE_VIEWPORT_WITH_COUNT_EXT dynamic state enabled, but not the DYNAMIC_STATE_VIEWPORT_SHADING_RATE_PALETTE_NV dynamic state enabled, then the bound graphics pipeline must have been created with PipelineViewportShadingRateImageStateCreateInfoNV::viewportCount greater or equal to the viewportCount parameter in the last call to cmdSetViewportWithCountEXT
• If the bound graphics pipeline state was created with the DYNAMIC_STATE_VIEWPORT_WITH_COUNT_EXT and DYNAMIC_STATE_VIEWPORT_SHADING_RATE_PALETTE_NV dynamic states enabled then the viewportCount parameter in the last call to cmdSetViewportShadingRatePaletteNV must be greater than or equal to the viewportCount parameter in the last call to cmdSetViewportWithCountEXT
• If the bound graphics pipeline state was created with the DYNAMIC_STATE_VIEWPORT_WITH_COUNT_EXT dynamic state enabled and a PipelineViewportSwizzleStateCreateInfoNV structure chained from VkPipelineVieportCreateInfo, then the bound graphics pipeline must have been created with PipelineViewportSwizzleStateCreateInfoNV::viewportCount greater or equal to the viewportCount parameter in the last call to cmdSetViewportWithCountEXT
• If the bound graphics pipeline state was created with the DYNAMIC_STATE_VIEWPORT_WITH_COUNT_EXT dynamic state enabled and a PipelineViewportExclusiveScissorStateCreateInfoNV structure chained from VkPipelineVieportCreateInfo, then the bound graphics pipeline must have been created with PipelineViewportExclusiveScissorStateCreateInfoNV::exclusiveScissorCount greater or equal to the viewportCount parameter in the last call to cmdSetViewportWithCountEXT
• If the bound graphics pipeline state was created with the DYNAMIC_STATE_PRIMITIVE_TOPOLOGY_EXT dynamic state enabled then cmdSetPrimitiveTopologyEXT must have been called in the current command buffer prior to this drawing command, and the primitiveTopology parameter of cmdSetPrimitiveTopologyEXT must be of the same topology class as the pipeline PipelineInputAssemblyStateCreateInfo::topology state
• If the bound graphics pipeline state was created with the DYNAMIC_STATE_PATCH_CONTROL_POINTS_EXT dynamic state enabled then cmdSetPatchControlPointsEXT must have been called in the current command buffer prior to this drawing command
• If the bound graphics pipeline state was created with the DYNAMIC_STATE_RASTERIZER_DISCARD_ENABLE_EXT dynamic state enabled then cmdSetRasterizerDiscardEnableEXT must have been called in the current command buffer prior to this drawing command
• If the bound graphics pipeline state was created with the DYNAMIC_STATE_DEPTH_BIAS_ENABLE_EXT dynamic state enabled then cmdSetDepthBiasEnableEXT must have been called in the current command buffer prior to this drawing command
• If the bound graphics pipeline state was created with the DYNAMIC_STATE_LOGIC_OP_EXT dynamic state enabled then cmdSetLogicOpEXT must have been called in the current command buffer prior to this drawing command and the logicOp must be a valid LogicOp value
• If the bound graphics pipeline state was created with the DYNAMIC_STATE_PRIMITIVE_RESTART_ENABLE_EXT dynamic state enabled then cmdSetPrimitiveRestartEnableEXT must have been called in the current command buffer prior to this drawing command
• If the primitiveFragmentShadingRateWithMultipleViewports limit is not supported, the bound graphics pipeline was created with the DYNAMIC_STATE_VIEWPORT_WITH_COUNT_EXT dynamic state enabled, and any of the shader stages of the bound graphics pipeline write to the PrimitiveShadingRateKHR built-in, then cmdSetViewportWithCountEXT must have been called in the current command buffer prior to this drawing command, and the viewportCount parameter of cmdSetViewportWithCountEXT must be 1
• If rasterization is not disabled in the bound graphics pipeline, then for each color attachment in the subpass, if the corresponding image view’s format features do not contain FORMAT_FEATURE_COLOR_ATTACHMENT_BLEND_BIT, then the blendEnable member of the corresponding element of the pAttachments member of pColorBlendState must be FALSE
• If rasterization is not disabled in the bound graphics pipeline, and neither the VK_AMD_mixed_attachment_samples nor the VK_NV_framebuffer_mixed_samples extensions are enabled, then PipelineMultisampleStateCreateInfo::rasterizationSamples must be the same as the current subpass color and/or depth/stencil attachments
• If the bound graphics pipeline was created with both the DYNAMIC_STATE_VERTEX_INPUT_EXT and DYNAMIC_STATE_VERTEX_INPUT_BINDING_STRIDE_EXT dynamic states enabled, then cmdSetVertexInputEXT must have been called in the current command buffer prior to this draw command
• If the bound graphics pipeline was created with the DYNAMIC_STATE_VERTEX_INPUT_BINDING_STRIDE_EXT dynamic state enabled, but not the DYNAMIC_STATE_VERTEX_INPUT_EXT dynamic state enabled, then cmdBindVertexBuffers2EXT must have been called in the current command buffer prior to this draw command, and the pStrides parameter of cmdBindVertexBuffers2EXT must not be NULL
• If the bound graphics pipeline state was created with the DYNAMIC_STATE_VERTEX_INPUT_EXT dynamic state enabled, then cmdSetVertexInputEXT must have been called in the current command buffer prior to this draw command
• If the current render pass instance was begun with cmdBeginRenderingKHR, the imageView member of pDepthAttachment is not NULL_HANDLE, and the layout member of pDepthAttachment is IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL, this command must not write any values to the depth attachment
• If the current render pass instance was begun with cmdBeginRenderingKHR, the imageView member of pStencilAttachment is not NULL_HANDLE, and the layout member of pStencilAttachment is IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL, this command must not write any values to the stencil attachment
• If the current render pass instance was begun with cmdBeginRenderingKHR, the imageView member of pDepthAttachment is not NULL_HANDLE, and the layout member of pDepthAttachment is IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL, this command must not write any values to the depth attachment
• If the current render pass instance was begun with cmdBeginRenderingKHR, the imageView member of pStencilAttachment is not NULL_HANDLE, and the layout member of pStencilAttachment is IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL, this command must not write any values to the stencil attachment
• If the current render pass instance was begun with cmdBeginRenderingKHR, the imageView member of pDepthAttachment is not NULL_HANDLE, and the layout member of pDepthAttachment is IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL, this command must not write any values to the depth attachment
• If the current render pass instance was begun with cmdBeginRenderingKHR, the imageView member of pStencilAttachment is not NULL_HANDLE, and the layout member of pStencilAttachment is IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL, this command must not write any values to the stencil attachment
• If the current render pass instance was begun with cmdBeginRenderingKHR, the currently bound graphics pipeline must have been created with a PipelineRenderingCreateInfoKHR::viewMask equal to RenderingInfoKHR::viewMask
• If the current render pass instance was begun with cmdBeginRenderingKHR, the currently bound graphics pipeline must have been created with a PipelineRenderingCreateInfoKHR::colorAttachmentCount equal to RenderingInfoKHR::colorAttachmentCount
• If the current render pass instance was begun with cmdBeginRenderingKHR and RenderingInfoKHR::colorAttachmentCount greater than 0, then each element of the RenderingInfoKHR::pColorAttachments array with a imageView not equal to NULL_HANDLE must have been created with a Format equal to the corresponding element of PipelineRenderingCreateInfoKHR::pColorAttachmentFormats used to create the currently bound graphics pipeline
• If the current render pass instance was begun with cmdBeginRenderingKHR and RenderingInfoKHR::pDepthAttachment->pname:imageView was not NULL_HANDLE, the value of PipelineRenderingCreateInfoKHR::depthAttachmentFormat used to create the currently bound graphics pipeline must be equal to the Format used to create RenderingInfoKHR::pDepthAttachment->pname:imageView
• If the current render pass instance was begun with cmdBeginRenderingKHR and RenderingInfoKHR::pStencilAttachment->pname:imageView was not NULL_HANDLE, the value of PipelineRenderingCreateInfoKHR::stencilAttachmentFormat used to create the currently bound graphics pipeline must be equal to the Format used to create RenderingInfoKHR::pStencilAttachment->pname:imageView
• If the current render pass instance was begun with cmdBeginRenderingKHR and RenderingFragmentShadingRateAttachmentInfoKHR::imageView was not NULL_HANDLE, the currently bound graphics pipeline must have been created with PIPELINE_RASTERIZATION_STATE_CREATE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR
• If the current render pass instance was begun with cmdBeginRenderingKHR and RenderingFragmentDensityMapAttachmentInfoEXT::imageView was not NULL_HANDLE, the currently bound graphics pipeline must have been created with PIPELINE_RASTERIZATION_STATE_CREATE_FRAGMENT_DENSITY_MAP_ATTACHMENT_BIT_EXT
• If the currently bound pipeline was created with a AttachmentSampleCountInfoAMD or AttachmentSampleCountInfoNV structure, and the current render pass instance was begun with cmdBeginRenderingKHR with a RenderingInfoKHR::colorAttachmentCount parameter greater than 0, then each element of the RenderingInfoKHR::pColorAttachments array with a imageView not equal to NULL_HANDLE must have been created with a sample count equal to the corresponding element of the pColorAttachmentSamples member of AttachmentSampleCountInfoAMD or AttachmentSampleCountInfoNV used to create the currently bound graphics pipeline
• If the current render pass instance was begun with cmdBeginRenderingKHR, the currently bound pipeline was created with a AttachmentSampleCountInfoAMD or AttachmentSampleCountInfoNV structure, and RenderingInfoKHR::pDepthAttachment->pname:imageView was not NULL_HANDLE, the value of the depthStencilAttachmentSamples member of AttachmentSampleCountInfoAMD or AttachmentSampleCountInfoNV used to create the currently bound graphics pipeline must be equal to the sample count used to create RenderingInfoKHR::pDepthAttachment->pname:imageView
• If the current render pass instance was begun with cmdBeginRenderingKHR, the currently bound pipeline was created with a AttachmentSampleCountInfoAMD or AttachmentSampleCountInfoNV structure, and RenderingInfoKHR::pStencilAttachment->pname:imageView was not NULL_HANDLE, the value of the depthStencilAttachmentSamples member of AttachmentSampleCountInfoAMD or AttachmentSampleCountInfoNV used to create the currently bound graphics pipeline must be equal to the sample count used to create RenderingInfoKHR::pStencilAttachment->pname:imageView
• If the currently bound pipeline was created without a AttachmentSampleCountInfoAMD or AttachmentSampleCountInfoNV structure, and the current render pass instance was begun with cmdBeginRenderingKHR with a RenderingInfoKHR::colorAttachmentCount parameter greater than 0, then each element of the RenderingInfoKHR::pColorAttachments array with a imageView not equal to NULL_HANDLE must have been created with a sample count equal to the value of PipelineMultisampleStateCreateInfo::rasterizationSamples used to create the currently bound graphics pipeline
• If the current render pass instance was begun with cmdBeginRenderingKHR, the currently bound pipeline was created without a AttachmentSampleCountInfoAMD or AttachmentSampleCountInfoNV structure, and RenderingInfoKHR::pDepthAttachment->pname:imageView was not NULL_HANDLE, the value of PipelineMultisampleStateCreateInfo::rasterizationSamples used to create the currently bound graphics pipeline must be equal to the sample count used to create RenderingInfoKHR::pDepthAttachment->pname:imageView
• If the current render pass instance was begun with cmdBeginRenderingKHR, the currently bound pipeline was created without a AttachmentSampleCountInfoAMD or AttachmentSampleCountInfoNV structure, and RenderingInfoKHR::pStencilAttachment->pname:imageView was not NULL_HANDLE, the value of PipelineMultisampleStateCreateInfo::rasterizationSamples used to create the currently bound graphics pipeline must be equal to the sample count used to create RenderingInfoKHR::pStencilAttachment->pname:imageView
• If the current render pass instance was begun with cmdBeginRenderingKHR, the currently bound pipeline must have been created with a GraphicsPipelineCreateInfo::renderPass equal to NULL_HANDLE
• If commandBuffer is a protected command buffer, any resource written to by the Pipeline object bound to the pipeline bind point used by this command must not be an unprotected resource
• If commandBuffer is a protected command buffer, pipeline stages other than the framebuffer-space and compute stages in the Pipeline object bound to the pipeline bind point used by this command must not write to any resource
• If any of the shader stages of the Pipeline bound to the pipeline bind point used by this command uses the RayQueryKHR capability, then commandBuffer must not be a protected command buffer
• All vertex input bindings accessed via vertex input variables declared in the vertex shader entry point’s interface must have either valid or NULL_HANDLE buffers bound
• 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 NULL_HANDLE
• For a given vertex buffer binding, any attribute data fetched must be entirely contained within the corresponding vertex buffer binding, as described in ???
• The multiDraw feature must be enabled
• drawCount must be less than PhysicalDeviceMultiDrawPropertiesEXT::maxMultiDrawCount
• If drawCount is greater than zero, pVertexInfo must be a valid pointer to memory containing one or more valid instances of MultiDrawInfoEXT structures
• stride must be a multiple of 4

Valid Usage (Implicit)

• commandBuffer must be a valid CommandBuffer handle

• commandBuffer must be in the recording state
• The CommandPool that commandBuffer was allocated from must support graphics operations
• This command must only be called inside of a render pass instance

Host Synchronization

• Host access to commandBuffer must be externally synchronized

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

Command Properties

'

Command Buffer Levels	Render Pass Scope	Supported Queue Types
Primary Secondary	Inside	Graphics

See Also

VK_EXT_multi_draw, CommandBuffer, MultiDrawInfoEXT

cmdDrawMultiIndexedEXT

Arguments

:: forall io. MonadIO io

=> CommandBuffer

commandBuffer is the command buffer into which the command is recorded.

-> ("indexInfo" ::: Vector MultiDrawIndexedInfoEXT)

pIndexInfo is a pointer to an array of MultiDrawIndexedInfoEXT with index information to be drawn.

-> ("instanceCount" ::: Word32)

instanceCount is the number of instances to draw.

-> ("firstInstance" ::: Word32)

firstInstance is the instance ID of the first instance to draw.

-> ("stride" ::: Word32)

stride is the byte stride between consecutive elements of pIndexInfo.

-> ("vertexOffset" ::: Maybe Int32)

pVertexOffset is NULL or a pointer to the value added to the vertex index before indexing into the vertex buffer. When specified, MultiDrawIndexedInfoEXT::offset is ignored.

-> io ()

vkCmdDrawMultiIndexedEXT - Draw primitives

Description

drawCount indexed draws are executed with parameters taken from pIndexInfo. The number of draw commands recorded is drawCount, with each command reading, sequentially, a firstIndex and an indexCount from pIndexInfo. If pVertexOffset is NULL, a vertexOffset is also read from pIndexInfo, otherwise the value from dereferencing pVertexOffset is used.

Valid Usage

• If a Sampler created with magFilter or minFilter equal to FILTER_LINEAR and compareEnable equal to FALSE is used to sample a ImageView as a result of this command, then the image view’s format features must contain FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT

• If a Sampler created with mipmapMode equal to SAMPLER_MIPMAP_MODE_LINEAR and compareEnable equal to FALSE is used to sample a ImageView as a result of this command, then the image view’s format features must contain FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT
• If a ImageView 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 ImageView 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
• Any ImageView being sampled with FILTER_CUBIC_EXT as a result of this command must have a ImageViewType and format that supports cubic filtering, as specified by FilterCubicImageViewImageFormatPropertiesEXT::filterCubic returned by getPhysicalDeviceImageFormatProperties2
• Any ImageView 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 ImageViewType and format that supports cubic filtering together with minmax filtering, as specified by FilterCubicImageViewImageFormatPropertiesEXT::filterCubicMinmax returned by getPhysicalDeviceImageFormatProperties2
• Any Image created with a ImageCreateInfo::flags containing IMAGE_CREATE_CORNER_SAMPLED_BIT_NV sampled as a result of this command must only be sampled using a SamplerAddressMode of SAMPLER_ADDRESS_MODE_CLAMP_TO_EDGE
• Any ImageView or BufferView being written as a storage image or storage texel buffer where the image format field of the OpTypeImage is Unknown must have image format features that support FORMAT_FEATURE_2_STORAGE_WRITE_WITHOUT_FORMAT_BIT_KHR
• Any ImageView or BufferView being read as a storage image or storage texel buffer where the image format field of the OpTypeImage is Unknown must have image format features that support FORMAT_FEATURE_2_STORAGE_READ_WITHOUT_FORMAT_BIT_KHR
• For each set n that is statically used by the Pipeline 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 a PipelineLayout that is compatible for set n, with the PipelineLayout used to create the current Pipeline, as described in ???
• If the maintenance4 feature is not enabled, then for each push constant that is statically used by the Pipeline 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 a PipelineLayout that is compatible for push constants, with the PipelineLayout used to create the current Pipeline, as described in ???
• Descriptors in each bound descriptor set, specified via cmdBindDescriptorSets, must be valid if they are statically used by the Pipeline bound to the pipeline bind point used by this command
• A valid pipeline must be bound to the pipeline bind point used by this command
• If the Pipeline object bound to the pipeline bind point used by this command requires any dynamic state, that state must have been set or inherited (if the VK_NV_inherited_viewport_scissor extension is enabled) for commandBuffer, and done so after any previously bound pipeline with the corresponding state not specified as dynamic
• There must not have been any calls to dynamic state setting commands for any state not specified as dynamic in the Pipeline object bound to the pipeline bind point used by this command, since that pipeline was bound
• If the Pipeline object bound to the pipeline bind point used by this command accesses a Sampler object that uses unnormalized coordinates, that sampler must not be used to sample from any Image with a ImageView of the type IMAGE_VIEW_TYPE_3D, IMAGE_VIEW_TYPE_CUBE, IMAGE_VIEW_TYPE_1D_ARRAY, IMAGE_VIEW_TYPE_2D_ARRAY or IMAGE_VIEW_TYPE_CUBE_ARRAY, in any shader stage
• If the Pipeline object bound to the pipeline bind point used by this command accesses a Sampler object that uses unnormalized coordinates, that sampler must not be used with any of the SPIR-V OpImageSample* or OpImageSparseSample* instructions with ImplicitLod, Dref or Proj in their name, in any shader stage
• If the Pipeline object bound to the pipeline bind point used by this command accesses a Sampler object that uses unnormalized coordinates, that sampler must not be used with any of the SPIR-V OpImageSample* or OpImageSparseSample* instructions that includes a LOD bias or any offset values, in any shader stage
• If the robust buffer access feature is not enabled, and if the Pipeline 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
• If the robust buffer access feature is not enabled, and if the Pipeline 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
• If commandBuffer is an unprotected command buffer, any resource accessed by the Pipeline object bound to the pipeline bind point used by this command must not be a protected resource
• If a ImageView 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 BufferView 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 ImageView with a Format 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 ImageView with a Format 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 BufferView with a Format 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 BufferView with a Format 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, Image 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, Buffer 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
• The current render pass must be compatible with the renderPass member of the GraphicsPipelineCreateInfo structure specified when creating the Pipeline bound to PIPELINE_BIND_POINT_GRAPHICS
• The subpass index of the current render pass must be equal to the subpass member of the GraphicsPipelineCreateInfo structure specified when creating the Pipeline bound to PIPELINE_BIND_POINT_GRAPHICS
• Every input attachment used by the current subpass must be bound to the pipeline via a descriptor set
• 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, except for cases involving read-only access to depth/stencil attachments as described in the Render Pass chapter
• If the draw is recorded in a render pass instance with multiview enabled, the maximum instance index must be less than or equal to PhysicalDeviceMultiviewProperties::maxMultiviewInstanceIndex
• If the bound graphics pipeline was created with PipelineSampleLocationsStateCreateInfoEXT::sampleLocationsEnable set to TRUE and the current subpass has a depth/stencil attachment, then that attachment must have been created with the IMAGE_CREATE_SAMPLE_LOCATIONS_COMPATIBLE_DEPTH_BIT_EXT bit set
• If the bound graphics pipeline state was created with the DYNAMIC_STATE_VIEWPORT_WITH_COUNT_EXT dynamic state enabled, but not the DYNAMIC_STATE_SCISSOR_WITH_COUNT_EXT dynamic state enabled, then cmdSetViewportWithCountEXT must have been called in the current command buffer prior to this drawing command, and the viewportCount parameter of cmdSetViewportWithCountEXT must match the PipelineViewportStateCreateInfo::scissorCount of the pipeline
• If the bound graphics pipeline state was created with the DYNAMIC_STATE_SCISSOR_WITH_COUNT_EXT dynamic state enabled, but not the DYNAMIC_STATE_VIEWPORT_WITH_COUNT_EXT dynamic state enabled, then cmdSetScissorWithCountEXT must have been called in the current command buffer prior to this drawing command, and the scissorCount parameter of cmdSetScissorWithCountEXT must match the PipelineViewportStateCreateInfo::viewportCount of the pipeline
• If the bound graphics pipeline state was created with both the DYNAMIC_STATE_SCISSOR_WITH_COUNT_EXT and DYNAMIC_STATE_VIEWPORT_WITH_COUNT_EXT dynamic states enabled then both cmdSetViewportWithCountEXT and cmdSetScissorWithCountEXT must have been called in the current command buffer prior to this drawing command, and the viewportCount parameter of cmdSetViewportWithCountEXT must match the scissorCount parameter of cmdSetScissorWithCountEXT
• If the bound graphics pipeline state was created with the DYNAMIC_STATE_VIEWPORT_WITH_COUNT_EXT dynamic state enabled, but not the DYNAMIC_STATE_VIEWPORT_W_SCALING_NV dynamic state enabled, then the bound graphics pipeline must have been created with PipelineViewportWScalingStateCreateInfoNV::viewportCount greater or equal to the viewportCount parameter in the last call to cmdSetViewportWithCountEXT
• If the bound graphics pipeline state was created with the DYNAMIC_STATE_VIEWPORT_WITH_COUNT_EXT and DYNAMIC_STATE_VIEWPORT_W_SCALING_NV dynamic states enabled then the viewportCount parameter in the last call to cmdSetViewportWScalingNV must be greater than or equal to the viewportCount parameter in the last call to cmdSetViewportWithCountEXT
• If the bound graphics pipeline state was created with the DYNAMIC_STATE_VIEWPORT_WITH_COUNT_EXT dynamic state enabled, but not the DYNAMIC_STATE_VIEWPORT_SHADING_RATE_PALETTE_NV dynamic state enabled, then the bound graphics pipeline must have been created with PipelineViewportShadingRateImageStateCreateInfoNV::viewportCount greater or equal to the viewportCount parameter in the last call to cmdSetViewportWithCountEXT
• If the bound graphics pipeline state was created with the DYNAMIC_STATE_VIEWPORT_WITH_COUNT_EXT and DYNAMIC_STATE_VIEWPORT_SHADING_RATE_PALETTE_NV dynamic states enabled then the viewportCount parameter in the last call to cmdSetViewportShadingRatePaletteNV must be greater than or equal to the viewportCount parameter in the last call to cmdSetViewportWithCountEXT
• If the bound graphics pipeline state was created with the DYNAMIC_STATE_VIEWPORT_WITH_COUNT_EXT dynamic state enabled and a PipelineViewportSwizzleStateCreateInfoNV structure chained from VkPipelineVieportCreateInfo, then the bound graphics pipeline must have been created with PipelineViewportSwizzleStateCreateInfoNV::viewportCount greater or equal to the viewportCount parameter in the last call to cmdSetViewportWithCountEXT
• If the bound graphics pipeline state was created with the DYNAMIC_STATE_VIEWPORT_WITH_COUNT_EXT dynamic state enabled and a PipelineViewportExclusiveScissorStateCreateInfoNV structure chained from VkPipelineVieportCreateInfo, then the bound graphics pipeline must have been created with PipelineViewportExclusiveScissorStateCreateInfoNV::exclusiveScissorCount greater or equal to the viewportCount parameter in the last call to cmdSetViewportWithCountEXT
• If the bound graphics pipeline state was created with the DYNAMIC_STATE_PRIMITIVE_TOPOLOGY_EXT dynamic state enabled then cmdSetPrimitiveTopologyEXT must have been called in the current command buffer prior to this drawing command, and the primitiveTopology parameter of cmdSetPrimitiveTopologyEXT must be of the same topology class as the pipeline PipelineInputAssemblyStateCreateInfo::topology state
• If the bound graphics pipeline state was created with the DYNAMIC_STATE_PATCH_CONTROL_POINTS_EXT dynamic state enabled then cmdSetPatchControlPointsEXT must have been called in the current command buffer prior to this drawing command
• If the bound graphics pipeline state was created with the DYNAMIC_STATE_RASTERIZER_DISCARD_ENABLE_EXT dynamic state enabled then cmdSetRasterizerDiscardEnableEXT must have been called in the current command buffer prior to this drawing command
• If the bound graphics pipeline state was created with the DYNAMIC_STATE_DEPTH_BIAS_ENABLE_EXT dynamic state enabled then cmdSetDepthBiasEnableEXT must have been called in the current command buffer prior to this drawing command
• If the bound graphics pipeline state was created with the DYNAMIC_STATE_LOGIC_OP_EXT dynamic state enabled then cmdSetLogicOpEXT must have been called in the current command buffer prior to this drawing command and the logicOp must be a valid LogicOp value
• If the bound graphics pipeline state was created with the DYNAMIC_STATE_PRIMITIVE_RESTART_ENABLE_EXT dynamic state enabled then cmdSetPrimitiveRestartEnableEXT must have been called in the current command buffer prior to this drawing command
• If the primitiveFragmentShadingRateWithMultipleViewports limit is not supported, the bound graphics pipeline was created with the DYNAMIC_STATE_VIEWPORT_WITH_COUNT_EXT dynamic state enabled, and any of the shader stages of the bound graphics pipeline write to the PrimitiveShadingRateKHR built-in, then cmdSetViewportWithCountEXT must have been called in the current command buffer prior to this drawing command, and the viewportCount parameter of cmdSetViewportWithCountEXT must be 1
• If rasterization is not disabled in the bound graphics pipeline, then for each color attachment in the subpass, if the corresponding image view’s format features do not contain FORMAT_FEATURE_COLOR_ATTACHMENT_BLEND_BIT, then the blendEnable member of the corresponding element of the pAttachments member of pColorBlendState must be FALSE
• If rasterization is not disabled in the bound graphics pipeline, and neither the VK_AMD_mixed_attachment_samples nor the VK_NV_framebuffer_mixed_samples extensions are enabled, then PipelineMultisampleStateCreateInfo::rasterizationSamples must be the same as the current subpass color and/or depth/stencil attachments
• If the bound graphics pipeline was created with both the DYNAMIC_STATE_VERTEX_INPUT_EXT and DYNAMIC_STATE_VERTEX_INPUT_BINDING_STRIDE_EXT dynamic states enabled, then cmdSetVertexInputEXT must have been called in the current command buffer prior to this draw command
• If the bound graphics pipeline was created with the DYNAMIC_STATE_VERTEX_INPUT_BINDING_STRIDE_EXT dynamic state enabled, but not the DYNAMIC_STATE_VERTEX_INPUT_EXT dynamic state enabled, then cmdBindVertexBuffers2EXT must have been called in the current command buffer prior to this draw command, and the pStrides parameter of cmdBindVertexBuffers2EXT must not be NULL
• If the bound graphics pipeline state was created with the DYNAMIC_STATE_VERTEX_INPUT_EXT dynamic state enabled, then cmdSetVertexInputEXT must have been called in the current command buffer prior to this draw command
• If the current render pass instance was begun with cmdBeginRenderingKHR, the imageView member of pDepthAttachment is not NULL_HANDLE, and the layout member of pDepthAttachment is IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL, this command must not write any values to the depth attachment
• If the current render pass instance was begun with cmdBeginRenderingKHR, the imageView member of pStencilAttachment is not NULL_HANDLE, and the layout member of pStencilAttachment is IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL, this command must not write any values to the stencil attachment
• If the current render pass instance was begun with cmdBeginRenderingKHR, the imageView member of pDepthAttachment is not NULL_HANDLE, and the layout member of pDepthAttachment is IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL, this command must not write any values to the depth attachment
• If the current render pass instance was begun with cmdBeginRenderingKHR, the imageView member of pStencilAttachment is not NULL_HANDLE, and the layout member of pStencilAttachment is IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL, this command must not write any values to the stencil attachment
• If the current render pass instance was begun with cmdBeginRenderingKHR, the imageView member of pDepthAttachment is not NULL_HANDLE, and the layout member of pDepthAttachment is IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL, this command must not write any values to the depth attachment
• If the current render pass instance was begun with cmdBeginRenderingKHR, the imageView member of pStencilAttachment is not NULL_HANDLE, and the layout member of pStencilAttachment is IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL, this command must not write any values to the stencil attachment
• If the current render pass instance was begun with cmdBeginRenderingKHR, the currently bound graphics pipeline must have been created with a PipelineRenderingCreateInfoKHR::viewMask equal to RenderingInfoKHR::viewMask
• If the current render pass instance was begun with cmdBeginRenderingKHR, the currently bound graphics pipeline must have been created with a PipelineRenderingCreateInfoKHR::colorAttachmentCount equal to RenderingInfoKHR::colorAttachmentCount
• If the current render pass instance was begun with cmdBeginRenderingKHR and RenderingInfoKHR::colorAttachmentCount greater than 0, then each element of the RenderingInfoKHR::pColorAttachments array with a imageView not equal to NULL_HANDLE must have been created with a Format equal to the corresponding element of PipelineRenderingCreateInfoKHR::pColorAttachmentFormats used to create the currently bound graphics pipeline
• If the current render pass instance was begun with cmdBeginRenderingKHR and RenderingInfoKHR::pDepthAttachment->pname:imageView was not NULL_HANDLE, the value of PipelineRenderingCreateInfoKHR::depthAttachmentFormat used to create the currently bound graphics pipeline must be equal to the Format used to create RenderingInfoKHR::pDepthAttachment->pname:imageView
• If the current render pass instance was begun with cmdBeginRenderingKHR and RenderingInfoKHR::pStencilAttachment->pname:imageView was not NULL_HANDLE, the value of PipelineRenderingCreateInfoKHR::stencilAttachmentFormat used to create the currently bound graphics pipeline must be equal to the Format used to create RenderingInfoKHR::pStencilAttachment->pname:imageView
• If the current render pass instance was begun with cmdBeginRenderingKHR and RenderingFragmentShadingRateAttachmentInfoKHR::imageView was not NULL_HANDLE, the currently bound graphics pipeline must have been created with PIPELINE_RASTERIZATION_STATE_CREATE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR
• If the current render pass instance was begun with cmdBeginRenderingKHR and RenderingFragmentDensityMapAttachmentInfoEXT::imageView was not NULL_HANDLE, the currently bound graphics pipeline must have been created with PIPELINE_RASTERIZATION_STATE_CREATE_FRAGMENT_DENSITY_MAP_ATTACHMENT_BIT_EXT
• If the currently bound pipeline was created with a AttachmentSampleCountInfoAMD or AttachmentSampleCountInfoNV structure, and the current render pass instance was begun with cmdBeginRenderingKHR with a RenderingInfoKHR::colorAttachmentCount parameter greater than 0, then each element of the RenderingInfoKHR::pColorAttachments array with a imageView not equal to NULL_HANDLE must have been created with a sample count equal to the corresponding element of the pColorAttachmentSamples member of AttachmentSampleCountInfoAMD or AttachmentSampleCountInfoNV used to create the currently bound graphics pipeline
• If the current render pass instance was begun with cmdBeginRenderingKHR, the currently bound pipeline was created with a AttachmentSampleCountInfoAMD or AttachmentSampleCountInfoNV structure, and RenderingInfoKHR::pDepthAttachment->pname:imageView was not NULL_HANDLE, the value of the depthStencilAttachmentSamples member of AttachmentSampleCountInfoAMD or AttachmentSampleCountInfoNV used to create the currently bound graphics pipeline must be equal to the sample count used to create RenderingInfoKHR::pDepthAttachment->pname:imageView
• If the current render pass instance was begun with cmdBeginRenderingKHR, the currently bound pipeline was created with a AttachmentSampleCountInfoAMD or AttachmentSampleCountInfoNV structure, and RenderingInfoKHR::pStencilAttachment->pname:imageView was not NULL_HANDLE, the value of the depthStencilAttachmentSamples member of AttachmentSampleCountInfoAMD or AttachmentSampleCountInfoNV used to create the currently bound graphics pipeline must be equal to the sample count used to create RenderingInfoKHR::pStencilAttachment->pname:imageView
• If the currently bound pipeline was created without a AttachmentSampleCountInfoAMD or AttachmentSampleCountInfoNV structure, and the current render pass instance was begun with cmdBeginRenderingKHR with a RenderingInfoKHR::colorAttachmentCount parameter greater than 0, then each element of the RenderingInfoKHR::pColorAttachments array with a imageView not equal to NULL_HANDLE must have been created with a sample count equal to the value of PipelineMultisampleStateCreateInfo::rasterizationSamples used to create the currently bound graphics pipeline
• If the current render pass instance was begun with cmdBeginRenderingKHR, the currently bound pipeline was created without a AttachmentSampleCountInfoAMD or AttachmentSampleCountInfoNV structure, and RenderingInfoKHR::pDepthAttachment->pname:imageView was not NULL_HANDLE, the value of PipelineMultisampleStateCreateInfo::rasterizationSamples used to create the currently bound graphics pipeline must be equal to the sample count used to create RenderingInfoKHR::pDepthAttachment->pname:imageView
• If the current render pass instance was begun with cmdBeginRenderingKHR, the currently bound pipeline was created without a AttachmentSampleCountInfoAMD or AttachmentSampleCountInfoNV structure, and RenderingInfoKHR::pStencilAttachment->pname:imageView was not NULL_HANDLE, the value of PipelineMultisampleStateCreateInfo::rasterizationSamples used to create the currently bound graphics pipeline must be equal to the sample count used to create RenderingInfoKHR::pStencilAttachment->pname:imageView
• If the current render pass instance was begun with cmdBeginRenderingKHR, the currently bound pipeline must have been created with a GraphicsPipelineCreateInfo::renderPass equal to NULL_HANDLE
• If commandBuffer is a protected command buffer, any resource written to by the Pipeline object bound to the pipeline bind point used by this command must not be an unprotected resource
• If commandBuffer is a protected command buffer, pipeline stages other than the framebuffer-space and compute stages in the Pipeline object bound to the pipeline bind point used by this command must not write to any resource
• If any of the shader stages of the Pipeline bound to the pipeline bind point used by this command uses the RayQueryKHR capability, then commandBuffer must not be a protected command buffer
• All vertex input bindings accessed via vertex input variables declared in the vertex shader entry point’s interface must have either valid or NULL_HANDLE buffers bound
• 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 NULL_HANDLE
• For a given vertex buffer binding, any attribute data fetched must be entirely contained within the corresponding vertex buffer binding, as described in ???
• The multiDraw feature must be enabled
• (indexSize × (firstIndex + indexCount) + offset) must be less than or equal to the size of the bound index buffer, with indexSize being based on the type specified by indexType, where the index buffer, indexType, and offset are specified via cmdBindIndexBuffer
• drawCount must be less than PhysicalDeviceMultiDrawPropertiesEXT::maxMultiDrawCount
• If drawCount is greater than zero, pIndexInfo must be a valid pointer to memory containing one or more valid instances of MultiDrawIndexedInfoEXT structures
• stride must be a multiple of 4

Valid Usage (Implicit)

• commandBuffer must be a valid CommandBuffer handle

• If pVertexOffset is not NULL, pVertexOffset must be a valid pointer to a valid int32_t value
• commandBuffer must be in the recording state
• The CommandPool that commandBuffer was allocated from must support graphics operations
• This command must only be called inside of a render pass instance

Host Synchronization

• Host access to commandBuffer must be externally synchronized

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

Command Properties

'

Command Buffer Levels	Render Pass Scope	Supported Queue Types
Primary Secondary	Inside	Graphics

See Also

VK_EXT_multi_draw, CommandBuffer, MultiDrawIndexedInfoEXT

data MultiDrawInfoEXT

VkMultiDrawInfoEXT - Structure specifying a multi-draw command

Description

The members of MultiDrawInfoEXT have the same meaning as the firstVertex and vertexCount parameters in cmdDraw.

See Also

VK_EXT_multi_draw, cmdDrawMultiEXT

Constructors

MultiDrawInfoEXT

Fields

• firstVertex :: Word32

  firstVertex is the first vertex to draw.

• vertexCount :: Word32

  vertexCount is the number of vertices to draw.

Instances

Eq MultiDrawInfoEXT

Defined in Vulkan.Extensions.VK_EXT_multi_draw

Methods

(==) :: MultiDrawInfoEXT -> MultiDrawInfoEXT -> Bool

(/=) :: MultiDrawInfoEXT -> MultiDrawInfoEXT -> Bool

Show MultiDrawInfoEXT

Defined in Vulkan.Extensions.VK_EXT_multi_draw

Methods

showsPrec :: Int -> MultiDrawInfoEXT -> ShowS

show :: MultiDrawInfoEXT -> String

showList :: [MultiDrawInfoEXT] -> ShowS

Storable MultiDrawInfoEXT

Defined in Vulkan.Extensions.VK_EXT_multi_draw

Methods

sizeOf :: MultiDrawInfoEXT -> Int

alignment :: MultiDrawInfoEXT -> Int

peekElemOff :: Ptr MultiDrawInfoEXT -> Int -> IO MultiDrawInfoEXT

pokeElemOff :: Ptr MultiDrawInfoEXT -> Int -> MultiDrawInfoEXT -> IO ()

peekByteOff :: Ptr b -> Int -> IO MultiDrawInfoEXT

pokeByteOff :: Ptr b -> Int -> MultiDrawInfoEXT -> IO ()

peek :: Ptr MultiDrawInfoEXT -> IO MultiDrawInfoEXT

poke :: Ptr MultiDrawInfoEXT -> MultiDrawInfoEXT -> IO ()

FromCStruct MultiDrawInfoEXT

Defined in Vulkan.Extensions.VK_EXT_multi_draw

Methods

peekCStruct :: Ptr MultiDrawInfoEXT -> IO MultiDrawInfoEXT

ToCStruct MultiDrawInfoEXT

Defined in Vulkan.Extensions.VK_EXT_multi_draw

Methods

withCStruct :: MultiDrawInfoEXT -> (Ptr MultiDrawInfoEXT -> IO b) -> IO b

pokeCStruct :: Ptr MultiDrawInfoEXT -> MultiDrawInfoEXT -> IO b -> IO b

withZeroCStruct :: (Ptr MultiDrawInfoEXT -> IO b) -> IO b

pokeZeroCStruct :: Ptr MultiDrawInfoEXT -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero MultiDrawInfoEXT

Defined in Vulkan.Extensions.VK_EXT_multi_draw

Methods

zero :: MultiDrawInfoEXT

data MultiDrawIndexedInfoEXT

VkMultiDrawIndexedInfoEXT - Structure specifying a multi-draw command

Description

The firstIndex, indexCount, and vertexOffset members of MultiDrawIndexedInfoEXT have the same meaning as the firstIndex, indexCount, and vertexOffset parameters, respectively, of cmdDrawIndexed.

See Also

VK_EXT_multi_draw, cmdDrawMultiIndexedEXT

Constructors

MultiDrawIndexedInfoEXT

Fields

• firstIndex :: Word32

  firstIndex is the first index to draw.

• indexCount :: Word32

  indexCount is the number of vertices to draw.

• vertexOffset :: Int32

  vertexOffset is the value added to the vertex index before indexing into the vertex buffer for indexed multidraws.

Instances

Eq MultiDrawIndexedInfoEXT

Defined in Vulkan.Extensions.VK_EXT_multi_draw

Methods

(==) :: MultiDrawIndexedInfoEXT -> MultiDrawIndexedInfoEXT -> Bool

(/=) :: MultiDrawIndexedInfoEXT -> MultiDrawIndexedInfoEXT -> Bool

Show MultiDrawIndexedInfoEXT

Defined in Vulkan.Extensions.VK_EXT_multi_draw

Methods

showsPrec :: Int -> MultiDrawIndexedInfoEXT -> ShowS

show :: MultiDrawIndexedInfoEXT -> String

showList :: [MultiDrawIndexedInfoEXT] -> ShowS

Storable MultiDrawIndexedInfoEXT

Defined in Vulkan.Extensions.VK_EXT_multi_draw

Methods

sizeOf :: MultiDrawIndexedInfoEXT -> Int

alignment :: MultiDrawIndexedInfoEXT -> Int

peekElemOff :: Ptr MultiDrawIndexedInfoEXT -> Int -> IO MultiDrawIndexedInfoEXT

pokeElemOff :: Ptr MultiDrawIndexedInfoEXT -> Int -> MultiDrawIndexedInfoEXT -> IO ()

peekByteOff :: Ptr b -> Int -> IO MultiDrawIndexedInfoEXT

pokeByteOff :: Ptr b -> Int -> MultiDrawIndexedInfoEXT -> IO ()

peek :: Ptr MultiDrawIndexedInfoEXT -> IO MultiDrawIndexedInfoEXT

poke :: Ptr MultiDrawIndexedInfoEXT -> MultiDrawIndexedInfoEXT -> IO ()

FromCStruct MultiDrawIndexedInfoEXT

Defined in Vulkan.Extensions.VK_EXT_multi_draw

Methods

peekCStruct :: Ptr MultiDrawIndexedInfoEXT -> IO MultiDrawIndexedInfoEXT

ToCStruct MultiDrawIndexedInfoEXT

Defined in Vulkan.Extensions.VK_EXT_multi_draw

Methods

withCStruct :: MultiDrawIndexedInfoEXT -> (Ptr MultiDrawIndexedInfoEXT -> IO b) -> IO b

pokeCStruct :: Ptr MultiDrawIndexedInfoEXT -> MultiDrawIndexedInfoEXT -> IO b -> IO b

withZeroCStruct :: (Ptr MultiDrawIndexedInfoEXT -> IO b) -> IO b

pokeZeroCStruct :: Ptr MultiDrawIndexedInfoEXT -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero MultiDrawIndexedInfoEXT

Defined in Vulkan.Extensions.VK_EXT_multi_draw

Methods

zero :: MultiDrawIndexedInfoEXT

data PhysicalDeviceMultiDrawPropertiesEXT

VkPhysicalDeviceMultiDrawPropertiesEXT - Structure describing multidraw limits of an implementation

Members

The members of the PhysicalDeviceMultiDrawPropertiesEXT structure describe the following features:

Description

If the VkPhysicalDeviceMultiDrawPropertiesPropertiesEXT structure is included in the pNext chain of the PhysicalDeviceProperties2 structure passed to getPhysicalDeviceProperties2, it is filled in with each corresponding implementation-dependent property.

Valid Usage (Implicit)

See Also

VK_EXT_multi_draw, StructureType

Constructors

PhysicalDeviceMultiDrawPropertiesEXT

Fields

• maxMultiDrawCount :: Word32

  maxMultiDrawCount indicates the maximum number of draw calls which can be batched into a single multidraw.

Instances

Eq PhysicalDeviceMultiDrawPropertiesEXT

Defined in Vulkan.Extensions.VK_EXT_multi_draw

Methods

(==) :: PhysicalDeviceMultiDrawPropertiesEXT -> PhysicalDeviceMultiDrawPropertiesEXT -> Bool

(/=) :: PhysicalDeviceMultiDrawPropertiesEXT -> PhysicalDeviceMultiDrawPropertiesEXT -> Bool

Show PhysicalDeviceMultiDrawPropertiesEXT

Defined in Vulkan.Extensions.VK_EXT_multi_draw

Methods

showsPrec :: Int -> PhysicalDeviceMultiDrawPropertiesEXT -> ShowS

show :: PhysicalDeviceMultiDrawPropertiesEXT -> String

showList :: [PhysicalDeviceMultiDrawPropertiesEXT] -> ShowS

Storable PhysicalDeviceMultiDrawPropertiesEXT

Defined in Vulkan.Extensions.VK_EXT_multi_draw

Methods

sizeOf :: PhysicalDeviceMultiDrawPropertiesEXT -> Int

alignment :: PhysicalDeviceMultiDrawPropertiesEXT -> Int

peekElemOff :: Ptr PhysicalDeviceMultiDrawPropertiesEXT -> Int -> IO PhysicalDeviceMultiDrawPropertiesEXT

pokeElemOff :: Ptr PhysicalDeviceMultiDrawPropertiesEXT -> Int -> PhysicalDeviceMultiDrawPropertiesEXT -> IO ()

peekByteOff :: Ptr b -> Int -> IO PhysicalDeviceMultiDrawPropertiesEXT

pokeByteOff :: Ptr b -> Int -> PhysicalDeviceMultiDrawPropertiesEXT -> IO ()

peek :: Ptr PhysicalDeviceMultiDrawPropertiesEXT -> IO PhysicalDeviceMultiDrawPropertiesEXT

poke :: Ptr PhysicalDeviceMultiDrawPropertiesEXT -> PhysicalDeviceMultiDrawPropertiesEXT -> IO ()

FromCStruct PhysicalDeviceMultiDrawPropertiesEXT

Defined in Vulkan.Extensions.VK_EXT_multi_draw

Methods

peekCStruct :: Ptr PhysicalDeviceMultiDrawPropertiesEXT -> IO PhysicalDeviceMultiDrawPropertiesEXT

ToCStruct PhysicalDeviceMultiDrawPropertiesEXT

Defined in Vulkan.Extensions.VK_EXT_multi_draw

Methods

withCStruct :: PhysicalDeviceMultiDrawPropertiesEXT -> (Ptr PhysicalDeviceMultiDrawPropertiesEXT -> IO b) -> IO b

pokeCStruct :: Ptr PhysicalDeviceMultiDrawPropertiesEXT -> PhysicalDeviceMultiDrawPropertiesEXT -> IO b -> IO b

withZeroCStruct :: (Ptr PhysicalDeviceMultiDrawPropertiesEXT -> IO b) -> IO b

pokeZeroCStruct :: Ptr PhysicalDeviceMultiDrawPropertiesEXT -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero PhysicalDeviceMultiDrawPropertiesEXT

Defined in Vulkan.Extensions.VK_EXT_multi_draw

Methods

zero :: PhysicalDeviceMultiDrawPropertiesEXT

data PhysicalDeviceMultiDrawFeaturesEXT

VkPhysicalDeviceMultiDrawFeaturesEXT - Structure describing whether the implementation supports multi draw functionality

Members

The members of the PhysicalDeviceMultiDrawFeaturesEXT structure describe the following features:

Description

If the PhysicalDeviceMultiDrawFeaturesEXT structure is included in the pNext chain of the PhysicalDeviceFeatures2 structure passed to getPhysicalDeviceFeatures2, it is filled in to indicate whether each corresponding feature is supported. PhysicalDeviceMultiDrawFeaturesEXT can also be used in the pNext chain of DeviceCreateInfo to selectively enable these features.

Valid Usage (Implicit)

See Also

VK_EXT_multi_draw, Bool32, StructureType

Constructors

PhysicalDeviceMultiDrawFeaturesEXT

Fields

• multiDraw :: Bool

  multiDraw indicates that the implementation supports cmdDrawMultiEXT and cmdDrawMultiIndexedEXT.

Instances

Eq PhysicalDeviceMultiDrawFeaturesEXT

Defined in Vulkan.Extensions.VK_EXT_multi_draw

Methods

(==) :: PhysicalDeviceMultiDrawFeaturesEXT -> PhysicalDeviceMultiDrawFeaturesEXT -> Bool

(/=) :: PhysicalDeviceMultiDrawFeaturesEXT -> PhysicalDeviceMultiDrawFeaturesEXT -> Bool

Show PhysicalDeviceMultiDrawFeaturesEXT

Defined in Vulkan.Extensions.VK_EXT_multi_draw

Methods

showsPrec :: Int -> PhysicalDeviceMultiDrawFeaturesEXT -> ShowS

show :: PhysicalDeviceMultiDrawFeaturesEXT -> String

showList :: [PhysicalDeviceMultiDrawFeaturesEXT] -> ShowS

Storable PhysicalDeviceMultiDrawFeaturesEXT

Defined in Vulkan.Extensions.VK_EXT_multi_draw

Methods

sizeOf :: PhysicalDeviceMultiDrawFeaturesEXT -> Int

alignment :: PhysicalDeviceMultiDrawFeaturesEXT -> Int

peekElemOff :: Ptr PhysicalDeviceMultiDrawFeaturesEXT -> Int -> IO PhysicalDeviceMultiDrawFeaturesEXT

pokeElemOff :: Ptr PhysicalDeviceMultiDrawFeaturesEXT -> Int -> PhysicalDeviceMultiDrawFeaturesEXT -> IO ()

peekByteOff :: Ptr b -> Int -> IO PhysicalDeviceMultiDrawFeaturesEXT

pokeByteOff :: Ptr b -> Int -> PhysicalDeviceMultiDrawFeaturesEXT -> IO ()

peek :: Ptr PhysicalDeviceMultiDrawFeaturesEXT -> IO PhysicalDeviceMultiDrawFeaturesEXT

poke :: Ptr PhysicalDeviceMultiDrawFeaturesEXT -> PhysicalDeviceMultiDrawFeaturesEXT -> IO ()

FromCStruct PhysicalDeviceMultiDrawFeaturesEXT

Defined in Vulkan.Extensions.VK_EXT_multi_draw

Methods

peekCStruct :: Ptr PhysicalDeviceMultiDrawFeaturesEXT -> IO PhysicalDeviceMultiDrawFeaturesEXT

ToCStruct PhysicalDeviceMultiDrawFeaturesEXT

Defined in Vulkan.Extensions.VK_EXT_multi_draw

Methods

withCStruct :: PhysicalDeviceMultiDrawFeaturesEXT -> (Ptr PhysicalDeviceMultiDrawFeaturesEXT -> IO b) -> IO b

pokeCStruct :: Ptr PhysicalDeviceMultiDrawFeaturesEXT -> PhysicalDeviceMultiDrawFeaturesEXT -> IO b -> IO b

withZeroCStruct :: (Ptr PhysicalDeviceMultiDrawFeaturesEXT -> IO b) -> IO b

pokeZeroCStruct :: Ptr PhysicalDeviceMultiDrawFeaturesEXT -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero PhysicalDeviceMultiDrawFeaturesEXT

Defined in Vulkan.Extensions.VK_EXT_multi_draw

Methods

zero :: PhysicalDeviceMultiDrawFeaturesEXT

type EXT_MULTI_DRAW_SPEC_VERSION = 1

pattern EXT_MULTI_DRAW_SPEC_VERSION :: forall a. Integral a => a

type EXT_MULTI_DRAW_EXTENSION_NAME = "VK_EXT_multi_draw"

pattern EXT_MULTI_DRAW_EXTENSION_NAME :: forall a. (Eq a, IsString a) => a