Package org.lwjgl.vulkan
Class VkVertexInputBindingDescription
- 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 thanVkPhysicalDeviceLimits
::maxVertexInputBindings
stride
must be less than or equal toVkPhysicalDeviceLimits
::maxVertexInputBindingStride
Valid Usage (Implicit)
inputRate
must be a validVkVertexInputRate
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
– aVkVertexInputRate
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 Description static class
VkVertexInputBindingDescription.Buffer
An array ofVkVertexInputBindingDescription
structs.
-
Constructor Summary
Constructors Constructor Description VkVertexInputBindingDescription(java.nio.ByteBuffer container)
Creates aVkVertexInputBindingDescription
instance at the current position of the specifiedByteBuffer
container.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description int
binding()
Returns the value of thebinding
field.VkVertexInputBindingDescription
binding(int value)
Sets the specified value to thebinding
field.static VkVertexInputBindingDescription
calloc()
Returns a newVkVertexInputBindingDescription
instance allocated withmemCalloc
.static VkVertexInputBindingDescription.Buffer
calloc(int capacity)
Returns a newVkVertexInputBindingDescription.Buffer
instance allocated withmemCalloc
.static VkVertexInputBindingDescription
callocStack()
Returns a newVkVertexInputBindingDescription
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkVertexInputBindingDescription.Buffer
callocStack(int capacity)
Returns a newVkVertexInputBindingDescription.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkVertexInputBindingDescription.Buffer
callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkVertexInputBindingDescription.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkVertexInputBindingDescription
callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkVertexInputBindingDescription
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkVertexInputBindingDescription
create()
Returns a newVkVertexInputBindingDescription
instance allocated withBufferUtils
.static VkVertexInputBindingDescription.Buffer
create(int capacity)
Returns a newVkVertexInputBindingDescription.Buffer
instance allocated withBufferUtils
.static VkVertexInputBindingDescription
create(long address)
Returns a newVkVertexInputBindingDescription
instance for the specified memory address.static VkVertexInputBindingDescription.Buffer
create(long address, int capacity)
Create aVkVertexInputBindingDescription.Buffer
instance at the specified memory.static VkVertexInputBindingDescription
createSafe(long address)
static VkVertexInputBindingDescription.Buffer
createSafe(long address, int capacity)
int
inputRate()
Returns the value of theinputRate
field.VkVertexInputBindingDescription
inputRate(int value)
Sets the specified value to theinputRate
field.static VkVertexInputBindingDescription
malloc()
Returns a newVkVertexInputBindingDescription
instance allocated withmemAlloc
.static VkVertexInputBindingDescription.Buffer
malloc(int capacity)
Returns a newVkVertexInputBindingDescription.Buffer
instance allocated withmemAlloc
.static VkVertexInputBindingDescription
mallocStack()
Returns a newVkVertexInputBindingDescription
instance allocated on the thread-localMemoryStack
.static VkVertexInputBindingDescription.Buffer
mallocStack(int capacity)
Returns a newVkVertexInputBindingDescription.Buffer
instance allocated on the thread-localMemoryStack
.static VkVertexInputBindingDescription.Buffer
mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkVertexInputBindingDescription.Buffer
instance allocated on the specifiedMemoryStack
.static VkVertexInputBindingDescription
mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkVertexInputBindingDescription
instance allocated on the specifiedMemoryStack
.static int
nbinding(long struct)
Unsafe version ofbinding()
.static void
nbinding(long struct, int value)
Unsafe version ofbinding
.static int
ninputRate(long struct)
Unsafe version ofinputRate()
.static void
ninputRate(long struct, int value)
Unsafe version ofinputRate
.static int
nstride(long struct)
Unsafe version ofstride()
.static void
nstride(long struct, int value)
Unsafe version ofstride
.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 thestride
field.VkVertexInputBindingDescription
stride(int value)
Sets the specified value to thestride
field.
-
-
-
Constructor Detail
-
VkVertexInputBindingDescription
public VkVertexInputBindingDescription(java.nio.ByteBuffer container)
Creates aVkVertexInputBindingDescription
instance at the current position of the specifiedByteBuffer
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 classorg.lwjgl.system.Struct
-
binding
public int binding()
Returns the value of thebinding
field.
-
stride
public int stride()
Returns the value of thestride
field.
-
inputRate
public int inputRate()
Returns the value of theinputRate
field.
-
binding
public VkVertexInputBindingDescription binding(int value)
Sets the specified value to thebinding
field.
-
stride
public VkVertexInputBindingDescription stride(int value)
Sets the specified value to thestride
field.
-
inputRate
public VkVertexInputBindingDescription inputRate(int value)
Sets the specified value to theinputRate
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 newVkVertexInputBindingDescription
instance allocated withmemAlloc
. The instance must be explicitly freed.
-
calloc
public static VkVertexInputBindingDescription calloc()
Returns a newVkVertexInputBindingDescription
instance allocated withmemCalloc
. The instance must be explicitly freed.
-
create
public static VkVertexInputBindingDescription create()
Returns a newVkVertexInputBindingDescription
instance allocated withBufferUtils
.
-
create
public static VkVertexInputBindingDescription create(long address)
Returns a newVkVertexInputBindingDescription
instance for the specified memory address.
-
createSafe
@Nullable public static VkVertexInputBindingDescription createSafe(long address)
-
malloc
public static VkVertexInputBindingDescription.Buffer malloc(int capacity)
Returns a newVkVertexInputBindingDescription.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
public static VkVertexInputBindingDescription.Buffer calloc(int capacity)
Returns a newVkVertexInputBindingDescription.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
public static VkVertexInputBindingDescription.Buffer create(int capacity)
Returns a newVkVertexInputBindingDescription.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
public static VkVertexInputBindingDescription.Buffer create(long address, int capacity)
Create aVkVertexInputBindingDescription.Buffer
instance at the specified memory.- Parameters:
address
- the memory addresscapacity
- the buffer capacity
-
createSafe
@Nullable public static VkVertexInputBindingDescription.Buffer createSafe(long address, int capacity)
-
mallocStack
public static VkVertexInputBindingDescription mallocStack()
Returns a newVkVertexInputBindingDescription
instance allocated on the thread-localMemoryStack
.
-
callocStack
public static VkVertexInputBindingDescription callocStack()
Returns a newVkVertexInputBindingDescription
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.
-
mallocStack
public static VkVertexInputBindingDescription mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkVertexInputBindingDescription
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
callocStack
public static VkVertexInputBindingDescription callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkVertexInputBindingDescription
instance allocated on the specifiedMemoryStack
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 newVkVertexInputBindingDescription.Buffer
instance allocated on the thread-localMemoryStack
.- Parameters:
capacity
- the buffer capacity
-
callocStack
public static VkVertexInputBindingDescription.Buffer callocStack(int capacity)
Returns a newVkVertexInputBindingDescription.Buffer
instance allocated on the thread-localMemoryStack
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 newVkVertexInputBindingDescription.Buffer
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
callocStack
public static VkVertexInputBindingDescription.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkVertexInputBindingDescription.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
nbinding
public static int nbinding(long struct)
Unsafe version ofbinding()
.
-
nstride
public static int nstride(long struct)
Unsafe version ofstride()
.
-
ninputRate
public static int ninputRate(long struct)
Unsafe version ofinputRate()
.
-
nbinding
public static void nbinding(long struct, int value)
Unsafe version ofbinding
.
-
nstride
public static void nstride(long struct, int value)
Unsafe version ofstride
.
-
ninputRate
public static void ninputRate(long struct, int value)
Unsafe version ofinputRate
.
-
-