VkVertexInputBindingDescription (LWJGL 3.2.4 SNAPSHOT

java.lang.Object
- org.lwjgl.system.Pointer.Default
- - org.lwjgl.system.Struct
  - - org.lwjgl.vulkan.VkVertexInputBindingDescription

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
```
public class VkVertexInputBindingDescription
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
```
Structure specifying vertex input binding description.
Valid Usage
- binding must be less than VkPhysicalDeviceLimits::maxVertexInputBindings
- stride must be less than or equal to VkPhysicalDeviceLimits::maxVertexInputBindingStride
Valid Usage (Implicit)
- inputRate must be a valid VkVertexInputRate value
See Also

VkPipelineVertexInputStateCreateInfo

Member documentation
- binding – the binding number that this structure describes.
- stride – the distance in bytes between two consecutive elements within the buffer.
- inputRate – a VkVertexInputRate value specifying whether vertex attribute addressing is a function of the vertex index or of the instance index.
Layout
```
 struct VkVertexInputBindingDescription {
     uint32_t binding;
     uint32_t stride;
     VkVertexInputRate inputRate;
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class VkVertexInputBindingDescription.Buffer
An array of VkVertexInputBindingDescription structs.
- Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
  org.lwjgl.system.Pointer.Default

Nested Classes
Modifier and Type	Class and Description
`static class`	`VkVertexInputBindingDescription.Buffer` An array of `VkVertexInputBindingDescription` structs.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALIGNOF` The struct alignment in bytes.
`static int`	`BINDING` The struct member offsets.
`static int`	`INPUTRATE` The struct member offsets.
`static int`	`SIZEOF` The struct size in bytes.
`static int`	`STRIDE` The struct member offsets.

Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors
Constructor and Description
`VkVertexInputBindingDescription(java.nio.ByteBuffer container)` Creates a `VkVertexInputBindingDescription` instance at the current position of the specified `ByteBuffer` container.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`binding()` Returns the value of the `binding` field.
`VkVertexInputBindingDescription`	`binding(int value)` Sets the specified value to the `binding` field.
`static VkVertexInputBindingDescription`	`calloc()` Returns a new `VkVertexInputBindingDescription` instance allocated with `memCalloc`.
`static VkVertexInputBindingDescription.Buffer`	`calloc(int capacity)` Returns a new `VkVertexInputBindingDescription.Buffer` instance allocated with `memCalloc`.
`static VkVertexInputBindingDescription`	`callocStack()` Returns a new `VkVertexInputBindingDescription` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkVertexInputBindingDescription.Buffer`	`callocStack(int capacity)` Returns a new `VkVertexInputBindingDescription.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkVertexInputBindingDescription.Buffer`	`callocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkVertexInputBindingDescription.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkVertexInputBindingDescription`	`callocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkVertexInputBindingDescription` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkVertexInputBindingDescription`	`create()` Returns a new `VkVertexInputBindingDescription` instance allocated with `BufferUtils`.
`static VkVertexInputBindingDescription.Buffer`	`create(int capacity)` Returns a new `VkVertexInputBindingDescription.Buffer` instance allocated with `BufferUtils`.
`static VkVertexInputBindingDescription`	`create(long address)` Returns a new `VkVertexInputBindingDescription` instance for the specified memory address.
`static VkVertexInputBindingDescription.Buffer`	`create(long address, int capacity)` Create a `VkVertexInputBindingDescription.Buffer` instance at the specified memory.
`static VkVertexInputBindingDescription`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static VkVertexInputBindingDescription.Buffer`	`createSafe(long address, int capacity)` Like `create`, but returns `null` if `address` is `NULL`.
`int`	`inputRate()` Returns the value of the `inputRate` field.
`VkVertexInputBindingDescription`	`inputRate(int value)` Sets the specified value to the `inputRate` field.
`static VkVertexInputBindingDescription`	`malloc()` Returns a new `VkVertexInputBindingDescription` instance allocated with `memAlloc`.
`static VkVertexInputBindingDescription.Buffer`	`malloc(int capacity)` Returns a new `VkVertexInputBindingDescription.Buffer` instance allocated with `memAlloc`.
`static VkVertexInputBindingDescription`	`mallocStack()` Returns a new `VkVertexInputBindingDescription` instance allocated on the thread-local `MemoryStack`.
`static VkVertexInputBindingDescription.Buffer`	`mallocStack(int capacity)` Returns a new `VkVertexInputBindingDescription.Buffer` instance allocated on the thread-local `MemoryStack`.
`static VkVertexInputBindingDescription.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkVertexInputBindingDescription.Buffer` instance allocated on the specified `MemoryStack`.
`static VkVertexInputBindingDescription`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkVertexInputBindingDescription` instance allocated on the specified `MemoryStack`.
`static int`	`nbinding(long struct)` Unsafe version of `binding()`.
`static void`	`nbinding(long struct, int value)` Unsafe version of `binding`.
`static int`	`ninputRate(long struct)` Unsafe version of `inputRate()`.
`static void`	`ninputRate(long struct, int value)` Unsafe version of `inputRate`.
`static int`	`nstride(long struct)` Unsafe version of `stride()`.
`static void`	`nstride(long struct, int value)` Unsafe version of `stride`.
`VkVertexInputBindingDescription`	`set(int binding, int stride, int inputRate)` Initializes this struct with the specified values.
`VkVertexInputBindingDescription`	`set(VkVertexInputBindingDescription src)` Copies the specified struct data to this struct.
`int`	`sizeof()`
`int`	`stride()` Returns the value of the `stride` field.
`VkVertexInputBindingDescription`	`stride(int value)` Sets the specified value to the `stride` field.

Methods inherited from class org.lwjgl.system.Struct
clear, free, isNull

Methods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toString

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.lwjgl.system.NativeResource
close, free

- Field Detail
  - SIZEOF
```
public static final int SIZEOF
```
    The struct size in bytes.
  - ALIGNOF
```
public static final int ALIGNOF
```
    The struct alignment in bytes.
  - BINDING
```
public static final int BINDING
```
    The struct member offsets.
  - STRIDE
```
public static final int STRIDE
```
    The struct member offsets.
  - INPUTRATE
```
public static final int INPUTRATE
```
    The struct member offsets.
- Constructor Detail
  - VkVertexInputBindingDescription
```
public VkVertexInputBindingDescription(java.nio.ByteBuffer container)
```
    Creates a VkVertexInputBindingDescription instance at the current position of the specified ByteBuffer container. Changes to the buffer's content will be visible to the struct instance and vice versa.
    The created instance holds a strong reference to the container object.
- Method Detail
  - sizeof
```
public int sizeof()
```
    Specified by:
    
    sizeof in class org.lwjgl.system.Struct
  - binding
```
public int binding()
```
    Returns the value of the binding field.
  - stride
```
public int stride()
```
    Returns the value of the stride field.
  - inputRate
```
public int inputRate()
```
    Returns the value of the inputRate field.
  - binding
```
public VkVertexInputBindingDescription binding(int value)
```
    Sets the specified value to the binding field.
  - stride
```
public VkVertexInputBindingDescription stride(int value)
```
    Sets the specified value to the stride field.
  - inputRate
```
public VkVertexInputBindingDescription inputRate(int value)
```
    Sets the specified value to the inputRate field.
  - set
```
public VkVertexInputBindingDescription set(int binding,
                                           int stride,
                                           int inputRate)
```
    Initializes this struct with the specified values.
  - set
```
public VkVertexInputBindingDescription set(VkVertexInputBindingDescription src)
```
    Copies the specified struct data to this struct.
    
    Parameters:
    
    src - the source struct
    
    Returns:
    
    this struct
  - malloc
```
public static VkVertexInputBindingDescription malloc()
```
    Returns a new VkVertexInputBindingDescription instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static VkVertexInputBindingDescription calloc()
```
    Returns a new VkVertexInputBindingDescription instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static VkVertexInputBindingDescription create()
```
    Returns a new VkVertexInputBindingDescription instance allocated with BufferUtils.
  - create
```
public static VkVertexInputBindingDescription create(long address)
```
    Returns a new VkVertexInputBindingDescription instance for the specified memory address.
  - createSafe
```
@Nullable
public static VkVertexInputBindingDescription createSafe(long address)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static VkVertexInputBindingDescription.Buffer malloc(int capacity)
```
    Returns a new VkVertexInputBindingDescription.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static VkVertexInputBindingDescription.Buffer calloc(int capacity)
```
    Returns a new VkVertexInputBindingDescription.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkVertexInputBindingDescription.Buffer create(int capacity)
```
    Returns a new VkVertexInputBindingDescription.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkVertexInputBindingDescription.Buffer create(long address,
                                                            int capacity)
```
    Create a VkVertexInputBindingDescription.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - createSafe
```
@Nullable
public static VkVertexInputBindingDescription.Buffer createSafe(long address,
                                                                          int capacity)
```
    Like create, but returns null if address is NULL.
  - mallocStack
```
public static VkVertexInputBindingDescription mallocStack()
```
    Returns a new VkVertexInputBindingDescription instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static VkVertexInputBindingDescription callocStack()
```
    Returns a new VkVertexInputBindingDescription instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static VkVertexInputBindingDescription mallocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkVertexInputBindingDescription instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static VkVertexInputBindingDescription callocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkVertexInputBindingDescription instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
  - mallocStack
```
public static VkVertexInputBindingDescription.Buffer mallocStack(int capacity)
```
    Returns a new VkVertexInputBindingDescription.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static VkVertexInputBindingDescription.Buffer callocStack(int capacity)
```
    Returns a new VkVertexInputBindingDescription.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static VkVertexInputBindingDescription.Buffer mallocStack(int capacity,
                                                                 org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkVertexInputBindingDescription.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static VkVertexInputBindingDescription.Buffer callocStack(int capacity,
                                                                 org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkVertexInputBindingDescription.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - nbinding
```
public static int nbinding(long struct)
```
    Unsafe version of binding().
  - nstride
```
public static int nstride(long struct)
```
    Unsafe version of stride().
  - ninputRate
```
public static int ninputRate(long struct)
```
    Unsafe version of inputRate().
  - nbinding
```
public static void nbinding(long struct,
                            int value)
```
    Unsafe version of binding.
  - nstride
```
public static void nstride(long struct,
                           int value)
```
    Unsafe version of stride.
  - ninputRate
```
public static void ninputRate(long struct,
                              int value)
```
    Unsafe version of inputRate.

Class VkVertexInputBindingDescription

Valid Usage

Valid Usage (Implicit)

See Also

Member documentation

Layout

Nested Class Summary

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

Field Summary

Fields inherited from interface org.lwjgl.system.Pointer

Constructor Summary

Method Summary

Methods inherited from class org.lwjgl.system.Struct

Methods inherited from class org.lwjgl.system.Pointer.Default

Methods inherited from class java.lang.Object

Methods inherited from interface org.lwjgl.system.NativeResource

Field Detail

SIZEOF

ALIGNOF

BINDING

STRIDE

INPUTRATE

Constructor Detail

VkVertexInputBindingDescription

Method Detail

sizeof

binding

stride

inputRate

binding

stride

inputRate

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nbinding

nstride

ninputRate

nbinding

nstride

ninputRate