Safe Haskell	Safe-Inferred
Language	Haskell2010

Vulkan.Extensions.VK_KHR_vertex_attribute_divisor

Description

Name

VK_KHR_vertex_attribute_divisor - device extension

VK_KHR_vertex_attribute_divisor

Name String: VK_KHR_vertex_attribute_divisor

Extension Type

Device extension

Registered Extension Number

526

Revision

1

Ratification Status

Ratified

Extension and Version Dependencies

VK_KHR_get_physical_device_properties2 or Version 1.1

Contact

Shahbaz Youssefi @syoussefi%0A*Here describe the issue or question you have about the VK_KHR_vertex_attribute_divisor extension*

Extension Proposal

VK_KHR_vertex_attribute_divisor

Other Extension Metadata

Last Modified Date: 2023-09-20

IP Status

No known IP claims.

Contributors

Shahbaz Youssefi, Google
Contributors to VK_EXT_vertex_attribute_divisor

Description

This extension is based on the VK_EXT_vertex_attribute_divisor extension. The only difference is the new property supportsNonZeroFirstInstance, which indicates support for non-zero values in firstInstance. This allows the extension to be supported on implementations that have traditionally only supported OpenGL ES.

New Structures

VertexInputBindingDivisorDescriptionKHR

Extending PhysicalDeviceFeatures2, DeviceCreateInfo:
- PhysicalDeviceVertexAttributeDivisorFeaturesKHR
Extending PhysicalDeviceProperties2:
- PhysicalDeviceVertexAttributeDivisorPropertiesKHR
Extending PipelineVertexInputStateCreateInfo:
- PipelineVertexInputDivisorStateCreateInfoKHR

New Enum Constants

KHR_VERTEX_ATTRIBUTE_DIVISOR_EXTENSION_NAME

Version History

Revision 1, 2023-09-20 (Shahbaz Youssefi)
- First Version, based on VK_EXT_vertex_attribute_divisor

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.

Synopsis

data VertexInputBindingDivisorDescriptionKHR = VertexInputBindingDivisorDescriptionKHR {
- binding :: Word32
- divisor :: Word32
}
data PipelineVertexInputDivisorStateCreateInfoKHR = PipelineVertexInputDivisorStateCreateInfoKHR {
- vertexBindingDivisors :: Vector VertexInputBindingDivisorDescriptionKHR
}
data PhysicalDeviceVertexAttributeDivisorPropertiesKHR = PhysicalDeviceVertexAttributeDivisorPropertiesKHR {
- maxVertexAttribDivisor :: Word32
- supportsNonZeroFirstInstance :: Bool
}
data PhysicalDeviceVertexAttributeDivisorFeaturesKHR = PhysicalDeviceVertexAttributeDivisorFeaturesKHR {
- vertexAttributeInstanceRateDivisor :: Bool
- vertexAttributeInstanceRateZeroDivisor :: Bool
}
type KHR_VERTEX_ATTRIBUTE_DIVISOR_SPEC_VERSION = 1
pattern KHR_VERTEX_ATTRIBUTE_DIVISOR_SPEC_VERSION :: forall a. Integral a => a
type KHR_VERTEX_ATTRIBUTE_DIVISOR_EXTENSION_NAME = "VK_KHR_vertex_attribute_divisor"
pattern KHR_VERTEX_ATTRIBUTE_DIVISOR_EXTENSION_NAME :: forall a. (Eq a, IsString a) => a

Documentation

data VertexInputBindingDivisorDescriptionKHR Source #

VkVertexInputBindingDivisorDescriptionKHR - 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 PhysicalDeviceVertexAttributeDivisorPropertiesKHR::maxVertexAttribDivisor, inclusive
VertexInputBindingDescription::inputRate must be of type VERTEX_INPUT_RATE_INSTANCE for this binding

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 PhysicalDeviceVertexAttributeDivisorPropertiesKHR::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

Instances details

Storable VertexInputBindingDivisorDescriptionKHR Source #
Instance details Defined in Vulkan.Extensions.VK_KHR_vertex_attribute_divisor Methods sizeOf :: VertexInputBindingDivisorDescriptionKHR -> Int # alignment :: VertexInputBindingDivisorDescriptionKHR -> Int # peekElemOff :: Ptr VertexInputBindingDivisorDescriptionKHR -> Int -> IO VertexInputBindingDivisorDescriptionKHR # pokeElemOff :: Ptr VertexInputBindingDivisorDescriptionKHR -> Int -> VertexInputBindingDivisorDescriptionKHR -> IO () # peekByteOff :: Ptr b -> Int -> IO VertexInputBindingDivisorDescriptionKHR # pokeByteOff :: Ptr b -> Int -> VertexInputBindingDivisorDescriptionKHR -> IO () # peek :: Ptr VertexInputBindingDivisorDescriptionKHR -> IO VertexInputBindingDivisorDescriptionKHR # poke :: Ptr VertexInputBindingDivisorDescriptionKHR -> VertexInputBindingDivisorDescriptionKHR -> IO () #
Show VertexInputBindingDivisorDescriptionKHR Source #
Instance details Defined in Vulkan.Extensions.VK_KHR_vertex_attribute_divisor Methods showsPrec :: Int -> VertexInputBindingDivisorDescriptionKHR -> ShowS # show :: VertexInputBindingDivisorDescriptionKHR -> String # showList :: [VertexInputBindingDivisorDescriptionKHR] -> ShowS #
Eq VertexInputBindingDivisorDescriptionKHR Source #
Instance details Defined in Vulkan.Extensions.VK_KHR_vertex_attribute_divisor Methods (==) :: VertexInputBindingDivisorDescriptionKHR -> VertexInputBindingDivisorDescriptionKHR -> Bool # (/=) :: VertexInputBindingDivisorDescriptionKHR -> VertexInputBindingDivisorDescriptionKHR -> Bool #
FromCStruct VertexInputBindingDivisorDescriptionKHR Source #
Instance details Defined in Vulkan.Extensions.VK_KHR_vertex_attribute_divisor Methods peekCStruct :: Ptr VertexInputBindingDivisorDescriptionKHR -> IO VertexInputBindingDivisorDescriptionKHR Source #
ToCStruct VertexInputBindingDivisorDescriptionKHR Source #
Instance details Defined in Vulkan.Extensions.VK_KHR_vertex_attribute_divisor Methods withCStruct :: VertexInputBindingDivisorDescriptionKHR -> (Ptr VertexInputBindingDivisorDescriptionKHR -> IO b) -> IO b Source # pokeCStruct :: Ptr VertexInputBindingDivisorDescriptionKHR -> VertexInputBindingDivisorDescriptionKHR -> IO b -> IO b Source # withZeroCStruct :: (Ptr VertexInputBindingDivisorDescriptionKHR -> IO b) -> IO b Source # pokeZeroCStruct :: Ptr VertexInputBindingDivisorDescriptionKHR -> IO b -> IO b Source # cStructSize :: Int Source # cStructAlignment :: Int Source #
Zero VertexInputBindingDivisorDescriptionKHR Source #
Instance details Defined in Vulkan.Extensions.VK_KHR_vertex_attribute_divisor Methods zero :: VertexInputBindingDivisorDescriptionKHR Source #

data PipelineVertexInputDivisorStateCreateInfoKHR Source #

VkPipelineVertexInputDivisorStateCreateInfoKHR - Structure specifying vertex attributes assignment during instanced rendering

Valid Usage (Implicit)

Description

If the PhysicalDeviceVertexAttributeDivisorPropertiesKHR 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)

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.
supportsNonZeroFirstInstance :: Bool
supportsNonZeroFirstInstance specifies whether a non-zero value for the firstInstance parameter of drawing commands is supported when VertexInputBindingDivisorDescriptionKHR::divisor is not 1.

Instances

Instances details

Storable PhysicalDeviceVertexAttributeDivisorPropertiesKHR Source #
Instance details Defined in Vulkan.Extensions.VK_KHR_vertex_attribute_divisor Methods sizeOf :: PhysicalDeviceVertexAttributeDivisorPropertiesKHR -> Int # alignment :: PhysicalDeviceVertexAttributeDivisorPropertiesKHR -> Int # peekElemOff :: Ptr PhysicalDeviceVertexAttributeDivisorPropertiesKHR -> Int -> IO PhysicalDeviceVertexAttributeDivisorPropertiesKHR # pokeElemOff :: Ptr PhysicalDeviceVertexAttributeDivisorPropertiesKHR -> Int -> PhysicalDeviceVertexAttributeDivisorPropertiesKHR -> IO () # peekByteOff :: Ptr b -> Int -> IO PhysicalDeviceVertexAttributeDivisorPropertiesKHR # pokeByteOff :: Ptr b -> Int -> PhysicalDeviceVertexAttributeDivisorPropertiesKHR -> IO () # peek :: Ptr PhysicalDeviceVertexAttributeDivisorPropertiesKHR -> IO PhysicalDeviceVertexAttributeDivisorPropertiesKHR # poke :: Ptr PhysicalDeviceVertexAttributeDivisorPropertiesKHR -> PhysicalDeviceVertexAttributeDivisorPropertiesKHR -> IO () #
Show PhysicalDeviceVertexAttributeDivisorPropertiesKHR Source #
Instance details Defined in Vulkan.Extensions.VK_KHR_vertex_attribute_divisor Methods showsPrec :: Int -> PhysicalDeviceVertexAttributeDivisorPropertiesKHR -> ShowS # show :: PhysicalDeviceVertexAttributeDivisorPropertiesKHR -> String # showList :: [PhysicalDeviceVertexAttributeDivisorPropertiesKHR] -> ShowS #
Eq PhysicalDeviceVertexAttributeDivisorPropertiesKHR Source #
Instance details Defined in Vulkan.Extensions.VK_KHR_vertex_attribute_divisor Methods (==) :: PhysicalDeviceVertexAttributeDivisorPropertiesKHR -> PhysicalDeviceVertexAttributeDivisorPropertiesKHR -> Bool # (/=) :: PhysicalDeviceVertexAttributeDivisorPropertiesKHR -> PhysicalDeviceVertexAttributeDivisorPropertiesKHR -> Bool #
FromCStruct PhysicalDeviceVertexAttributeDivisorPropertiesKHR Source #
Instance details Defined in Vulkan.Extensions.VK_KHR_vertex_attribute_divisor Methods peekCStruct :: Ptr PhysicalDeviceVertexAttributeDivisorPropertiesKHR -> IO PhysicalDeviceVertexAttributeDivisorPropertiesKHR Source #
ToCStruct PhysicalDeviceVertexAttributeDivisorPropertiesKHR Source #
Instance details Defined in Vulkan.Extensions.VK_KHR_vertex_attribute_divisor Methods withCStruct :: PhysicalDeviceVertexAttributeDivisorPropertiesKHR -> (Ptr PhysicalDeviceVertexAttributeDivisorPropertiesKHR -> IO b) -> IO b Source # pokeCStruct :: Ptr PhysicalDeviceVertexAttributeDivisorPropertiesKHR -> PhysicalDeviceVertexAttributeDivisorPropertiesKHR -> IO b -> IO b Source # withZeroCStruct :: (Ptr PhysicalDeviceVertexAttributeDivisorPropertiesKHR -> IO b) -> IO b Source # pokeZeroCStruct :: Ptr PhysicalDeviceVertexAttributeDivisorPropertiesKHR -> IO b -> IO b Source # cStructSize :: Int Source # cStructAlignment :: Int Source #
Zero PhysicalDeviceVertexAttributeDivisorPropertiesKHR Source #
Instance details Defined in Vulkan.Extensions.VK_KHR_vertex_attribute_divisor Methods zero :: PhysicalDeviceVertexAttributeDivisorPropertiesKHR Source #

data PhysicalDeviceVertexAttributeDivisorFeaturesKHR Source #

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

Members

This structure describes the following features:

Description

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

Valid Usage (Implicit)

PhysicalDeviceVertexAttributeDivisorFeaturesKHR
Fields vertexAttributeInstanceRateDivisor :: Bool `vertexAttributeInstanceRateDivisor` specifies whether vertex attribute fetching may be repeated in the case of instanced rendering. vertexAttributeInstanceRateZeroDivisor :: Bool `vertexAttributeInstanceRateZeroDivisor` specifies whether a zero value for `VertexInputBindingDivisorDescriptionEXT`::`divisor` is supported.

Instances

Instances details

Storable PhysicalDeviceVertexAttributeDivisorFeaturesKHR Source #
Instance details Defined in Vulkan.Extensions.VK_KHR_vertex_attribute_divisor Methods sizeOf :: PhysicalDeviceVertexAttributeDivisorFeaturesKHR -> Int # alignment :: PhysicalDeviceVertexAttributeDivisorFeaturesKHR -> Int # peekElemOff :: Ptr PhysicalDeviceVertexAttributeDivisorFeaturesKHR -> Int -> IO PhysicalDeviceVertexAttributeDivisorFeaturesKHR # pokeElemOff :: Ptr PhysicalDeviceVertexAttributeDivisorFeaturesKHR -> Int -> PhysicalDeviceVertexAttributeDivisorFeaturesKHR -> IO () # peekByteOff :: Ptr b -> Int -> IO PhysicalDeviceVertexAttributeDivisorFeaturesKHR # pokeByteOff :: Ptr b -> Int -> PhysicalDeviceVertexAttributeDivisorFeaturesKHR -> IO () # peek :: Ptr PhysicalDeviceVertexAttributeDivisorFeaturesKHR -> IO PhysicalDeviceVertexAttributeDivisorFeaturesKHR # poke :: Ptr PhysicalDeviceVertexAttributeDivisorFeaturesKHR -> PhysicalDeviceVertexAttributeDivisorFeaturesKHR -> IO () #
Show PhysicalDeviceVertexAttributeDivisorFeaturesKHR Source #
Instance details Defined in Vulkan.Extensions.VK_KHR_vertex_attribute_divisor Methods showsPrec :: Int -> PhysicalDeviceVertexAttributeDivisorFeaturesKHR -> ShowS # show :: PhysicalDeviceVertexAttributeDivisorFeaturesKHR -> String # showList :: [PhysicalDeviceVertexAttributeDivisorFeaturesKHR] -> ShowS #
Eq PhysicalDeviceVertexAttributeDivisorFeaturesKHR Source #
Instance details Defined in Vulkan.Extensions.VK_KHR_vertex_attribute_divisor Methods (==) :: PhysicalDeviceVertexAttributeDivisorFeaturesKHR -> PhysicalDeviceVertexAttributeDivisorFeaturesKHR -> Bool # (/=) :: PhysicalDeviceVertexAttributeDivisorFeaturesKHR -> PhysicalDeviceVertexAttributeDivisorFeaturesKHR -> Bool #
FromCStruct PhysicalDeviceVertexAttributeDivisorFeaturesKHR Source #
Instance details Defined in Vulkan.Extensions.VK_KHR_vertex_attribute_divisor Methods peekCStruct :: Ptr PhysicalDeviceVertexAttributeDivisorFeaturesKHR -> IO PhysicalDeviceVertexAttributeDivisorFeaturesKHR Source #
ToCStruct PhysicalDeviceVertexAttributeDivisorFeaturesKHR Source #
Instance details Defined in Vulkan.Extensions.VK_KHR_vertex_attribute_divisor Methods withCStruct :: PhysicalDeviceVertexAttributeDivisorFeaturesKHR -> (Ptr PhysicalDeviceVertexAttributeDivisorFeaturesKHR -> IO b) -> IO b Source # pokeCStruct :: Ptr PhysicalDeviceVertexAttributeDivisorFeaturesKHR -> PhysicalDeviceVertexAttributeDivisorFeaturesKHR -> IO b -> IO b Source # withZeroCStruct :: (Ptr PhysicalDeviceVertexAttributeDivisorFeaturesKHR -> IO b) -> IO b Source # pokeZeroCStruct :: Ptr PhysicalDeviceVertexAttributeDivisorFeaturesKHR -> IO b -> IO b Source # cStructSize :: Int Source # cStructAlignment :: Int Source #
Zero PhysicalDeviceVertexAttributeDivisorFeaturesKHR Source #
Instance details Defined in Vulkan.Extensions.VK_KHR_vertex_attribute_divisor Methods zero :: PhysicalDeviceVertexAttributeDivisorFeaturesKHR Source #

type KHR_VERTEX_ATTRIBUTE_DIVISOR_SPEC_VERSION = 1 Source #

pattern KHR_VERTEX_ATTRIBUTE_DIVISOR_SPEC_VERSION :: forall a. Integral a => a Source #

type KHR_VERTEX_ATTRIBUTE_DIVISOR_EXTENSION_NAME = "VK_KHR_vertex_attribute_divisor" Source #

pattern KHR_VERTEX_ATTRIBUTE_DIVISOR_EXTENSION_NAME :: forall a. (Eq a, IsString a) => a Source #

Show PipelineVertexInputDivisorStateCreateInfoKHR Source #
Instance details Defined in Vulkan.Extensions.VK_KHR_vertex_attribute_divisor Methods showsPrec :: Int -> PipelineVertexInputDivisorStateCreateInfoKHR -> ShowS # show :: PipelineVertexInputDivisorStateCreateInfoKHR -> String # showList :: [PipelineVertexInputDivisorStateCreateInfoKHR] -> ShowS #
FromCStruct PipelineVertexInputDivisorStateCreateInfoKHR Source #
Instance details Defined in Vulkan.Extensions.VK_KHR_vertex_attribute_divisor Methods peekCStruct :: Ptr PipelineVertexInputDivisorStateCreateInfoKHR -> IO PipelineVertexInputDivisorStateCreateInfoKHR Source #
ToCStruct PipelineVertexInputDivisorStateCreateInfoKHR Source #
Instance details Defined in Vulkan.Extensions.VK_KHR_vertex_attribute_divisor Methods withCStruct :: PipelineVertexInputDivisorStateCreateInfoKHR -> (Ptr PipelineVertexInputDivisorStateCreateInfoKHR -> IO b) -> IO b Source # pokeCStruct :: Ptr PipelineVertexInputDivisorStateCreateInfoKHR -> PipelineVertexInputDivisorStateCreateInfoKHR -> IO b -> IO b Source # withZeroCStruct :: (Ptr PipelineVertexInputDivisorStateCreateInfoKHR -> IO b) -> IO b Source # pokeZeroCStruct :: Ptr PipelineVertexInputDivisorStateCreateInfoKHR -> IO b -> IO b Source # cStructSize :: Int Source # cStructAlignment :: Int Source #
Zero PipelineVertexInputDivisorStateCreateInfoKHR Source #
Instance details Defined in Vulkan.Extensions.VK_KHR_vertex_attribute_divisor Methods zero :: PipelineVertexInputDivisorStateCreateInfoKHR Source #

Name

VK_KHR_vertex_attribute_divisor

Other Extension Metadata

Description

New Structures

New Enum Constants

Version History

See Also

Document Notes

Documentation

Description

Valid Usage

See Also

Instances

Valid Usage (Implicit)

See Also

Instances

Description

Valid Usage (Implicit)

See Also

Instances

Members

Description

Valid Usage (Implicit)

See Also

Instances

PipelineVertexInputDivisorStateCreateInfoKHR
Fields vertexBindingDivisors :: Vector VertexInputBindingDivisorDescriptionKHR `pVertexBindingDivisors` is a pointer to an array of `VertexInputBindingDivisorDescriptionKHR` structures specifying the divisor value for each binding. `pVertexBindingDivisors` must be a valid pointer to an array of `vertexBindingDivisorCount` `VertexInputBindingDivisorDescriptionKHR` structures