Package org.lwjgl.vulkan

Class EXTMultiDraw

java.lang.Object

org.lwjgl.vulkan.EXTMultiDraw

public class EXTMultiDraw
extends java.lang.Object

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 VkMultiDrawInfoEXT or VkMultiDrawIndexedInfoEXT structs with vkCmdDrawMultiEXT or vkCmdDrawMultiIndexedEXT, 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.

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

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

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	VK_EXT_MULTI_DRAW_EXTENSION_NAME	The extension name.
static int	VK_EXT_MULTI_DRAW_SPEC_VERSION	The extension specification version.
static int	VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_MULTI_DRAW_FEATURES_EXT VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_MULTI_DRAW_PROPERTIES_EXT	Extends VkStructureType.

Method Summary

Modifier and Type	Method	Description
static void	nvkCmdDrawMultiEXT(org.lwjgl.vulkan.VkCommandBuffer commandBuffer, int drawCount, long pVertexInfo, int instanceCount, int firstInstance, int stride)	Unsafe version of: CmdDrawMultiEXT
static void	nvkCmdDrawMultiIndexedEXT(org.lwjgl.vulkan.VkCommandBuffer commandBuffer, int drawCount, long pIndexInfo, int instanceCount, int firstInstance, int stride, long pVertexOffset)	Unsafe version of: CmdDrawMultiIndexedEXT
static void	vkCmdDrawMultiEXT(org.lwjgl.vulkan.VkCommandBuffer commandBuffer, VkMultiDrawInfoEXT.Buffer pVertexInfo, int instanceCount, int firstInstance, int stride)	Draw primitives.
static void	vkCmdDrawMultiIndexedEXT(org.lwjgl.vulkan.VkCommandBuffer commandBuffer, VkMultiDrawIndexedInfoEXT.Buffer pIndexInfo, int instanceCount, int firstInstance, int stride, int[] pVertexOffset)	Array version of: CmdDrawMultiIndexedEXT
static void	vkCmdDrawMultiIndexedEXT(org.lwjgl.vulkan.VkCommandBuffer commandBuffer, VkMultiDrawIndexedInfoEXT.Buffer pIndexInfo, int instanceCount, int firstInstance, int stride, java.nio.IntBuffer pVertexOffset)	Draw primitives.

Methods inherited from class java.lang.Object

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

Field Detail

VK_EXT_MULTI_DRAW_SPEC_VERSION

The extension specification version.

VK_EXT_MULTI_DRAW_EXTENSION_NAME

The extension name.

VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_MULTI_DRAW_FEATURES_EXT, VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_MULTI_DRAW_PROPERTIES_EXT

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_PHYSICAL_DEVICE_MULTI_DRAW_FEATURES_EXT
• STRUCTURE_TYPE_PHYSICAL_DEVICE_MULTI_DRAW_PROPERTIES_EXT

Method Detail

nvkCmdDrawMultiEXT

public static void nvkCmdDrawMultiEXT(org.lwjgl.vulkan.VkCommandBuffer commandBuffer,
                                      int drawCount,
                                      long pVertexInfo,
                                      int instanceCount,
                                      int firstInstance,
                                      int stride)

Unsafe version of: CmdDrawMultiEXT

Parameters:

drawCount - the number of draws to execute, and can be zero.

vkCmdDrawMultiEXT

public static void vkCmdDrawMultiEXT(org.lwjgl.vulkan.VkCommandBuffer commandBuffer,
                                     @Nullable
                                     VkMultiDrawInfoEXT.Buffer pVertexInfo,
                                     int instanceCount,
                                     int firstInstance,
                                     int stride)

Draw primitives.

C Specification

To record an ordered sequence of drawing operations which have no state changes between them, call:

 void vkCmdDrawMultiEXT(
     VkCommandBuffer                             commandBuffer,
     uint32_t                                    drawCount,
     const VkMultiDrawInfoEXT*                   pVertexInfo,
     uint32_t                                    instanceCount,
     uint32_t                                    firstInstance,
     uint32_t                                    stride);

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 VkSampler created with magFilter or minFilter equal to FILTER_LINEAR and compareEnable equal to FALSE is used to sample a VkImageView as a result of this command, then the image view’s format features must contain FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT
• If a VkSampler created with mipmapMode equal to SAMPLER_MIPMAP_MODE_LINEAR and compareEnable equal to FALSE is used to sample a VkImageView as a result of this command, then the image view’s format features must contain FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT
• If a VkImageView is sampled with depth comparison, the image view’s format features must contain FORMAT_FEATURE_2_SAMPLED_IMAGE_DEPTH_COMPARISON_BIT
• If a VkImageView is accessed using atomic operations as a result of this command, then the image view’s format features must contain FORMAT_FEATURE_STORAGE_IMAGE_ATOMIC_BIT
• If a VkImageView is sampled with FILTER_CUBIC_EXT as a result of this command, then the image view’s format features must contain FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_EXT
• Any VkImageView being sampled with FILTER_CUBIC_EXT as a result of this command must have a VkImageViewType and format that supports cubic filtering, as specified by VkFilterCubicImageViewImageFormatPropertiesEXT::filterCubic returned by vkGetPhysicalDeviceImageFormatProperties2
• Any VkImageView being sampled with FILTER_CUBIC_EXT with a reduction mode of either SAMPLER_REDUCTION_MODE_MIN or SAMPLER_REDUCTION_MODE_MAX as a result of this command must have a VkImageViewType and format that supports cubic filtering together with minmax filtering, as specified by VkFilterCubicImageViewImageFormatPropertiesEXT::filterCubicMinmax returned by vkGetPhysicalDeviceImageFormatProperties2
• Any VkImage created with a VkImageCreateInfo::flags containing IMAGE_CREATE_CORNER_SAMPLED_BIT_NV sampled as a result of this command must only be sampled using a VkSamplerAddressMode of SAMPLER_ADDRESS_MODE_CLAMP_TO_EDGE
• Any VkImageView or VkBufferView being written as a storage image or storage texel buffer where the image format field of the OpTypeImage is Unknown then the view’s format feature must contain FORMAT_FEATURE_2_STORAGE_WRITE_WITHOUT_FORMAT_BIT
• Any VkImageView or VkBufferView being read as a storage image or storage texel buffer where the image format field of the OpTypeImage is Unknown then the view’s format feature must contain FORMAT_FEATURE_2_STORAGE_READ_WITHOUT_FORMAT_BIT
• For each set n that is statically used by the VkPipeline 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 VkPipelineLayout that is compatible for set n, with the VkPipelineLayout used to create the current VkPipeline, as described in Pipeline Layout Compatibility
• If the maintenance4 feature is not enabled, then for each push constant that is statically used by the VkPipeline 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 VkPipelineLayout that is compatible for push constants, with the VkPipelineLayout used to create the current VkPipeline, as described in Pipeline Layout Compatibility
• Descriptors in each bound descriptor set, specified via vkCmdBindDescriptorSets, must be valid if they are statically used by the VkPipeline 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 VkPipeline 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 VkPipeline object bound to the pipeline bind point used by this command, since that pipeline was bound
• If the VkPipeline object bound to the pipeline bind point used by this command accesses a VkSampler object that uses unnormalized coordinates, that sampler must not be used to sample from any VkImage with a VkImageView 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 VkPipeline object bound to the pipeline bind point used by this command accesses a VkSampler 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 VkPipeline object bound to the pipeline bind point used by this command accesses a VkSampler 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 VkPipeline 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 VkPipeline 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 and protectedNoFault is not supported, any resource accessed by the VkPipeline object bound to the pipeline bind point used by this command must not be a protected resource
• If the VkPipeline object bound to the pipeline bind point used by this command accesses a VkSampler or VkImageView object that enables sampler Y′C_BC_R conversion, that object must only be used with OpImageSample* or OpImageSparseSample* instructions
• If the VkPipeline object bound to the pipeline bind point used by this command accesses a VkSampler or VkImageView object that enables sampler Y′C_BC_R conversion, that object must not use the ConstOffset and Offset operands
• If a VkImageView is accessed 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 VkBufferView is accessed using OpImageWrite as a result of this command, then the Type of the Texel operand of that instruction must have at least as many components as the buffer view’s format
• If a VkImageView with a VkFormat that has a 64-bit component width is accessed as a result of this command, the SampledType of the OpTypeImage operand of that instruction must have a Width of 64
• If a VkImageView with a VkFormat that has a component width less than 64-bit is accessed as a result of this command, the SampledType of the OpTypeImage operand of that instruction must have a Width of 32
• If a VkBufferView with a VkFormat that has a 64-bit component width is accessed as a result of this command, the SampledType of the OpTypeImage operand of that instruction must have a Width of 64
• If a VkBufferView with a VkFormat that has a component width less than 64-bit is accessed as a result of this command, the SampledType of the OpTypeImage operand of that instruction must have a Width of 32
• If the sparseImageInt64Atomics feature is not enabled, VkImage objects created with the IMAGE_CREATE_SPARSE_RESIDENCY_BIT flag must not be accessed by atomic instructions through an OpTypeImage with a SampledType with a Width of 64 by this command
• If the sparseImageInt64Atomics feature is not enabled, VkBuffer objects created with the BUFFER_CREATE_SPARSE_RESIDENCY_BIT flag must not be accessed by atomic instructions through an OpTypeImage with a SampledType with a Width of 64 by this command
• The current render pass must be compatible with the renderPass member of the VkGraphicsPipelineCreateInfo structure specified when creating the VkPipeline bound to PIPELINE_BIND_POINT_GRAPHICS
• The subpass index of the current render pass must be equal to the subpass member of the VkGraphicsPipelineCreateInfo structure specified when creating the VkPipeline bound to PIPELINE_BIND_POINT_GRAPHICS
• Every input attachment used by the current subpass must be bound to the pipeline via a descriptor set
• Memory backing image subresources used as attachments in the current render pass must not be written in any way other than as an attachment by this command
• If any recorded command in the current subpass will write to an image subresource as an attachment, this command must not read from the memory backing that image subresource in any other way than as an attachment
• If any recorded command in the current subpass will read from an image subresource used as an attachment in any way other than as an attachment, this command must not write to that image subresource as an attachment
• 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
• If the bound graphics pipeline was created with VkPipelineSampleLocationsStateCreateInfoEXT::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 dynamic state enabled, but not the DYNAMIC_STATE_SCISSOR_WITH_COUNT dynamic state enabled, then CmdSetViewportWithCount must have been called in the current command buffer prior to this drawing command, and the viewportCount parameter of vkCmdSetViewportWithCount must match the VkPipelineViewportStateCreateInfo::scissorCount of the pipeline
• If the bound graphics pipeline state was created with the DYNAMIC_STATE_SCISSOR_WITH_COUNT dynamic state enabled, but not the DYNAMIC_STATE_VIEWPORT_WITH_COUNT dynamic state enabled, then CmdSetScissorWithCount must have been called in the current command buffer prior to this drawing command, and the scissorCount parameter of vkCmdSetScissorWithCount must match the VkPipelineViewportStateCreateInfo::viewportCount of the pipeline
• If the bound graphics pipeline state was created with both the DYNAMIC_STATE_SCISSOR_WITH_COUNT and DYNAMIC_STATE_VIEWPORT_WITH_COUNT dynamic states enabled then both CmdSetViewportWithCount and CmdSetScissorWithCount must have been called in the current command buffer prior to this drawing command, and the viewportCount parameter of vkCmdSetViewportWithCount must match the scissorCount parameter of vkCmdSetScissorWithCount
• If the bound graphics pipeline state was created with the DYNAMIC_STATE_VIEWPORT_WITH_COUNT 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 VkPipelineViewportWScalingStateCreateInfoNV::viewportCount greater or equal to the viewportCount parameter in the last call to CmdSetViewportWithCount
• If the bound graphics pipeline state was created with the DYNAMIC_STATE_VIEWPORT_WITH_COUNT 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 CmdSetViewportWithCount
• If the bound graphics pipeline state was created with the DYNAMIC_STATE_VIEWPORT_WITH_COUNT 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 VkPipelineViewportShadingRateImageStateCreateInfoNV::viewportCount greater or equal to the viewportCount parameter in the last call to CmdSetViewportWithCount
• If the bound graphics pipeline state was created with the DYNAMIC_STATE_VIEWPORT_WITH_COUNT 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 CmdSetViewportWithCount
• If the bound graphics pipeline state was created with the DYNAMIC_STATE_VIEWPORT_WITH_COUNT dynamic state enabled and a VkPipelineViewportSwizzleStateCreateInfoNV structure chained from VkPipelineVieportCreateInfo, then the bound graphics pipeline must have been created with VkPipelineViewportSwizzleStateCreateInfoNV::viewportCount greater or equal to the viewportCount parameter in the last call to CmdSetViewportWithCount
• If the bound graphics pipeline state was created with the DYNAMIC_STATE_VIEWPORT_WITH_COUNT dynamic state enabled and a VkPipelineViewportExclusiveScissorStateCreateInfoNV structure chained from VkPipelineVieportCreateInfo, then the bound graphics pipeline must have been created with VkPipelineViewportExclusiveScissorStateCreateInfoNV::exclusiveScissorCount greater or equal to the viewportCount parameter in the last call to CmdSetViewportWithCount
• If the bound graphics pipeline state was created with the DYNAMIC_STATE_RASTERIZER_DISCARD_ENABLE dynamic state enabled then CmdSetRasterizerDiscardEnable 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 dynamic state enabled then CmdSetDepthBiasEnable 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 VkLogicOp value
• If the primitiveFragmentShadingRateWithMultipleViewports limit is not supported, the bound graphics pipeline was created with the DYNAMIC_STATE_VIEWPORT_WITH_COUNT dynamic state enabled, and any of the shader stages of the bound graphics pipeline write to the PrimitiveShadingRateKHR built-in, then CmdSetViewportWithCount must have been called in the current command buffer prior to this drawing command, and the viewportCount parameter of vkCmdSetViewportWithCount 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 VkPipelineMultisampleStateCreateInfo::rasterizationSamples must be the same as the current subpass color and/or depth/stencil attachments
• If the current render pass instance was begun with CmdBeginRendering, 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 CmdBeginRendering, 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 CmdBeginRendering, 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 CmdBeginRendering, 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 CmdBeginRendering, 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 CmdBeginRendering, 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 CmdBeginRendering, the currently bound graphics pipeline must have been created with a VkPipelineRenderingCreateInfo::viewMask equal to VkRenderingInfo::viewMask
• If the current render pass instance was begun with CmdBeginRendering, the currently bound graphics pipeline must have been created with a VkPipelineRenderingCreateInfo::colorAttachmentCount equal to VkRenderingInfo::colorAttachmentCount
• If the current render pass instance was begun with CmdBeginRendering and VkRenderingInfo::colorAttachmentCount greater than 0, then each element of the VkRenderingInfo::pColorAttachments array with a imageView not equal to NULL_HANDLE must have been created with a VkFormat equal to the corresponding element of VkPipelineRenderingCreateInfo::pColorAttachmentFormats used to create the currently bound graphics pipeline
• If the current render pass instance was begun with CmdBeginRendering and VkRenderingInfo::pDepthAttachment\u2192pname:imageView was not NULL_HANDLE, the value of VkPipelineRenderingCreateInfo::depthAttachmentFormat used to create the currently bound graphics pipeline must be equal to the VkFormat used to create VkRenderingInfo::pDepthAttachment\u2192pname:imageView
• If the current render pass instance was begun with CmdBeginRendering and VkRenderingInfo::pStencilAttachment\u2192pname:imageView was not NULL_HANDLE, the value of VkPipelineRenderingCreateInfo::stencilAttachmentFormat used to create the currently bound graphics pipeline must be equal to the VkFormat used to create VkRenderingInfo::pStencilAttachment\u2192pname:imageView
• If the current render pass instance was begun with CmdBeginRendering and VkRenderingFragmentShadingRateAttachmentInfoKHR::imageView was not NULL_HANDLE, the currently bound graphics pipeline must have been created with PIPELINE_CREATE_RENDERING_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR
• If the current render pass instance was begun with CmdBeginRendering and VkRenderingFragmentDensityMapAttachmentInfoEXT::imageView was not NULL_HANDLE, the currently bound graphics pipeline must have been created with PIPELINE_CREATE_RENDERING_FRAGMENT_DENSITY_MAP_ATTACHMENT_BIT_EXT
• If the currently bound pipeline was created with a VkAttachmentSampleCountInfoAMD or VkAttachmentSampleCountInfoNV structure, and the current render pass instance was begun with CmdBeginRendering with a VkRenderingInfo::colorAttachmentCount parameter greater than 0, then each element of the VkRenderingInfo::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 VkAttachmentSampleCountInfoAMD or VkAttachmentSampleCountInfoNV used to create the currently bound graphics pipeline
• If the current render pass instance was begun with CmdBeginRendering, the currently bound pipeline was created with a VkAttachmentSampleCountInfoAMD or VkAttachmentSampleCountInfoNV structure, and VkRenderingInfo::pDepthAttachment\u2192pname:imageView was not NULL_HANDLE, the value of the depthStencilAttachmentSamples member of VkAttachmentSampleCountInfoAMD or VkAttachmentSampleCountInfoNV used to create the currently bound graphics pipeline must be equal to the sample count used to create VkRenderingInfo::pDepthAttachment\u2192pname:imageView
• If the current render pass instance was begun with CmdBeginRendering, the currently bound pipeline was created with a VkAttachmentSampleCountInfoAMD or VkAttachmentSampleCountInfoNV structure, and VkRenderingInfo::pStencilAttachment\u2192pname:imageView was not NULL_HANDLE, the value of the depthStencilAttachmentSamples member of VkAttachmentSampleCountInfoAMD or VkAttachmentSampleCountInfoNV used to create the currently bound graphics pipeline must be equal to the sample count used to create VkRenderingInfo::pStencilAttachment\u2192pname:imageView
• If the currently bound pipeline was created without a VkAttachmentSampleCountInfoAMD or VkAttachmentSampleCountInfoNV structure, and the current render pass instance was begun with CmdBeginRendering with a VkRenderingInfo::colorAttachmentCount parameter greater than 0, then each element of the VkRenderingInfo::pColorAttachments array with a imageView not equal to NULL_HANDLE must have been created with a sample count equal to the value of VkPipelineMultisampleStateCreateInfo::rasterizationSamples used to create the currently bound graphics pipeline
• If the current render pass instance was begun with CmdBeginRendering, the currently bound pipeline was created without a VkAttachmentSampleCountInfoAMD or VkAttachmentSampleCountInfoNV structure, and VkRenderingInfo::pDepthAttachment\u2192pname:imageView was not NULL_HANDLE, the value of VkPipelineMultisampleStateCreateInfo::rasterizationSamples used to create the currently bound graphics pipeline must be equal to the sample count used to create VkRenderingInfo::pDepthAttachment\u2192pname:imageView
• If the current render pass instance was begun with CmdBeginRendering, the currently bound pipeline was created without a VkAttachmentSampleCountInfoAMD or VkAttachmentSampleCountInfoNV structure, and VkRenderingInfo::pStencilAttachment\u2192pname:imageView was not NULL_HANDLE, the value of VkPipelineMultisampleStateCreateInfo::rasterizationSamples used to create the currently bound graphics pipeline must be equal to the sample count used to create VkRenderingInfo::pStencilAttachment\u2192pname:imageView
• If the current render pass instance was begun with CmdBeginRendering, the currently bound pipeline must have been created with a VkGraphicsPipelineCreateInfo::renderPass equal to NULL_HANDLE

• If commandBuffer is a protected command buffer and protectedNoFault is not supported, any resource written to by the VkPipeline object bound to the pipeline bind point used by this command must not be an unprotected resource
• If commandBuffer is a protected command buffer and protectedNoFault is not supported, pipeline stages other than the framebuffer-space and compute stages in the VkPipeline 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 VkPipeline 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 Vertex Input Description
• 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 vkCmdSetPrimitiveTopologyEXT must be of the same topology class as the pipeline VkPipelineInputAssemblyStateCreateInfo::topology state
• 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 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_PRIMITIVE_RESTART_ENABLE_EXT dynamic state enabled then CmdSetPrimitiveRestartEnableEXT must have been called in the current command buffer prior to this drawing command
• The bound graphics pipeline must not have been created with the VkPipelineShaderStageCreateInfo::stage member of an element of VkGraphicsPipelineCreateInfo::pStages set to SHADER_STAGE_TASK_BIT_NV or SHADER_STAGE_MESH_BIT_NV
• The multiDraw feature must be enabled
• drawCount must be less than VkPhysicalDeviceMultiDrawPropertiesEXT::maxMultiDrawCount
• If drawCount is greater than zero, pVertexInfo must be a valid pointer to memory containing one or more valid instances of VkMultiDrawInfoEXT structures
• stride must be a multiple of 4

Valid Usage (Implicit)

• commandBuffer must be a valid VkCommandBuffer handle
• commandBuffer must be in the recording state
• The VkCommandPool that commandBuffer was allocated from must support graphics 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 VkCommandPool 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

VkMultiDrawInfoEXT

Parameters:

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

pVertexInfo - a pointer to an array of VkMultiDrawInfoEXT with vertex information to be drawn.

instanceCount - the number of instances to draw.

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

stride - the byte stride between consecutive elements of pVertexInfo.

nvkCmdDrawMultiIndexedEXT

public static void nvkCmdDrawMultiIndexedEXT(org.lwjgl.vulkan.VkCommandBuffer commandBuffer,
                                             int drawCount,
                                             long pIndexInfo,
                                             int instanceCount,
                                             int firstInstance,
                                             int stride,
                                             long pVertexOffset)

Unsafe version of: CmdDrawMultiIndexedEXT

Parameters:

drawCount - the number of draws to execute, and can be zero.

vkCmdDrawMultiIndexedEXT

public static void vkCmdDrawMultiIndexedEXT(org.lwjgl.vulkan.VkCommandBuffer commandBuffer,
                                            @Nullable
                                            VkMultiDrawIndexedInfoEXT.Buffer pIndexInfo,
                                            int instanceCount,
                                            int firstInstance,
                                            int stride,
                                            @Nullable
                                            java.nio.IntBuffer pVertexOffset)

Draw primitives.

C Specification

To record an ordered sequence of indexed drawing operations which have no state changes between them, call:

 void vkCmdDrawMultiIndexedEXT(
     VkCommandBuffer                             commandBuffer,
     uint32_t                                    drawCount,
     const VkMultiDrawIndexedInfoEXT*            pIndexInfo,
     uint32_t                                    instanceCount,
     uint32_t                                    firstInstance,
     uint32_t                                    stride,
     const int32_t*                              pVertexOffset);

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 VkSampler created with magFilter or minFilter equal to FILTER_LINEAR and compareEnable equal to FALSE is used to sample a VkImageView as a result of this command, then the image view’s format features must contain FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT
• If a VkSampler created with mipmapMode equal to SAMPLER_MIPMAP_MODE_LINEAR and compareEnable equal to FALSE is used to sample a VkImageView as a result of this command, then the image view’s format features must contain FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT
• If a VkImageView is sampled with depth comparison, the image view’s format features must contain FORMAT_FEATURE_2_SAMPLED_IMAGE_DEPTH_COMPARISON_BIT
• If a VkImageView is accessed using atomic operations as a result of this command, then the image view’s format features must contain FORMAT_FEATURE_STORAGE_IMAGE_ATOMIC_BIT
• If a VkImageView is sampled with FILTER_CUBIC_EXT as a result of this command, then the image view’s format features must contain FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_EXT
• Any VkImageView being sampled with FILTER_CUBIC_EXT as a result of this command must have a VkImageViewType and format that supports cubic filtering, as specified by VkFilterCubicImageViewImageFormatPropertiesEXT::filterCubic returned by vkGetPhysicalDeviceImageFormatProperties2
• Any VkImageView being sampled with FILTER_CUBIC_EXT with a reduction mode of either SAMPLER_REDUCTION_MODE_MIN or SAMPLER_REDUCTION_MODE_MAX as a result of this command must have a VkImageViewType and format that supports cubic filtering together with minmax filtering, as specified by VkFilterCubicImageViewImageFormatPropertiesEXT::filterCubicMinmax returned by vkGetPhysicalDeviceImageFormatProperties2
• Any VkImage created with a VkImageCreateInfo::flags containing IMAGE_CREATE_CORNER_SAMPLED_BIT_NV sampled as a result of this command must only be sampled using a VkSamplerAddressMode of SAMPLER_ADDRESS_MODE_CLAMP_TO_EDGE
• Any VkImageView or VkBufferView being written as a storage image or storage texel buffer where the image format field of the OpTypeImage is Unknown then the view’s format feature must contain FORMAT_FEATURE_2_STORAGE_WRITE_WITHOUT_FORMAT_BIT
• Any VkImageView or VkBufferView being read as a storage image or storage texel buffer where the image format field of the OpTypeImage is Unknown then the view’s format feature must contain FORMAT_FEATURE_2_STORAGE_READ_WITHOUT_FORMAT_BIT
• For each set n that is statically used by the VkPipeline 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 VkPipelineLayout that is compatible for set n, with the VkPipelineLayout used to create the current VkPipeline, as described in Pipeline Layout Compatibility
• If the maintenance4 feature is not enabled, then for each push constant that is statically used by the VkPipeline 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 VkPipelineLayout that is compatible for push constants, with the VkPipelineLayout used to create the current VkPipeline, as described in Pipeline Layout Compatibility
• Descriptors in each bound descriptor set, specified via vkCmdBindDescriptorSets, must be valid if they are statically used by the VkPipeline 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 VkPipeline 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 VkPipeline object bound to the pipeline bind point used by this command, since that pipeline was bound
• If the VkPipeline object bound to the pipeline bind point used by this command accesses a VkSampler object that uses unnormalized coordinates, that sampler must not be used to sample from any VkImage with a VkImageView 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 VkPipeline object bound to the pipeline bind point used by this command accesses a VkSampler 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 VkPipeline object bound to the pipeline bind point used by this command accesses a VkSampler 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 VkPipeline 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 VkPipeline 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 and protectedNoFault is not supported, any resource accessed by the VkPipeline object bound to the pipeline bind point used by this command must not be a protected resource
• If the VkPipeline object bound to the pipeline bind point used by this command accesses a VkSampler or VkImageView object that enables sampler Y′C_BC_R conversion, that object must only be used with OpImageSample* or OpImageSparseSample* instructions
• If the VkPipeline object bound to the pipeline bind point used by this command accesses a VkSampler or VkImageView object that enables sampler Y′C_BC_R conversion, that object must not use the ConstOffset and Offset operands
• If a VkImageView is accessed 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 VkBufferView is accessed using OpImageWrite as a result of this command, then the Type of the Texel operand of that instruction must have at least as many components as the buffer view’s format
• If a VkImageView with a VkFormat that has a 64-bit component width is accessed as a result of this command, the SampledType of the OpTypeImage operand of that instruction must have a Width of 64
• If a VkImageView with a VkFormat that has a component width less than 64-bit is accessed as a result of this command, the SampledType of the OpTypeImage operand of that instruction must have a Width of 32
• If a VkBufferView with a VkFormat that has a 64-bit component width is accessed as a result of this command, the SampledType of the OpTypeImage operand of that instruction must have a Width of 64
• If a VkBufferView with a VkFormat that has a component width less than 64-bit is accessed as a result of this command, the SampledType of the OpTypeImage operand of that instruction must have a Width of 32
• If the sparseImageInt64Atomics feature is not enabled, VkImage objects created with the IMAGE_CREATE_SPARSE_RESIDENCY_BIT flag must not be accessed by atomic instructions through an OpTypeImage with a SampledType with a Width of 64 by this command
• If the sparseImageInt64Atomics feature is not enabled, VkBuffer objects created with the BUFFER_CREATE_SPARSE_RESIDENCY_BIT flag must not be accessed by atomic instructions through an OpTypeImage with a SampledType with a Width of 64 by this command
• The current render pass must be compatible with the renderPass member of the VkGraphicsPipelineCreateInfo structure specified when creating the VkPipeline bound to PIPELINE_BIND_POINT_GRAPHICS
• The subpass index of the current render pass must be equal to the subpass member of the VkGraphicsPipelineCreateInfo structure specified when creating the VkPipeline bound to PIPELINE_BIND_POINT_GRAPHICS
• Every input attachment used by the current subpass must be bound to the pipeline via a descriptor set
• Memory backing image subresources used as attachments in the current render pass must not be written in any way other than as an attachment by this command
• If any recorded command in the current subpass will write to an image subresource as an attachment, this command must not read from the memory backing that image subresource in any other way than as an attachment
• If any recorded command in the current subpass will read from an image subresource used as an attachment in any way other than as an attachment, this command must not write to that image subresource as an attachment
• 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
• If the bound graphics pipeline was created with VkPipelineSampleLocationsStateCreateInfoEXT::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 dynamic state enabled, but not the DYNAMIC_STATE_SCISSOR_WITH_COUNT dynamic state enabled, then CmdSetViewportWithCount must have been called in the current command buffer prior to this drawing command, and the viewportCount parameter of vkCmdSetViewportWithCount must match the VkPipelineViewportStateCreateInfo::scissorCount of the pipeline
• If the bound graphics pipeline state was created with the DYNAMIC_STATE_SCISSOR_WITH_COUNT dynamic state enabled, but not the DYNAMIC_STATE_VIEWPORT_WITH_COUNT dynamic state enabled, then CmdSetScissorWithCount must have been called in the current command buffer prior to this drawing command, and the scissorCount parameter of vkCmdSetScissorWithCount must match the VkPipelineViewportStateCreateInfo::viewportCount of the pipeline
• If the bound graphics pipeline state was created with both the DYNAMIC_STATE_SCISSOR_WITH_COUNT and DYNAMIC_STATE_VIEWPORT_WITH_COUNT dynamic states enabled then both CmdSetViewportWithCount and CmdSetScissorWithCount must have been called in the current command buffer prior to this drawing command, and the viewportCount parameter of vkCmdSetViewportWithCount must match the scissorCount parameter of vkCmdSetScissorWithCount
• If the bound graphics pipeline state was created with the DYNAMIC_STATE_VIEWPORT_WITH_COUNT 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 VkPipelineViewportWScalingStateCreateInfoNV::viewportCount greater or equal to the viewportCount parameter in the last call to CmdSetViewportWithCount
• If the bound graphics pipeline state was created with the DYNAMIC_STATE_VIEWPORT_WITH_COUNT 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 CmdSetViewportWithCount
• If the bound graphics pipeline state was created with the DYNAMIC_STATE_VIEWPORT_WITH_COUNT 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 VkPipelineViewportShadingRateImageStateCreateInfoNV::viewportCount greater or equal to the viewportCount parameter in the last call to CmdSetViewportWithCount
• If the bound graphics pipeline state was created with the DYNAMIC_STATE_VIEWPORT_WITH_COUNT 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 CmdSetViewportWithCount
• If the bound graphics pipeline state was created with the DYNAMIC_STATE_VIEWPORT_WITH_COUNT dynamic state enabled and a VkPipelineViewportSwizzleStateCreateInfoNV structure chained from VkPipelineVieportCreateInfo, then the bound graphics pipeline must have been created with VkPipelineViewportSwizzleStateCreateInfoNV::viewportCount greater or equal to the viewportCount parameter in the last call to CmdSetViewportWithCount
• If the bound graphics pipeline state was created with the DYNAMIC_STATE_VIEWPORT_WITH_COUNT dynamic state enabled and a VkPipelineViewportExclusiveScissorStateCreateInfoNV structure chained from VkPipelineVieportCreateInfo, then the bound graphics pipeline must have been created with VkPipelineViewportExclusiveScissorStateCreateInfoNV::exclusiveScissorCount greater or equal to the viewportCount parameter in the last call to CmdSetViewportWithCount
• If the bound graphics pipeline state was created with the DYNAMIC_STATE_RASTERIZER_DISCARD_ENABLE dynamic state enabled then CmdSetRasterizerDiscardEnable 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 dynamic state enabled then CmdSetDepthBiasEnable 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 VkLogicOp value
• If the primitiveFragmentShadingRateWithMultipleViewports limit is not supported, the bound graphics pipeline was created with the DYNAMIC_STATE_VIEWPORT_WITH_COUNT dynamic state enabled, and any of the shader stages of the bound graphics pipeline write to the PrimitiveShadingRateKHR built-in, then CmdSetViewportWithCount must have been called in the current command buffer prior to this drawing command, and the viewportCount parameter of vkCmdSetViewportWithCount 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 VkPipelineMultisampleStateCreateInfo::rasterizationSamples must be the same as the current subpass color and/or depth/stencil attachments
• If the current render pass instance was begun with CmdBeginRendering, 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 CmdBeginRendering, 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 CmdBeginRendering, 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 CmdBeginRendering, 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 CmdBeginRendering, 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 CmdBeginRendering, 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 CmdBeginRendering, the currently bound graphics pipeline must have been created with a VkPipelineRenderingCreateInfo::viewMask equal to VkRenderingInfo::viewMask
• If the current render pass instance was begun with CmdBeginRendering, the currently bound graphics pipeline must have been created with a VkPipelineRenderingCreateInfo::colorAttachmentCount equal to VkRenderingInfo::colorAttachmentCount
• If the current render pass instance was begun with CmdBeginRendering and VkRenderingInfo::colorAttachmentCount greater than 0, then each element of the VkRenderingInfo::pColorAttachments array with a imageView not equal to NULL_HANDLE must have been created with a VkFormat equal to the corresponding element of VkPipelineRenderingCreateInfo::pColorAttachmentFormats used to create the currently bound graphics pipeline
• If the current render pass instance was begun with CmdBeginRendering and VkRenderingInfo::pDepthAttachment\u2192pname:imageView was not NULL_HANDLE, the value of VkPipelineRenderingCreateInfo::depthAttachmentFormat used to create the currently bound graphics pipeline must be equal to the VkFormat used to create VkRenderingInfo::pDepthAttachment\u2192pname:imageView
• If the current render pass instance was begun with CmdBeginRendering and VkRenderingInfo::pStencilAttachment\u2192pname:imageView was not NULL_HANDLE, the value of VkPipelineRenderingCreateInfo::stencilAttachmentFormat used to create the currently bound graphics pipeline must be equal to the VkFormat used to create VkRenderingInfo::pStencilAttachment\u2192pname:imageView
• If the current render pass instance was begun with CmdBeginRendering and VkRenderingFragmentShadingRateAttachmentInfoKHR::imageView was not NULL_HANDLE, the currently bound graphics pipeline must have been created with PIPELINE_CREATE_RENDERING_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR
• If the current render pass instance was begun with CmdBeginRendering and VkRenderingFragmentDensityMapAttachmentInfoEXT::imageView was not NULL_HANDLE, the currently bound graphics pipeline must have been created with PIPELINE_CREATE_RENDERING_FRAGMENT_DENSITY_MAP_ATTACHMENT_BIT_EXT
• If the currently bound pipeline was created with a VkAttachmentSampleCountInfoAMD or VkAttachmentSampleCountInfoNV structure, and the current render pass instance was begun with CmdBeginRendering with a VkRenderingInfo::colorAttachmentCount parameter greater than 0, then each element of the VkRenderingInfo::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 VkAttachmentSampleCountInfoAMD or VkAttachmentSampleCountInfoNV used to create the currently bound graphics pipeline
• If the current render pass instance was begun with CmdBeginRendering, the currently bound pipeline was created with a VkAttachmentSampleCountInfoAMD or VkAttachmentSampleCountInfoNV structure, and VkRenderingInfo::pDepthAttachment\u2192pname:imageView was not NULL_HANDLE, the value of the depthStencilAttachmentSamples member of VkAttachmentSampleCountInfoAMD or VkAttachmentSampleCountInfoNV used to create the currently bound graphics pipeline must be equal to the sample count used to create VkRenderingInfo::pDepthAttachment\u2192pname:imageView
• If the current render pass instance was begun with CmdBeginRendering, the currently bound pipeline was created with a VkAttachmentSampleCountInfoAMD or VkAttachmentSampleCountInfoNV structure, and VkRenderingInfo::pStencilAttachment\u2192pname:imageView was not NULL_HANDLE, the value of the depthStencilAttachmentSamples member of VkAttachmentSampleCountInfoAMD or VkAttachmentSampleCountInfoNV used to create the currently bound graphics pipeline must be equal to the sample count used to create VkRenderingInfo::pStencilAttachment\u2192pname:imageView
• If the currently bound pipeline was created without a VkAttachmentSampleCountInfoAMD or VkAttachmentSampleCountInfoNV structure, and the current render pass instance was begun with CmdBeginRendering with a VkRenderingInfo::colorAttachmentCount parameter greater than 0, then each element of the VkRenderingInfo::pColorAttachments array with a imageView not equal to NULL_HANDLE must have been created with a sample count equal to the value of VkPipelineMultisampleStateCreateInfo::rasterizationSamples used to create the currently bound graphics pipeline
• If the current render pass instance was begun with CmdBeginRendering, the currently bound pipeline was created without a VkAttachmentSampleCountInfoAMD or VkAttachmentSampleCountInfoNV structure, and VkRenderingInfo::pDepthAttachment\u2192pname:imageView was not NULL_HANDLE, the value of VkPipelineMultisampleStateCreateInfo::rasterizationSamples used to create the currently bound graphics pipeline must be equal to the sample count used to create VkRenderingInfo::pDepthAttachment\u2192pname:imageView
• If the current render pass instance was begun with CmdBeginRendering, the currently bound pipeline was created without a VkAttachmentSampleCountInfoAMD or VkAttachmentSampleCountInfoNV structure, and VkRenderingInfo::pStencilAttachment\u2192pname:imageView was not NULL_HANDLE, the value of VkPipelineMultisampleStateCreateInfo::rasterizationSamples used to create the currently bound graphics pipeline must be equal to the sample count used to create VkRenderingInfo::pStencilAttachment\u2192pname:imageView
• If the current render pass instance was begun with CmdBeginRendering, the currently bound pipeline must have been created with a VkGraphicsPipelineCreateInfo::renderPass equal to NULL_HANDLE

• If commandBuffer is a protected command buffer and protectedNoFault is not supported, any resource written to by the VkPipeline object bound to the pipeline bind point used by this command must not be an unprotected resource
• If commandBuffer is a protected command buffer and protectedNoFault is not supported, pipeline stages other than the framebuffer-space and compute stages in the VkPipeline 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 VkPipeline 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 Vertex Input Description
• 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 vkCmdSetPrimitiveTopologyEXT must be of the same topology class as the pipeline VkPipelineInputAssemblyStateCreateInfo::topology state
• 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 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_PRIMITIVE_RESTART_ENABLE_EXT dynamic state enabled then CmdSetPrimitiveRestartEnableEXT must have been called in the current command buffer prior to this drawing command
• The bound graphics pipeline must not have been created with the VkPipelineShaderStageCreateInfo::stage member of an element of VkGraphicsPipelineCreateInfo::pStages set to SHADER_STAGE_TASK_BIT_NV or SHADER_STAGE_MESH_BIT_NV
• 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 vkCmdBindIndexBuffer
• drawCount must be less than VkPhysicalDeviceMultiDrawPropertiesEXT::maxMultiDrawCount
• If drawCount is greater than zero, pIndexInfo must be a valid pointer to memory containing one or more valid instances of VkMultiDrawIndexedInfoEXT structures
• stride must be a multiple of 4

Valid Usage (Implicit)

• commandBuffer must be a valid VkCommandBuffer 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 VkCommandPool 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 VkCommandPool 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

VkMultiDrawIndexedInfoEXT

Parameters:

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

pIndexInfo - a pointer to an array of VkMultiDrawIndexedInfoEXT with index information to be drawn.

instanceCount - the number of instances to draw.

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

stride - the byte stride between consecutive elements of pIndexInfo.

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

vkCmdDrawMultiIndexedEXT

public static void vkCmdDrawMultiIndexedEXT(org.lwjgl.vulkan.VkCommandBuffer commandBuffer,
                                            @Nullable
                                            VkMultiDrawIndexedInfoEXT.Buffer pIndexInfo,
                                            int instanceCount,
                                            int firstInstance,
                                            int stride,
                                            @Nullable
                                            int[] pVertexOffset)

Array version of: CmdDrawMultiIndexedEXT