VkVertexInputAttributeDescription (LWJGL 3.2.4 SNAPSHOT

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

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
```
public class VkVertexInputAttributeDescription
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
```
Structure specifying vertex input attribute description.
Valid Usage
- location must be less than VkPhysicalDeviceLimits::maxVertexInputAttributes
- binding must be less than VkPhysicalDeviceLimits::maxVertexInputBindings
- offset must be less than or equal to VkPhysicalDeviceLimits::maxVertexInputAttributeOffset
- format must be allowed as a vertex buffer format, as specified by the FORMAT_FEATURE_VERTEX_BUFFER_BIT flag in VkFormatProperties::bufferFeatures returned by vkGetPhysicalDeviceFormatProperties
Valid Usage (Implicit)
- format must be a valid VkFormat value
See Also

VkPipelineVertexInputStateCreateInfo

Member documentation
- location – the shader binding location number for this attribute.
- binding – the binding number which this attribute takes its data from.
- format – the size and type of the vertex attribute data.
- offset – a byte offset of this attribute relative to the start of an element in the vertex input binding.
Layout
```
 struct VkVertexInputAttributeDescription {
     uint32_t location;
     uint32_t binding;
     VkFormat format;
     uint32_t offset;
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class VkVertexInputAttributeDescription.Buffer
An array of VkVertexInputAttributeDescription 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`	`VkVertexInputAttributeDescription.Buffer` An array of `VkVertexInputAttributeDescription` 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`	`FORMAT` The struct member offsets.
`static int`	`LOCATION` The struct member offsets.
`static int`	`OFFSET` The struct member offsets.
`static int`	`SIZEOF` The struct size in bytes.

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

Constructor Summary

Constructors
Constructor and Description
`VkVertexInputAttributeDescription(java.nio.ByteBuffer container)` Creates a `VkVertexInputAttributeDescription` 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.
`VkVertexInputAttributeDescription`	`binding(int value)` Sets the specified value to the `binding` field.
`static VkVertexInputAttributeDescription`	`calloc()` Returns a new `VkVertexInputAttributeDescription` instance allocated with `memCalloc`.
`static VkVertexInputAttributeDescription.Buffer`	`calloc(int capacity)` Returns a new `VkVertexInputAttributeDescription.Buffer` instance allocated with `memCalloc`.
`static VkVertexInputAttributeDescription`	`callocStack()` Returns a new `VkVertexInputAttributeDescription` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkVertexInputAttributeDescription.Buffer`	`callocStack(int capacity)` Returns a new `VkVertexInputAttributeDescription.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkVertexInputAttributeDescription.Buffer`	`callocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkVertexInputAttributeDescription.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkVertexInputAttributeDescription`	`callocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkVertexInputAttributeDescription` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkVertexInputAttributeDescription`	`create()` Returns a new `VkVertexInputAttributeDescription` instance allocated with `BufferUtils`.
`static VkVertexInputAttributeDescription.Buffer`	`create(int capacity)` Returns a new `VkVertexInputAttributeDescription.Buffer` instance allocated with `BufferUtils`.
`static VkVertexInputAttributeDescription`	`create(long address)` Returns a new `VkVertexInputAttributeDescription` instance for the specified memory address.
`static VkVertexInputAttributeDescription.Buffer`	`create(long address, int capacity)` Create a `VkVertexInputAttributeDescription.Buffer` instance at the specified memory.
`static VkVertexInputAttributeDescription`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static VkVertexInputAttributeDescription.Buffer`	`createSafe(long address, int capacity)` Like `create`, but returns `null` if `address` is `NULL`.
`int`	`format()` Returns the value of the `format` field.
`VkVertexInputAttributeDescription`	`format(int value)` Sets the specified value to the `format` field.
`int`	`location()` Returns the value of the `location` field.
`VkVertexInputAttributeDescription`	`location(int value)` Sets the specified value to the `location` field.
`static VkVertexInputAttributeDescription`	`malloc()` Returns a new `VkVertexInputAttributeDescription` instance allocated with `memAlloc`.
`static VkVertexInputAttributeDescription.Buffer`	`malloc(int capacity)` Returns a new `VkVertexInputAttributeDescription.Buffer` instance allocated with `memAlloc`.
`static VkVertexInputAttributeDescription`	`mallocStack()` Returns a new `VkVertexInputAttributeDescription` instance allocated on the thread-local `MemoryStack`.
`static VkVertexInputAttributeDescription.Buffer`	`mallocStack(int capacity)` Returns a new `VkVertexInputAttributeDescription.Buffer` instance allocated on the thread-local `MemoryStack`.
`static VkVertexInputAttributeDescription.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkVertexInputAttributeDescription.Buffer` instance allocated on the specified `MemoryStack`.
`static VkVertexInputAttributeDescription`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkVertexInputAttributeDescription` 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`	`nformat(long struct)` Unsafe version of `format()`.
`static void`	`nformat(long struct, int value)` Unsafe version of `format`.
`static int`	`nlocation(long struct)` Unsafe version of `location()`.
`static void`	`nlocation(long struct, int value)` Unsafe version of `location`.
`static int`	`noffset(long struct)` Unsafe version of `offset()`.
`static void`	`noffset(long struct, int value)` Unsafe version of `offset`.
`int`	`offset()` Returns the value of the `offset` field.
`VkVertexInputAttributeDescription`	`offset(int value)` Sets the specified value to the `offset` field.
`VkVertexInputAttributeDescription`	`set(int location, int binding, int format, int offset)` Initializes this struct with the specified values.
`VkVertexInputAttributeDescription`	`set(VkVertexInputAttributeDescription src)` Copies the specified struct data to this struct.
`int`	`sizeof()`

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.
  - LOCATION
```
public static final int LOCATION
```
    The struct member offsets.
  - BINDING
```
public static final int BINDING
```
    The struct member offsets.
  - FORMAT
```
public static final int FORMAT
```
    The struct member offsets.
  - OFFSET
```
public static final int OFFSET
```
    The struct member offsets.
- Constructor Detail
  - VkVertexInputAttributeDescription
```
public VkVertexInputAttributeDescription(java.nio.ByteBuffer container)
```
    Creates a VkVertexInputAttributeDescription 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
  - location
```
public int location()
```
    Returns the value of the location field.
  - binding
```
public int binding()
```
    Returns the value of the binding field.
  - format
```
public int format()
```
    Returns the value of the format field.
  - offset
```
public int offset()
```
    Returns the value of the offset field.
  - location
```
public VkVertexInputAttributeDescription location(int value)
```
    Sets the specified value to the location field.
  - binding
```
public VkVertexInputAttributeDescription binding(int value)
```
    Sets the specified value to the binding field.
  - format
```
public VkVertexInputAttributeDescription format(int value)
```
    Sets the specified value to the format field.
  - offset
```
public VkVertexInputAttributeDescription offset(int value)
```
    Sets the specified value to the offset field.
  - set
```
public VkVertexInputAttributeDescription set(int location,
                                             int binding,
                                             int format,
                                             int offset)
```
    Initializes this struct with the specified values.
  - set
```
public VkVertexInputAttributeDescription set(VkVertexInputAttributeDescription src)
```
    Copies the specified struct data to this struct.
    
    Parameters:
    
    src - the source struct
    
    Returns:
    
    this struct
  - malloc
```
public static VkVertexInputAttributeDescription malloc()
```
    Returns a new VkVertexInputAttributeDescription instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static VkVertexInputAttributeDescription calloc()
```
    Returns a new VkVertexInputAttributeDescription instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static VkVertexInputAttributeDescription create()
```
    Returns a new VkVertexInputAttributeDescription instance allocated with BufferUtils.
  - create
```
public static VkVertexInputAttributeDescription create(long address)
```
    Returns a new VkVertexInputAttributeDescription instance for the specified memory address.
  - createSafe
```
@Nullable
public static VkVertexInputAttributeDescription createSafe(long address)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static VkVertexInputAttributeDescription.Buffer malloc(int capacity)
```
    Returns a new VkVertexInputAttributeDescription.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static VkVertexInputAttributeDescription.Buffer calloc(int capacity)
```
    Returns a new VkVertexInputAttributeDescription.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkVertexInputAttributeDescription.Buffer create(int capacity)
```
    Returns a new VkVertexInputAttributeDescription.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkVertexInputAttributeDescription.Buffer create(long address,
                                                              int capacity)
```
    Create a VkVertexInputAttributeDescription.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - createSafe
```
@Nullable
public static VkVertexInputAttributeDescription.Buffer createSafe(long address,
                                                                            int capacity)
```
    Like create, but returns null if address is NULL.
  - mallocStack
```
public static VkVertexInputAttributeDescription mallocStack()
```
    Returns a new VkVertexInputAttributeDescription instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static VkVertexInputAttributeDescription callocStack()
```
    Returns a new VkVertexInputAttributeDescription instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static VkVertexInputAttributeDescription mallocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkVertexInputAttributeDescription instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static VkVertexInputAttributeDescription callocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkVertexInputAttributeDescription instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
  - mallocStack
```
public static VkVertexInputAttributeDescription.Buffer mallocStack(int capacity)
```
    Returns a new VkVertexInputAttributeDescription.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static VkVertexInputAttributeDescription.Buffer callocStack(int capacity)
```
    Returns a new VkVertexInputAttributeDescription.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static VkVertexInputAttributeDescription.Buffer mallocStack(int capacity,
                                                                   org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkVertexInputAttributeDescription.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static VkVertexInputAttributeDescription.Buffer callocStack(int capacity,
                                                                   org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkVertexInputAttributeDescription.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
  - nlocation
```
public static int nlocation(long struct)
```
    Unsafe version of location().
  - nbinding
```
public static int nbinding(long struct)
```
    Unsafe version of binding().
  - nformat
```
public static int nformat(long struct)
```
    Unsafe version of format().
  - noffset
```
public static int noffset(long struct)
```
    Unsafe version of offset().
  - nlocation
```
public static void nlocation(long struct,
                             int value)
```
    Unsafe version of location.
  - nbinding
```
public static void nbinding(long struct,
                            int value)
```
    Unsafe version of binding.
  - nformat
```
public static void nformat(long struct,
                           int value)
```
    Unsafe version of format.
  - noffset
```
public static void noffset(long struct,
                           int value)
```
    Unsafe version of offset.

Class VkVertexInputAttributeDescription

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

LOCATION

BINDING

FORMAT

OFFSET

Constructor Detail

VkVertexInputAttributeDescription

Method Detail

sizeof

location

binding

format

offset

location

binding

format

offset

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nlocation

nbinding

nformat

noffset

nlocation

nbinding

nformat

noffset