Package org.lwjgl.vulkan
Class VkVertexInputAttributeDescription
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.vulkan.VkVertexInputAttributeDescription
-
- All Implemented Interfaces:
- java.lang.AutoCloseable, NativeResource, Pointer
public class VkVertexInputAttributeDescription extends Struct
Khronos Reference Page
Vulkan SpecificationDescribes a vertex input attribute.
Valid Usage
formatmust be a validVkFormatvaluelocationmust be less thanVkPhysicalDeviceLimits::maxVertexInputAttributesbindingmust be less thanVkPhysicalDeviceLimits::maxVertexInputBindingsoffsetmust be less than or equal toVkPhysicalDeviceLimits::maxVertexInputAttributeOffsetformatmust be allowed as a vertex buffer format, as specified by theFORMAT_FEATURE_VERTEX_BUFFER_BITflag inVkFormatProperties::bufferFeaturesreturned byGetPhysicalDeviceFormatProperties
Member documentation
location– the shader binding location number for this attributebinding– the binding number which this attribute takes its data fromformat– the size and type of the vertex attribute dataoffset– 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 classVkVertexInputAttributeDescription.BufferAn array ofVkVertexInputAttributeDescriptionstructs.-
Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
Pointer.Default
-
-
Field Summary
Fields Modifier and Type Field and Description static intSIZEOFThe struct size in bytes.-
Fields inherited from interface org.lwjgl.system.Pointer
POINTER_SHIFT, POINTER_SIZE
-
-
Constructor Summary
Constructors Constructor and Description VkVertexInputAttributeDescription(java.nio.ByteBuffer container)Creates aVkVertexInputAttributeDescriptioninstance at the current position of the specifiedByteBuffercontainer.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method and Description intbinding()Returns the value of thebindingfield.VkVertexInputAttributeDescriptionbinding(int value)Sets the specified value to thebindingfield.static VkVertexInputAttributeDescriptioncalloc()Returns a newVkVertexInputAttributeDescriptioninstance allocated withmemCalloc.static VkVertexInputAttributeDescription.Buffercalloc(int capacity)Returns a newVkVertexInputAttributeDescription.Bufferinstance allocated withmemCalloc.static VkVertexInputAttributeDescriptioncallocStack()Returns a newVkVertexInputAttributeDescriptioninstance allocated on the thread-localMemoryStackand initializes all its bits to zero.static VkVertexInputAttributeDescription.BuffercallocStack(int capacity)Returns a newVkVertexInputAttributeDescription.Bufferinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.static VkVertexInputAttributeDescription.BuffercallocStack(int capacity, MemoryStack stack)Returns a newVkVertexInputAttributeDescription.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkVertexInputAttributeDescriptioncallocStack(MemoryStack stack)Returns a newVkVertexInputAttributeDescriptioninstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkVertexInputAttributeDescriptioncreate()Returns a newVkVertexInputAttributeDescriptioninstance allocated withBufferUtils.static VkVertexInputAttributeDescription.Buffercreate(int capacity)Returns a newVkVertexInputAttributeDescription.Bufferinstance allocated withBufferUtils.static VkVertexInputAttributeDescriptioncreate(long address)Returns a newVkVertexInputAttributeDescriptioninstance for the specified memory address ornullif the address isNULL.static VkVertexInputAttributeDescription.Buffercreate(long address, int capacity)Create aVkVertexInputAttributeDescription.Bufferinstance at the specified memory.intformat()Returns the value of theformatfield.VkVertexInputAttributeDescriptionformat(int value)Sets the specified value to theformatfield.intlocation()Returns the value of thelocationfield.VkVertexInputAttributeDescriptionlocation(int value)Sets the specified value to thelocationfield.static VkVertexInputAttributeDescriptionmalloc()Returns a newVkVertexInputAttributeDescriptioninstance allocated withmemAlloc.static VkVertexInputAttributeDescription.Buffermalloc(int capacity)Returns a newVkVertexInputAttributeDescription.Bufferinstance allocated withmemAlloc.static VkVertexInputAttributeDescriptionmallocStack()Returns a newVkVertexInputAttributeDescriptioninstance allocated on the thread-localMemoryStack.static VkVertexInputAttributeDescription.BuffermallocStack(int capacity)Returns a newVkVertexInputAttributeDescription.Bufferinstance allocated on the thread-localMemoryStack.static VkVertexInputAttributeDescription.BuffermallocStack(int capacity, MemoryStack stack)Returns a newVkVertexInputAttributeDescription.Bufferinstance allocated on the specifiedMemoryStack.static VkVertexInputAttributeDescriptionmallocStack(MemoryStack stack)Returns a newVkVertexInputAttributeDescriptioninstance allocated on the specifiedMemoryStack.VkVertexInputAttributeDescriptionnset(long struct)Unsafe version ofset.intoffset()Returns the value of theoffsetfield.VkVertexInputAttributeDescriptionoffset(int value)Sets the specified value to theoffsetfield.VkVertexInputAttributeDescriptionset(int location, int binding, int format, int offset)Initializes this struct with the specified values.VkVertexInputAttributeDescriptionset(VkVertexInputAttributeDescription src)Copies the specified struct data to this struct.intsizeof()Returns thesizeof(struct).-
Methods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toString
-
Methods inherited from interface org.lwjgl.system.NativeResource
close
-
-
-
-
Constructor Detail
-
VkVertexInputAttributeDescription
public VkVertexInputAttributeDescription(java.nio.ByteBuffer container)
Creates aVkVertexInputAttributeDescriptioninstance at the current position of the specifiedByteBuffercontainer. 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()
Description copied from class:StructReturns thesizeof(struct).
-
location
public int location()
Returns the value of thelocationfield.
-
binding
public int binding()
Returns the value of thebindingfield.
-
format
public int format()
Returns the value of theformatfield.
-
offset
public int offset()
Returns the value of theoffsetfield.
-
location
public VkVertexInputAttributeDescription location(int value)
Sets the specified value to thelocationfield.
-
binding
public VkVertexInputAttributeDescription binding(int value)
Sets the specified value to thebindingfield.
-
format
public VkVertexInputAttributeDescription format(int value)
Sets the specified value to theformatfield.
-
offset
public VkVertexInputAttributeDescription offset(int value)
Sets the specified value to theoffsetfield.
-
set
public VkVertexInputAttributeDescription set(int location, int binding, int format, int offset)
Initializes this struct with the specified values.
-
nset
public VkVertexInputAttributeDescription nset(long struct)
Unsafe version ofset.
-
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 newVkVertexInputAttributeDescriptioninstance allocated withmemAlloc. The instance must be explicitly freed.
-
calloc
public static VkVertexInputAttributeDescription calloc()
Returns a newVkVertexInputAttributeDescriptioninstance allocated withmemCalloc. The instance must be explicitly freed.
-
create
public static VkVertexInputAttributeDescription create()
Returns a newVkVertexInputAttributeDescriptioninstance allocated withBufferUtils.
-
create
public static VkVertexInputAttributeDescription create(long address)
Returns a newVkVertexInputAttributeDescriptioninstance for the specified memory address ornullif the address isNULL.
-
malloc
public static VkVertexInputAttributeDescription.Buffer malloc(int capacity)
Returns a newVkVertexInputAttributeDescription.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
public static VkVertexInputAttributeDescription.Buffer calloc(int capacity)
Returns a newVkVertexInputAttributeDescription.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
public static VkVertexInputAttributeDescription.Buffer create(int capacity)
Returns a newVkVertexInputAttributeDescription.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
public static VkVertexInputAttributeDescription.Buffer create(long address, int capacity)
Create aVkVertexInputAttributeDescription.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
mallocStack
public static VkVertexInputAttributeDescription mallocStack()
Returns a newVkVertexInputAttributeDescriptioninstance allocated on the thread-localMemoryStack.
-
callocStack
public static VkVertexInputAttributeDescription callocStack()
Returns a newVkVertexInputAttributeDescriptioninstance allocated on the thread-localMemoryStackand initializes all its bits to zero.
-
mallocStack
public static VkVertexInputAttributeDescription mallocStack(MemoryStack stack)
Returns a newVkVertexInputAttributeDescriptioninstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
callocStack
public static VkVertexInputAttributeDescription callocStack(MemoryStack stack)
Returns a newVkVertexInputAttributeDescriptioninstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocate
-
mallocStack
public static VkVertexInputAttributeDescription.Buffer mallocStack(int capacity)
Returns a newVkVertexInputAttributeDescription.Bufferinstance allocated on the thread-localMemoryStack.- Parameters:
capacity- the buffer capacity
-
callocStack
public static VkVertexInputAttributeDescription.Buffer callocStack(int capacity)
Returns a newVkVertexInputAttributeDescription.Bufferinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.- Parameters:
capacity- the buffer capacity
-
mallocStack
public static VkVertexInputAttributeDescription.Buffer mallocStack(int capacity, MemoryStack stack)
Returns a newVkVertexInputAttributeDescription.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
callocStack
public static VkVertexInputAttributeDescription.Buffer callocStack(int capacity, MemoryStack stack)
Returns a newVkVertexInputAttributeDescription.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
-