HORIZON HASKELLDocslts/ghc-9.14.x3e2d5682026-10-11Search names, modules, packages, or :: a typeCtrl K

GHC 9.14.1 · lts/ghc-9.14.x · 3e2d568 · 2026-10-11

Modulevulkan-3.27GHC2021

Vulkan.Extensions.VK_EXT_primitive_restart_index

Name

VK_EXT_primitive_restart_index - device extension

VK_EXT_primitive_restart_index

Name String

VK_EXT_primitive_restart_index

Extension Type

Device extension

Registered Extension Number

679

Revision

1

Ratification Status

Not ratified

Extension and Version Dependencies

VK_KHR_get_physical_device_properties2

or

Vulkan Version 1.1

Special Use
Contact
Extension Proposal

VK_EXT_primitive_restart_index

Other Extension Metadata

Last Modified Date

2026-03-10

IP Status

No known IP claims.

Contributors
  • Mike Blumenkrantz, Valve

  • Spencer Fricke, LunarG

  • Ricardo Garcia, Igalia

  • Piers Daniell, NVIDIA

Description

This extension allows setting a custom primitive restart index. It is primarily intended to support GL emulation.

New Commands

New Structures

New Enum Constants

Version History

  • Revision 1, 2026-03-10 (Mike Blumenkrantz)

    • Internal revisions

See Also

No cross-references are available

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.

  • 3 types
  • 1 value
  • Packagevulkan-3.27
  • Exports6
  • LanguageGHC2021
  • LicenceBSD-3-Clause
  • SourceVK_EXT_primitive_restart_index.hs
valuecmdSetPrimitiveRestartIndexEXT
  1. :: MonadIO io
  2. => CommandBuffer

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

  3. -> "primitiveRestartIndex" ::: Word32

    primitiveRestartIndex controls which special vertex index value is treated as restarting the assembly of primitives. This overrides the default values specified in PipelineInputAssemblyStateCreateInfo::primitiveRestartEnable.

  4. -> io ()
#

vkCmdSetPrimitiveRestartIndexEXT - Set primitive assembly restart index dynamically for a command buffer

Description

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

Valid Usage

Valid Usage (Implicit)

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

'

Conditional Rendering

vkCmdSetPrimitiveRestartIndexEXT is not affected by conditional rendering

See Also

VK_EXT_primitive_restart_index, CommandBuffer

VkPhysicalDevicePrimitiveRestartIndexFeaturesEXT - Structure describing features to configure primitive restart index

Description

If the PhysicalDevicePrimitiveRestartIndexFeaturesEXT 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. If the application wishes to use a Device with any features described by PhysicalDevicePrimitiveRestartIndexFeaturesEXT, it must add an instance of the structure, with the desired feature members set to TRUE, to the pNext chain of DeviceCreateInfo when creating the Device.

Structure Chaining

Extends the structures

See Also

VK_EXT_primitive_restart_index, Bool32, StructureType

Constructors

Instances6Eq, Show, Storable, FromCStruct, ToCStruct, Zero