Vulkan.Extensions.VK_EXT_vertex_attribute_divisor

Name

VK_EXT_vertex_attribute_divisor - device extension

VK_EXT_vertex_attribute_divisor

Name String

VK_EXT_vertex_attribute_divisor

Extension Type

Device extension

Registered Extension Number

191

Revision

3

Extension and Version Dependencies

• Requires support for Vulkan 1.0
• Requires VK_KHR_get_physical_device_properties2 to be enabled for any device-level functionality

Contact

• Vikram Kushwaha @vkushwaha%0A*Here describe the issue or question you have about the VK_EXT_vertex_attribute_divisor extension*

Other Extension Metadata

Last Modified Date

2018-08-03

IP Status

No known IP claims.

Contributors

• Vikram Kushwaha, NVIDIA
• Jason Ekstrand, Intel

Description

This extension allows instance-rate vertex attributes to be repeated for certain number of instances instead of advancing for every instance when instanced rendering is enabled.

New Structures

• VertexInputBindingDivisorDescriptionEXT

• Extending PhysicalDeviceFeatures2, DeviceCreateInfo:

  • PhysicalDeviceVertexAttributeDivisorFeaturesEXT

• Extending PhysicalDeviceProperties2:

  • PhysicalDeviceVertexAttributeDivisorPropertiesEXT

• Extending PipelineVertexInputStateCreateInfo:

  • PipelineVertexInputDivisorStateCreateInfoEXT

New Enum Constants

• EXT_VERTEX_ATTRIBUTE_DIVISOR_EXTENSION_NAME

• EXT_VERTEX_ATTRIBUTE_DIVISOR_SPEC_VERSION

• Extending StructureType:

  • STRUCTURE_TYPE_PHYSICAL_DEVICE_VERTEX_ATTRIBUTE_DIVISOR_FEATURES_EXT
  • STRUCTURE_TYPE_PHYSICAL_DEVICE_VERTEX_ATTRIBUTE_DIVISOR_PROPERTIES_EXT
  • STRUCTURE_TYPE_PIPELINE_VERTEX_INPUT_DIVISOR_STATE_CREATE_INFO_EXT

Issues

1) What is the effect of a non-zero value for firstInstance?

RESOLVED: The Vulkan API should follow the OpenGL convention and offset attribute fetching by firstInstance while computing vertex attribute offsets.

2) Should zero be an allowed divisor?

RESOLVED: Yes. A zero divisor means the vertex attribute is repeated for all instances.

Examples

To create a vertex binding such that the first binding uses instanced rendering and the same attribute is used for every 4 draw instances, an application could use the following set of structures:

    const VkVertexInputBindingDivisorDescriptionEXT divisorDesc =
    {
        0,
        4
    };

    const VkPipelineVertexInputDivisorStateCreateInfoEXT divisorInfo =
    {
        VK_STRUCTURE_TYPE_PIPELINE_VERTEX_INPUT_DIVISOR_STATE_CREATE_INFO_EXT, // sType
        NULL,                                                             // pNext
        1,                                                                // vertexBindingDivisorCount
        &divisorDesc                                                      // pVertexBindingDivisors
    }

    const VkVertexInputBindingDescription binding =
    {
        0,                                                                // binding
        sizeof(Vertex),                                                   // stride
        VK_VERTEX_INPUT_RATE_INSTANCE                                     // inputRate
    };

    const VkPipelineVertexInputStateCreateInfo viInfo =
    {
        VK_STRUCTURE_TYPE_PIPELINE_VERTEX_INPUT_CREATE_INFO,              // sType
        &divisorInfo,                                                     // pNext
        ...
    };
    //...

Version History

• Revision 1, 2017-12-04 (Vikram Kushwaha)

  • First Version

• Revision 2, 2018-07-16 (Jason Ekstrand)

  • Adjust the interaction between divisor and firstInstance to match the OpenGL convention.
  • Disallow divisors of zero.

• Revision 3, 2018-08-03 (Vikram Kushwaha)

  • Allow a zero divisor.
  • Add a physical device features structure to query/enable this feature.

See Also

PhysicalDeviceVertexAttributeDivisorFeaturesEXT, PhysicalDeviceVertexAttributeDivisorPropertiesEXT, PipelineVertexInputDivisorStateCreateInfoEXT, VertexInputBindingDivisorDescriptionEXT

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

data VertexInputBindingDivisorDescriptionEXT

VkVertexInputBindingDivisorDescriptionEXT - Structure specifying a divisor used in instanced rendering

Description

If this structure is not used to define a divisor value for an attribute, then the divisor has a logical default value of 1.

Valid Usage

• binding must be less than PhysicalDeviceLimits::maxVertexInputBindings

• If the vertexAttributeInstanceRateZeroDivisor feature is not enabled, divisor must not be 0
• If the vertexAttributeInstanceRateDivisor feature is not enabled, divisor must be 1
• divisor must be a value between 0 and PhysicalDeviceVertexAttributeDivisorPropertiesEXT::maxVertexAttribDivisor, inclusive
• VertexInputBindingDescription::inputRate must be of type VERTEX_INPUT_RATE_INSTANCE for this binding

See Also

VK_EXT_vertex_attribute_divisor, PipelineVertexInputDivisorStateCreateInfoEXT

Constructors

VertexInputBindingDivisorDescriptionEXT

Fields

• binding :: Word32

  binding is the binding number for which the divisor is specified.

• divisor :: Word32

  divisor is the number of successive instances that will use the same value of the vertex attribute when instanced rendering is enabled. For example, if the divisor is N, the same vertex attribute will be applied to N successive instances before moving on to the next vertex attribute. The maximum value of divisor is implementation-dependent and can be queried using PhysicalDeviceVertexAttributeDivisorPropertiesEXT::maxVertexAttribDivisor. A value of 0 can be used for the divisor if the vertexAttributeInstanceRateZeroDivisor feature is enabled. In this case, the same vertex attribute will be applied to all instances.

Instances

Storable VertexInputBindingDivisorDescriptionEXT

Defined in Vulkan.Extensions.VK_EXT_vertex_attribute_divisor

Methods

sizeOf :: VertexInputBindingDivisorDescriptionEXT -> Int

alignment :: VertexInputBindingDivisorDescriptionEXT -> Int

peekElemOff :: Ptr VertexInputBindingDivisorDescriptionEXT -> Int -> IO VertexInputBindingDivisorDescriptionEXT

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

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

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

peek :: Ptr VertexInputBindingDivisorDescriptionEXT -> IO VertexInputBindingDivisorDescriptionEXT

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

Show VertexInputBindingDivisorDescriptionEXT

Defined in Vulkan.Extensions.VK_EXT_vertex_attribute_divisor

Methods

showsPrec :: Int -> VertexInputBindingDivisorDescriptionEXT -> ShowS

show :: VertexInputBindingDivisorDescriptionEXT -> String

showList :: [VertexInputBindingDivisorDescriptionEXT] -> ShowS

Eq VertexInputBindingDivisorDescriptionEXT

Defined in Vulkan.Extensions.VK_EXT_vertex_attribute_divisor

Methods

(==) :: VertexInputBindingDivisorDescriptionEXT -> VertexInputBindingDivisorDescriptionEXT -> Bool

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

FromCStruct VertexInputBindingDivisorDescriptionEXT

Defined in Vulkan.Extensions.VK_EXT_vertex_attribute_divisor

Methods

peekCStruct :: Ptr VertexInputBindingDivisorDescriptionEXT -> IO VertexInputBindingDivisorDescriptionEXT

ToCStruct VertexInputBindingDivisorDescriptionEXT

Defined in Vulkan.Extensions.VK_EXT_vertex_attribute_divisor

Methods

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

pokeCStruct :: Ptr VertexInputBindingDivisorDescriptionEXT -> VertexInputBindingDivisorDescriptionEXT -> IO b -> IO b

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

pokeZeroCStruct :: Ptr VertexInputBindingDivisorDescriptionEXT -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero VertexInputBindingDivisorDescriptionEXT

Defined in Vulkan.Extensions.VK_EXT_vertex_attribute_divisor

Methods

zero :: VertexInputBindingDivisorDescriptionEXT

data PipelineVertexInputDivisorStateCreateInfoEXT

VkPipelineVertexInputDivisorStateCreateInfoEXT - Structure specifying vertex attributes assignment during instanced rendering

Valid Usage (Implicit)

See Also

VK_EXT_vertex_attribute_divisor, StructureType, VertexInputBindingDivisorDescriptionEXT

Constructors

PipelineVertexInputDivisorStateCreateInfoEXT

Fields

• vertexBindingDivisors :: Vector VertexInputBindingDivisorDescriptionEXT

  pVertexBindingDivisors is a pointer to an array of VertexInputBindingDivisorDescriptionEXT structures specifying the divisor value for each binding.

  pVertexBindingDivisors must be a valid pointer to an array of vertexBindingDivisorCount VertexInputBindingDivisorDescriptionEXT structures

Instances

Show PipelineVertexInputDivisorStateCreateInfoEXT

Defined in Vulkan.Extensions.VK_EXT_vertex_attribute_divisor

Methods

showsPrec :: Int -> PipelineVertexInputDivisorStateCreateInfoEXT -> ShowS

show :: PipelineVertexInputDivisorStateCreateInfoEXT -> String

showList :: [PipelineVertexInputDivisorStateCreateInfoEXT] -> ShowS

FromCStruct PipelineVertexInputDivisorStateCreateInfoEXT

Defined in Vulkan.Extensions.VK_EXT_vertex_attribute_divisor

Methods

peekCStruct :: Ptr PipelineVertexInputDivisorStateCreateInfoEXT -> IO PipelineVertexInputDivisorStateCreateInfoEXT

ToCStruct PipelineVertexInputDivisorStateCreateInfoEXT

Defined in Vulkan.Extensions.VK_EXT_vertex_attribute_divisor

Methods

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

pokeCStruct :: Ptr PipelineVertexInputDivisorStateCreateInfoEXT -> PipelineVertexInputDivisorStateCreateInfoEXT -> IO b -> IO b

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

pokeZeroCStruct :: Ptr PipelineVertexInputDivisorStateCreateInfoEXT -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero PipelineVertexInputDivisorStateCreateInfoEXT

Defined in Vulkan.Extensions.VK_EXT_vertex_attribute_divisor

Methods

zero :: PipelineVertexInputDivisorStateCreateInfoEXT

data PhysicalDeviceVertexAttributeDivisorPropertiesEXT

VkPhysicalDeviceVertexAttributeDivisorPropertiesEXT - Structure describing max value of vertex attribute divisor that can be supported by an implementation

Description

If the PhysicalDeviceVertexAttributeDivisorPropertiesEXT 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_vertex_attribute_divisor, StructureType

Constructors

PhysicalDeviceVertexAttributeDivisorPropertiesEXT

Fields

• maxVertexAttribDivisor :: Word32

  maxVertexAttribDivisor is the maximum value of the number of instances that will repeat the value of vertex attribute data when instanced rendering is enabled.

Instances

Storable PhysicalDeviceVertexAttributeDivisorPropertiesEXT

Defined in Vulkan.Extensions.VK_EXT_vertex_attribute_divisor

Methods

sizeOf :: PhysicalDeviceVertexAttributeDivisorPropertiesEXT -> Int

alignment :: PhysicalDeviceVertexAttributeDivisorPropertiesEXT -> Int

peekElemOff :: Ptr PhysicalDeviceVertexAttributeDivisorPropertiesEXT -> Int -> IO PhysicalDeviceVertexAttributeDivisorPropertiesEXT

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

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

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

peek :: Ptr PhysicalDeviceVertexAttributeDivisorPropertiesEXT -> IO PhysicalDeviceVertexAttributeDivisorPropertiesEXT

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

Show PhysicalDeviceVertexAttributeDivisorPropertiesEXT

Defined in Vulkan.Extensions.VK_EXT_vertex_attribute_divisor

Methods

showsPrec :: Int -> PhysicalDeviceVertexAttributeDivisorPropertiesEXT -> ShowS

show :: PhysicalDeviceVertexAttributeDivisorPropertiesEXT -> String

showList :: [PhysicalDeviceVertexAttributeDivisorPropertiesEXT] -> ShowS

Eq PhysicalDeviceVertexAttributeDivisorPropertiesEXT

Defined in Vulkan.Extensions.VK_EXT_vertex_attribute_divisor

Methods

(==) :: PhysicalDeviceVertexAttributeDivisorPropertiesEXT -> PhysicalDeviceVertexAttributeDivisorPropertiesEXT -> Bool

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

FromCStruct PhysicalDeviceVertexAttributeDivisorPropertiesEXT

Defined in Vulkan.Extensions.VK_EXT_vertex_attribute_divisor

Methods

peekCStruct :: Ptr PhysicalDeviceVertexAttributeDivisorPropertiesEXT -> IO PhysicalDeviceVertexAttributeDivisorPropertiesEXT

ToCStruct PhysicalDeviceVertexAttributeDivisorPropertiesEXT

Defined in Vulkan.Extensions.VK_EXT_vertex_attribute_divisor

Methods

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

pokeCStruct :: Ptr PhysicalDeviceVertexAttributeDivisorPropertiesEXT -> PhysicalDeviceVertexAttributeDivisorPropertiesEXT -> IO b -> IO b

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

pokeZeroCStruct :: Ptr PhysicalDeviceVertexAttributeDivisorPropertiesEXT -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero PhysicalDeviceVertexAttributeDivisorPropertiesEXT

Defined in Vulkan.Extensions.VK_EXT_vertex_attribute_divisor

Methods

zero :: PhysicalDeviceVertexAttributeDivisorPropertiesEXT

data PhysicalDeviceVertexAttributeDivisorFeaturesEXT

VkPhysicalDeviceVertexAttributeDivisorFeaturesEXT - Structure describing if fetching of vertex attribute may be repeated for instanced rendering

Members

This structure describes the following features:

Description

If the PhysicalDeviceVertexAttributeDivisorFeaturesEXT 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. PhysicalDeviceVertexAttributeDivisorFeaturesEXT can also be used in the pNext chain of DeviceCreateInfo to selectively enable these features.

Valid Usage (Implicit)

See Also

VK_EXT_vertex_attribute_divisor, Bool32, StructureType

Constructors

PhysicalDeviceVertexAttributeDivisorFeaturesEXT

Fields

• vertexAttributeInstanceRateDivisor :: Bool

  vertexAttributeInstanceRateDivisor specifies whether vertex attribute fetching may be repeated in case of instanced rendering.

• vertexAttributeInstanceRateZeroDivisor :: Bool

  vertexAttributeInstanceRateZeroDivisor specifies whether a zero value for VertexInputBindingDivisorDescriptionEXT::divisor is supported.

Instances

Storable PhysicalDeviceVertexAttributeDivisorFeaturesEXT

Defined in Vulkan.Extensions.VK_EXT_vertex_attribute_divisor

Methods

sizeOf :: PhysicalDeviceVertexAttributeDivisorFeaturesEXT -> Int

alignment :: PhysicalDeviceVertexAttributeDivisorFeaturesEXT -> Int

peekElemOff :: Ptr PhysicalDeviceVertexAttributeDivisorFeaturesEXT -> Int -> IO PhysicalDeviceVertexAttributeDivisorFeaturesEXT

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

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

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

peek :: Ptr PhysicalDeviceVertexAttributeDivisorFeaturesEXT -> IO PhysicalDeviceVertexAttributeDivisorFeaturesEXT

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

Show PhysicalDeviceVertexAttributeDivisorFeaturesEXT

Defined in Vulkan.Extensions.VK_EXT_vertex_attribute_divisor

Methods

showsPrec :: Int -> PhysicalDeviceVertexAttributeDivisorFeaturesEXT -> ShowS

show :: PhysicalDeviceVertexAttributeDivisorFeaturesEXT -> String

showList :: [PhysicalDeviceVertexAttributeDivisorFeaturesEXT] -> ShowS

Eq PhysicalDeviceVertexAttributeDivisorFeaturesEXT

Defined in Vulkan.Extensions.VK_EXT_vertex_attribute_divisor

Methods

(==) :: PhysicalDeviceVertexAttributeDivisorFeaturesEXT -> PhysicalDeviceVertexAttributeDivisorFeaturesEXT -> Bool

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

FromCStruct PhysicalDeviceVertexAttributeDivisorFeaturesEXT

Defined in Vulkan.Extensions.VK_EXT_vertex_attribute_divisor

Methods

peekCStruct :: Ptr PhysicalDeviceVertexAttributeDivisorFeaturesEXT -> IO PhysicalDeviceVertexAttributeDivisorFeaturesEXT

ToCStruct PhysicalDeviceVertexAttributeDivisorFeaturesEXT

Defined in Vulkan.Extensions.VK_EXT_vertex_attribute_divisor

Methods

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

pokeCStruct :: Ptr PhysicalDeviceVertexAttributeDivisorFeaturesEXT -> PhysicalDeviceVertexAttributeDivisorFeaturesEXT -> IO b -> IO b

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

pokeZeroCStruct :: Ptr PhysicalDeviceVertexAttributeDivisorFeaturesEXT -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero PhysicalDeviceVertexAttributeDivisorFeaturesEXT

Defined in Vulkan.Extensions.VK_EXT_vertex_attribute_divisor

Methods

zero :: PhysicalDeviceVertexAttributeDivisorFeaturesEXT

type EXT_VERTEX_ATTRIBUTE_DIVISOR_SPEC_VERSION = 3

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

type EXT_VERTEX_ATTRIBUTE_DIVISOR_EXTENSION_NAME = "VK_EXT_vertex_attribute_divisor"

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