Safe Haskell	None
Language	Haskell2010

Vulkan.Extensions.VK_EXT_vertex_input_dynamic_state

Description

Name

VK_EXT_vertex_input_dynamic_state - device extension

VK_EXT_vertex_input_dynamic_state

Name String: VK_EXT_vertex_input_dynamic_state

Extension Type

Device extension

Registered Extension Number

353

Revision

2

Extension and Version Dependencies

Requires Vulkan 1.0
Requires VK_KHR_get_physical_device_properties2

Contact

Piers Daniell @pdaniell-nv%0A<<Here describe the issue or question you have about the VK_EXT_vertex_input_dynamic_state extension> >

Other Extension Metadata

Last Modified Date: 2020-08-21

IP Status

No known IP claims.

Contributors

Jeff Bolz, NVIDIA
Spencer Fricke, Samsung
Stu Smith, AMD

Description

One of the states that contributes to the combinatorial explosion of pipeline state objects that need to be created, is the vertex input binding and attribute descriptions. By allowing them to be dynamic applications may reduce the number of pipeline objects they need to create.

This extension adds dynamic state support for what is normally static state in PipelineVertexInputStateCreateInfo.

New Commands

cmdSetVertexInputEXT

New Structures

VertexInputAttributeDescription2EXT

VertexInputBindingDescription2EXT
Extending PhysicalDeviceFeatures2, DeviceCreateInfo:
- PhysicalDeviceVertexInputDynamicStateFeaturesEXT

New Enum Constants

EXT_VERTEX_INPUT_DYNAMIC_STATE_EXTENSION_NAME

Version History

Revision 2, 2020-11-05 (Piers Daniell)
- Make VertexInputBindingDescription2EXT extensible
- Add new VertexInputAttributeDescription2EXT struct for the pVertexAttributeDescriptions parameter to cmdSetVertexInputEXT so it is also extensible

Revision 1, 2020-08-21 (Piers Daniell)
- Internal revisions

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

cmdSetVertexInputEXT :: forall io. MonadIO io => CommandBuffer -> ("vertexBindingDescriptions" ::: Vector VertexInputBindingDescription2EXT) -> ("vertexAttributeDescriptions" ::: Vector VertexInputAttributeDescription2EXT) -> io ()
data PhysicalDeviceVertexInputDynamicStateFeaturesEXT = PhysicalDeviceVertexInputDynamicStateFeaturesEXT {
- vertexInputDynamicState :: Bool
}
data VertexInputBindingDescription2EXT = VertexInputBindingDescription2EXT {
- binding :: Word32
- stride :: Word32
- inputRate :: VertexInputRate
- divisor :: Word32
}
data VertexInputAttributeDescription2EXT = VertexInputAttributeDescription2EXT {
- location :: Word32
- binding :: Word32
- format :: Format
- offset :: Word32
}
type EXT_VERTEX_INPUT_DYNAMIC_STATE_SPEC_VERSION = 2
pattern EXT_VERTEX_INPUT_DYNAMIC_STATE_SPEC_VERSION :: forall a. Integral a => a
type EXT_VERTEX_INPUT_DYNAMIC_STATE_EXTENSION_NAME = "VK_EXT_vertex_input_dynamic_state"
pattern EXT_VERTEX_INPUT_DYNAMIC_STATE_EXTENSION_NAME :: forall a. (Eq a, IsString a) => a

Documentation

cmdSetVertexInputEXT Source #

Arguments

:: forall io. MonadIO io
=> CommandBuffer	`commandBuffer` is the command buffer into which the command will be recorded.
-> ("vertexBindingDescriptions" ::: Vector VertexInputBindingDescription2EXT)	`pVertexBindingDescriptions` is a pointer to an array of `VertexInputBindingDescription2EXT` structures.
-> ("vertexAttributeDescriptions" ::: Vector VertexInputAttributeDescription2EXT)	`pVertexAttributeDescriptions` is a pointer to an array of `VertexInputAttributeDescription2EXT` structures.
-> io ()

vkCmdSetVertexInputEXT - Set the vertex input state dynamically for a command buffer

Description

This command sets the vertex input attribute and vertex input binding descriptions state for subsequent drawing commands when the graphics pipeline is created with DYNAMIC_STATE_VERTEX_INPUT_EXT set in PipelineDynamicStateCreateInfo::pDynamicStates. Otherwise, this state is specified by the GraphicsPipelineCreateInfo::pVertexInputState values used to create the currently active pipeline.

If the bound pipeline state object was also created with the DYNAMIC_STATE_VERTEX_INPUT_BINDING_STRIDE_EXT dynamic state enabled, then cmdBindVertexBuffers2EXT can be used instead of cmdSetVertexInputEXT to dynamically set the stride.

Valid Usage

The vertexInputDynamicState feature must be enabled

vertexBindingDescriptionCount must be less than or equal to PhysicalDeviceLimits::maxVertexInputBindings
vertexAttributeDescriptionCount must be less than or equal to PhysicalDeviceLimits::maxVertexInputAttributes
For every binding specified by each element of pVertexAttributeDescriptions, a VertexInputBindingDescription2EXT must exist in pVertexBindingDescriptions with the same value of binding
All elements of pVertexBindingDescriptions must describe distinct binding numbers
All elements of pVertexAttributeDescriptions must describe distinct attribute locations

Valid Usage (Implicit)

commandBuffer must be a valid CommandBuffer handle

If vertexBindingDescriptionCount is not 0, pVertexBindingDescriptions must be a valid pointer to an array of vertexBindingDescriptionCount valid VertexInputBindingDescription2EXT structures
If vertexAttributeDescriptionCount is not 0, pVertexAttributeDescriptions must be a valid pointer to an array of vertexAttributeDescriptionCount valid VertexInputAttributeDescription2EXT structures
commandBuffer must be in the recording state
The CommandPool that commandBuffer was allocated from must support graphics operations

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

'

Command Buffer Levels	Render Pass Scope	Supported Queue Types
Primary Secondary	Both	Graphics

Members

This structure describes the following feature:

Description

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

Valid Usage (Implicit)

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

data VertexInputBindingDescription2EXT Source #

VkVertexInputBindingDescription2EXT - Structure specifying the extended vertex input binding description

Valid Usage

binding must be less than PhysicalDeviceLimits::maxVertexInputBindings

stride must be less than or equal to PhysicalDeviceLimits::maxVertexInputBindingStride
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
If divisor is not 1 then inputRate must be of type VERTEX_INPUT_RATE_INSTANCE

Valid Usage (Implicit)

sType must be STRUCTURE_TYPE_VERTEX_INPUT_BINDING_DESCRIPTION_2_EXT

inputRate must be a valid VertexInputRate value

binding :: Word32
binding is the binding number that this structure describes.
stride :: Word32
stride is the byte stride between consecutive elements within the buffer.
inputRate :: VertexInputRate
inputRate is a VertexInputRate value specifying whether vertex attribute addressing is a function of the vertex index or of the instance index.
divisor :: Word32
divisor is the number of successive instances that will use the same value of the vertex attribute when instanced rendering is enabled. This member can be set to a value other than 1 if the vertexAttributeInstanceRateDivisor feature 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

Instances details

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

data VertexInputAttributeDescription2EXT Source #

VkVertexInputAttributeDescription2EXT - Structure specifying the extended vertex input attribute description

Valid Usage

location must be less than PhysicalDeviceLimits::maxVertexInputAttributes

binding must be less than PhysicalDeviceLimits::maxVertexInputBindings
offset must be less than or equal to PhysicalDeviceLimits::maxVertexInputAttributeOffset
format must be allowed as a vertex buffer format, as specified by the FORMAT_FEATURE_VERTEX_BUFFER_BIT flag in FormatProperties::bufferFeatures returned by getPhysicalDeviceFormatProperties
If the VK_KHR_portability_subset extension is enabled, and PhysicalDevicePortabilitySubsetFeaturesKHR::vertexAttributeAccessBeyondStride is FALSE, the sum of offset plus the size of the vertex attribute data described by format must not be greater than stride in the VertexInputBindingDescription2EXT referenced in binding

Valid Usage (Implicit)

sType must be STRUCTURE_TYPE_VERTEX_INPUT_ATTRIBUTE_DESCRIPTION_2_EXT

format must be a valid Format value

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

Name

VK_EXT_vertex_input_dynamic_state

Other Extension Metadata

Description

New Commands

New Structures

New Enum Constants

Version History

See Also

Document Notes

Documentation

Description

Valid Usage

Valid Usage (Implicit)

Host Synchronization

Command Properties

See Also

Members

Description

Valid Usage (Implicit)

See Also

Instances

Valid Usage

Valid Usage (Implicit)

See Also

Instances

Valid Usage

Valid Usage (Implicit)

See Also

Instances

PhysicalDeviceVertexInputDynamicStateFeaturesEXT
Fields vertexInputDynamicState :: Bool `vertexInputDynamicState` indicates that the implementation supports the following dynamic states: `DYNAMIC_STATE_VERTEX_INPUT_EXT`

VertexInputAttributeDescription2EXT
Fields location :: Word32 `location` is the shader input location number for this attribute. binding :: Word32 `binding` is the binding number which this attribute takes its data from. format :: Format `format` is the size and type of the vertex attribute data. offset :: Word32 `offset` is a byte offset of this attribute relative to the start of an element in the vertex input binding.