Function Prototype

vkCmdSetPrimitiveRestartIndexEXT

Set primitive assembly restart index dynamically for a command buffer

To dynamically control which special vertex index value is treated as restarting the assembly of primitives, call:

void vkCmdSetPrimitiveRestartIndexEXT(
    VkCommandBuffer commandBuffer,
    uint32_t primitiveRestartIndex);

pub fn cmd_set_primitive_restart_index_ext(
    command_buffer: vk::CommandBuffer,
    primitive_restart_index: u32,
);

commandBuffer is the command buffer into which the command will be recorded.
primitiveRestartIndex controls which special vertex index value is treated as restarting the assembly of primitives. This overrides the default restart index value as defined as part of the description of the VkPipelineInputAssemblyStateCreateInfo::primitiveRestartEnable state. Default values are applied when binding an index buffer.

This command sets a custom primitive restart index for subsequent drawing commands. Binding an index buffer invalidates the custom index value.

Valid Usage

The primitiveRestartIndex feature must be enabled

commandBuffer must be a valid VkCommandBuffer handle

commandBuffer must be in the recording state

The VkCommandPool that commandBuffer was allocated from must support VK_QUEUE_GRAPHICS_BIT operations

This command must only be called outside of a video coding scope

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

Parent

Type

Function Prototype

primarysecondary

both

VK_QUEUE_GRAPHICS_BIT

state