Package org.lwjgl.vulkan

Class EXTVertexInputDynamicState

java.lang.Object

org.lwjgl.vulkan.EXTVertexInputDynamicState

public class EXTVertexInputDynamicState
extends java.lang.Object

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 VkPipelineVertexInputStateCreateInfo.

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

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

Field Summary

Fields

Modifier and Type	Field	Description
static int	VK_DYNAMIC_STATE_VERTEX_INPUT_EXT	Extends VkDynamicState.
static java.lang.String	VK_EXT_VERTEX_INPUT_DYNAMIC_STATE_EXTENSION_NAME	The extension name.
static int	VK_EXT_VERTEX_INPUT_DYNAMIC_STATE_SPEC_VERSION	The extension specification version.
static int	VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_VERTEX_INPUT_DYNAMIC_STATE_FEATURES_EXT VK_STRUCTURE_TYPE_VERTEX_INPUT_ATTRIBUTE_DESCRIPTION_2_EXT VK_STRUCTURE_TYPE_VERTEX_INPUT_BINDING_DESCRIPTION_2_EXT	Extends VkStructureType.

Method Summary

Modifier and Type	Method	Description
static void	nvkCmdSetVertexInputEXT(org.lwjgl.vulkan.VkCommandBuffer commandBuffer, int vertexBindingDescriptionCount, long pVertexBindingDescriptions, int vertexAttributeDescriptionCount, long pVertexAttributeDescriptions)	Unsafe version of: CmdSetVertexInputEXT
static void	vkCmdSetVertexInputEXT(org.lwjgl.vulkan.VkCommandBuffer commandBuffer, VkVertexInputBindingDescription2EXT.Buffer pVertexBindingDescriptions, VkVertexInputAttributeDescription2EXT.Buffer pVertexAttributeDescriptions)	Set the vertex input state dynamically for a command buffer.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

VK_EXT_VERTEX_INPUT_DYNAMIC_STATE_SPEC_VERSION

The extension specification version.

VK_EXT_VERTEX_INPUT_DYNAMIC_STATE_EXTENSION_NAME

The extension name.

VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_VERTEX_INPUT_DYNAMIC_STATE_FEATURES_EXT, VK_STRUCTURE_TYPE_VERTEX_INPUT_BINDING_DESCRIPTION_2_EXT, VK_STRUCTURE_TYPE_VERTEX_INPUT_ATTRIBUTE_DESCRIPTION_2_EXT

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_PHYSICAL_DEVICE_VERTEX_INPUT_DYNAMIC_STATE_FEATURES_EXT
• STRUCTURE_TYPE_VERTEX_INPUT_BINDING_DESCRIPTION_2_EXT
• STRUCTURE_TYPE_VERTEX_INPUT_ATTRIBUTE_DESCRIPTION_2_EXT

VK_DYNAMIC_STATE_VERTEX_INPUT_EXT

Extends VkDynamicState.

Method Detail

nvkCmdSetVertexInputEXT

public static void nvkCmdSetVertexInputEXT(org.lwjgl.vulkan.VkCommandBuffer commandBuffer,
                                           int vertexBindingDescriptionCount,
                                           long pVertexBindingDescriptions,
                                           int vertexAttributeDescriptionCount,
                                           long pVertexAttributeDescriptions)

Unsafe version of: CmdSetVertexInputEXT

Parameters:

vertexBindingDescriptionCount - the number of vertex binding descriptions provided in pVertexBindingDescriptions.

vertexAttributeDescriptionCount - the number of vertex attribute descriptions provided in pVertexAttributeDescriptions.

vkCmdSetVertexInputEXT

public static void vkCmdSetVertexInputEXT(org.lwjgl.vulkan.VkCommandBuffer commandBuffer,
                                          @Nullable
                                          VkVertexInputBindingDescription2EXT.Buffer pVertexBindingDescriptions,
                                          @Nullable
                                          VkVertexInputAttributeDescription2EXT.Buffer pVertexAttributeDescriptions)

Set the vertex input state dynamically for a command buffer.

C Specification

To dynamically set the vertex input attribute and vertex input binding descriptions, call:

 void vkCmdSetVertexInputEXT(
     VkCommandBuffer                             commandBuffer,
     uint32_t                                    vertexBindingDescriptionCount,
     const VkVertexInputBindingDescription2EXT*  pVertexBindingDescriptions,
     uint32_t                                    vertexAttributeDescriptionCount,
     const VkVertexInputAttributeDescription2EXT* pVertexAttributeDescriptions);

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 VkPipelineDynamicStateCreateInfo::pDynamicStates. Otherwise, this state is specified by the VkGraphicsPipelineCreateInfo::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 dynamic state enabled, then CmdBindVertexBuffers2 can be used instead of vkCmdSetVertexInputEXT to dynamically set the stride.

Valid Usage

• The vertexInputDynamicState feature must be enabled
• vertexBindingDescriptionCount must be less than or equal to VkPhysicalDeviceLimits::maxVertexInputBindings
• vertexAttributeDescriptionCount must be less than or equal to VkPhysicalDeviceLimits::maxVertexInputAttributes
• For every binding specified by each element of pVertexAttributeDescriptions, a VkVertexInputBindingDescription2EXT 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 VkCommandBuffer handle
• If vertexBindingDescriptionCount is not 0, pVertexBindingDescriptions must be a valid pointer to an array of vertexBindingDescriptionCount valid VkVertexInputBindingDescription2EXT structures
• If vertexAttributeDescriptionCount is not 0, pVertexAttributeDescriptions must be a valid pointer to an array of vertexAttributeDescriptionCount valid VkVertexInputAttributeDescription2EXT structures
• commandBuffer must be in the recording state
• The VkCommandPool that commandBuffer was allocated from must support graphics operations

Host Synchronization

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

Command Properties

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

See Also

VkVertexInputAttributeDescription2EXT, VkVertexInputBindingDescription2EXT

Parameters:

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

pVertexBindingDescriptions - a pointer to an array of VkVertexInputBindingDescription2EXT structures.

pVertexAttributeDescriptions - a pointer to an array of VkVertexInputAttributeDescription2EXT structures.