Package org.lwjgl.vulkan

Class VkVertexInputBindingDescription

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkVertexInputBindingDescription>

org.lwjgl.vulkan.VkVertexInputBindingDescription

All Implemented Interfaces:

AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer

public class VkVertexInputBindingDescription
extends org.lwjgl.system.Struct<VkVertexInputBindingDescription>
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
• If the VK_KHR_portability_subset extension is enabled, stride must be a multiple of, and at least as large as, VkPhysicalDevicePortabilitySubsetPropertiesKHR::minVertexInputBindingStrideAlignment

Valid Usage (Implicit)

• inputRate must be a valid VkVertexInputRate value

See Also

VkPipelineVertexInputStateCreateInfo

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 of VkVertexInputBindingDescription structs.

Nested classes/interfaces inherited from class org.lwjgl.system.Struct

org.lwjgl.system.Struct.StructValidation

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

org.lwjgl.system.Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	BINDING	The struct member offsets.
static final int	INPUTRATE	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final 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	Description
VkVertexInputBindingDescription(ByteBuffer container)	Creates a VkVertexInputBindingDescription instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
int	binding()	the binding number that this structure describes.
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.Buffer	calloc(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	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkVertexInputBindingDescription instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkVertexInputBindingDescription	callocStack()	Deprecated.
static VkVertexInputBindingDescription.Buffer	callocStack(int capacity)	Deprecated.
static VkVertexInputBindingDescription.Buffer	callocStack(int capacity, org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkVertexInputBindingDescription	callocStack(org.lwjgl.system.MemoryStack stack)	Deprecated.
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 @Nullable VkVertexInputBindingDescription	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkVertexInputBindingDescription.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
int	inputRate()	a VkVertexInputRate value specifying whether vertex attribute addressing is a function of the vertex index or of the instance index.
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.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkVertexInputBindingDescription.Buffer instance allocated on the specified MemoryStack.
static VkVertexInputBindingDescription	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkVertexInputBindingDescription instance allocated on the specified MemoryStack.
static VkVertexInputBindingDescription	mallocStack()	Deprecated.
static VkVertexInputBindingDescription.Buffer	mallocStack(int capacity)	Deprecated.
static VkVertexInputBindingDescription.Buffer	mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkVertexInputBindingDescription	mallocStack(org.lwjgl.system.MemoryStack stack)	Deprecated.
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()	the byte stride between consecutive elements within the buffer.
VkVertexInputBindingDescription	stride(int value)	Sets the specified value to the stride() field.

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull, validate, validate

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 Details

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 Details

VkVertexInputBindingDescription

public VkVertexInputBindingDescription(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 Details

sizeof

public int sizeof()

Specified by:

sizeof in class org.lwjgl.system.Struct<VkVertexInputBindingDescription>

binding

public int binding()

the binding number that this structure describes.

stride

public int stride()

the byte stride between consecutive elements within the buffer.

inputRate

public int inputRate()

a VkVertexInputRate value specifying whether vertex attribute addressing is a function of the vertex index or of the instance index.

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

public static @Nullable 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

public static @Nullable VkVertexInputBindingDescription.Buffer createSafe(long address,
 int capacity)

Like create, but returns null if address is NULL.

mallocStack

@Deprecated
public static VkVertexInputBindingDescription mallocStack()

Deprecated.

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

callocStack

@Deprecated
public static VkVertexInputBindingDescription callocStack()

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

mallocStack

@Deprecated
public static VkVertexInputBindingDescription mallocStack(org.lwjgl.system.MemoryStack stack)

Deprecated.

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

callocStack

@Deprecated
public static VkVertexInputBindingDescription callocStack(org.lwjgl.system.MemoryStack stack)

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

mallocStack

@Deprecated
public static VkVertexInputBindingDescription.Buffer mallocStack(int capacity)

Deprecated.

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

callocStack

@Deprecated
public static VkVertexInputBindingDescription.Buffer callocStack(int capacity)

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

mallocStack

@Deprecated
public static VkVertexInputBindingDescription.Buffer mallocStack(int capacity,
 org.lwjgl.system.MemoryStack stack)

Deprecated.

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

callocStack

@Deprecated
public static VkVertexInputBindingDescription.Buffer callocStack(int capacity,
 org.lwjgl.system.MemoryStack stack)

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

malloc

public static VkVertexInputBindingDescription malloc(org.lwjgl.system.MemoryStack stack)

Returns a new VkVertexInputBindingDescription instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkVertexInputBindingDescription calloc(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

malloc

public static VkVertexInputBindingDescription.Buffer malloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

Returns a new VkVertexInputBindingDescription.Buffer instance allocated on the specified MemoryStack.

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

public static VkVertexInputBindingDescription.Buffer calloc(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:

capacity - the buffer capacity

stack - the stack from which to allocate

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.