VkPipelineVertexInputDivisorStateCreateInfoKHR(3)

# VkPipelineVertexInputDivisorStateCreateInfoKHR(3) Manual Page

## Name

VkPipelineVertexInputDivisorStateCreateInfoKHR - Structure specifying vertex attributes assignment during instanced rendering

Loading… please wait.

## C Specification

If the `vertexAttributeInstanceRateDivisor` feature is enabled and the `pNext` chain of VkPipelineVertexInputStateCreateInfo includes a `VkPipelineVertexInputDivisorStateCreateInfoKHR` structure, then that structure controls how vertex attributes are assigned to an instance when instanced rendering is enabled.

The `VkPipelineVertexInputDivisorStateCreateInfoKHR` structure is defined as:

    // Provided by VK_KHR_vertex_attribute_divisor
    typedef struct VkPipelineVertexInputDivisorStateCreateInfoKHR {
        VkStructureType                                     sType;
        const void*                                         pNext;
        uint32_t                                            vertexBindingDivisorCount;
        const VkVertexInputBindingDivisorDescriptionKHR*    pVertexBindingDivisors;
    } VkPipelineVertexInputDivisorStateCreateInfoKHR;

or the equivalent

    // Provided by VK_EXT_vertex_attribute_divisor
    typedef VkPipelineVertexInputDivisorStateCreateInfoKHR VkPipelineVertexInputDivisorStateCreateInfoEXT;

## Members

- `sType` is a VkStructureType value identifying this structure.

- `pNext` is `NULL` or a pointer to a structure extending this structure.

- `vertexBindingDivisorCount` is the number of elements in the `pVertexBindingDivisors` array.

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

## Description

Valid Usage (Implicit)

- VUID-VkPipelineVertexInputDivisorStateCreateInfoKHR-sType-sType
  `sType` must be `VK_STRUCTURE_TYPE_PIPELINE_VERTEX_INPUT_DIVISOR_STATE_CREATE_INFO_KHR`

- VUID-VkPipelineVertexInputDivisorStateCreateInfoKHR-pVertexBindingDivisors-parameter
  `pVertexBindingDivisors` must be a valid pointer to an array of `vertexBindingDivisorCount` VkVertexInputBindingDivisorDescriptionKHR structures

- VUID-VkPipelineVertexInputDivisorStateCreateInfoKHR-vertexBindingDivisorCount-arraylength
  `vertexBindingDivisorCount` must be greater than `0`

## See Also

VK_EXT_vertex_attribute_divisor, VK_KHR_vertex_attribute_divisor, VkStructureType, VkVertexInputBindingDivisorDescriptionKHR

## Document Notes

For more information, see the Vulkan Specification

This page is extracted from the Vulkan Specification. Fixes and changes should be made to the Specification, not directly.

## Copyright

Copyright 2014-2024 The Khronos Group Inc.

SPDX-License-Identifier: CC-BY-4.0