Package org.lwjgl.vulkan

Class VkVertexInputBindingDescription2EXT

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkVertexInputBindingDescription2EXT>

org.lwjgl.vulkan.VkVertexInputBindingDescription2EXT

All Implemented Interfaces:

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

public class VkVertexInputBindingDescription2EXT
extends org.lwjgl.system.Struct<VkVertexInputBindingDescription2EXT>
implements org.lwjgl.system.NativeResource

Structure specifying the extended 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 vertexAttributeInstanceRateZeroDivisor feature is not enabled, divisor must not be 0
• If the vertexAttributeInstanceRateDivisor feature is not enabled, divisor must be 1
• divisor must be a value between 0 and VkPhysicalDeviceVertexAttributeDivisorPropertiesEXT::maxVertexAttribDivisor, inclusive
• If divisor is not 1 then inputRate must be of type VERTEX_INPUT_RATE_INSTANCE

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_VERTEX_INPUT_BINDING_DESCRIPTION_2_EXT
• inputRate must be a valid VkVertexInputRate value

See Also

CmdSetVertexInputEXT

Layout

 struct VkVertexInputBindingDescription2EXT {
     VkStructureType sType();
     void * pNext();
     uint32_t binding();
     uint32_t stride();
     VkVertexInputRate inputRate();
     uint32_t divisor();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkVertexInputBindingDescription2EXT.Buffer	An array of VkVertexInputBindingDescription2EXT 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	DIVISOR	The struct member offsets.
static final int	INPUTRATE	The struct member offsets.
static final int	PNEXT	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	STRIDE	The struct member offsets.
static final int	STYPE	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
VkVertexInputBindingDescription2EXT(ByteBuffer container)	Creates a VkVertexInputBindingDescription2EXT 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.
VkVertexInputBindingDescription2EXT	binding(int value)	Sets the specified value to the binding() field.
static VkVertexInputBindingDescription2EXT	calloc()	Returns a new VkVertexInputBindingDescription2EXT instance allocated with memCalloc.
static VkVertexInputBindingDescription2EXT.Buffer	calloc(int capacity)	Returns a new VkVertexInputBindingDescription2EXT.Buffer instance allocated with memCalloc.
static VkVertexInputBindingDescription2EXT.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkVertexInputBindingDescription2EXT.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkVertexInputBindingDescription2EXT	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkVertexInputBindingDescription2EXT instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkVertexInputBindingDescription2EXT	create()	Returns a new VkVertexInputBindingDescription2EXT instance allocated with BufferUtils.
static VkVertexInputBindingDescription2EXT.Buffer	create(int capacity)	Returns a new VkVertexInputBindingDescription2EXT.Buffer instance allocated with BufferUtils.
static VkVertexInputBindingDescription2EXT	create(long address)	Returns a new VkVertexInputBindingDescription2EXT instance for the specified memory address.
static VkVertexInputBindingDescription2EXT.Buffer	create(long address, int capacity)	Create a VkVertexInputBindingDescription2EXT.Buffer instance at the specified memory.
static @Nullable VkVertexInputBindingDescription2EXT	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkVertexInputBindingDescription2EXT.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
int	divisor()	the number of successive instances that will use the same value of the vertex attribute when instanced rendering is enabled.
VkVertexInputBindingDescription2EXT	divisor(int value)	Sets the specified value to the divisor() field.
int	inputRate()	a VkVertexInputRate value specifying whether vertex attribute addressing is a function of the vertex index or of the instance index.
VkVertexInputBindingDescription2EXT	inputRate(int value)	Sets the specified value to the inputRate() field.
static VkVertexInputBindingDescription2EXT	malloc()	Returns a new VkVertexInputBindingDescription2EXT instance allocated with memAlloc.
static VkVertexInputBindingDescription2EXT.Buffer	malloc(int capacity)	Returns a new VkVertexInputBindingDescription2EXT.Buffer instance allocated with memAlloc.
static VkVertexInputBindingDescription2EXT.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkVertexInputBindingDescription2EXT.Buffer instance allocated on the specified MemoryStack.
static VkVertexInputBindingDescription2EXT	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkVertexInputBindingDescription2EXT 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	ndivisor(long struct)	Unsafe version of divisor().
static void	ndivisor(long struct, int value)	Unsafe version of divisor.
static int	ninputRate(long struct)	Unsafe version of inputRate().
static void	ninputRate(long struct, int value)	Unsafe version of inputRate.
static long	npNext(long struct)	Unsafe version of pNext().
static void	npNext(long struct, long value)	Unsafe version of pNext.
static int	nstride(long struct)	Unsafe version of stride().
static void	nstride(long struct, int value)	Unsafe version of stride.
static int	nsType(long struct)	Unsafe version of sType().
static void	nsType(long struct, int value)	Unsafe version of sType.
long	pNext()	NULL or a pointer to a structure extending this structure.
VkVertexInputBindingDescription2EXT	pNext(long value)	Sets the specified value to the pNext() field.
VkVertexInputBindingDescription2EXT	set(int sType, long pNext, int binding, int stride, int inputRate, int divisor)	Initializes this struct with the specified values.
VkVertexInputBindingDescription2EXT	set(VkVertexInputBindingDescription2EXT src)	Copies the specified struct data to this struct.
int	sizeof()
int	stride()	the byte stride between consecutive elements within the buffer.
VkVertexInputBindingDescription2EXT	stride(int value)	Sets the specified value to the stride() field.
int	sType()	a VkStructureType value identifying this structure.
VkVertexInputBindingDescription2EXT	sType(int value)	Sets the specified value to the sType() field.
VkVertexInputBindingDescription2EXT	sType$Default()	Sets the STRUCTURE_TYPE_VERTEX_INPUT_BINDING_DESCRIPTION_2_EXT value to the sType() 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.

STYPE

public static final int STYPE

The struct member offsets.

PNEXT

public static final int PNEXT

The struct member offsets.

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.

DIVISOR

public static final int DIVISOR

The struct member offsets.

Constructor Details

VkVertexInputBindingDescription2EXT

public VkVertexInputBindingDescription2EXT(ByteBuffer container)

Creates a VkVertexInputBindingDescription2EXT 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<VkVertexInputBindingDescription2EXT>

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

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.

divisor

public int divisor()

the number of successive instances that will use the same value of the vertex attribute when instanced rendering is enabled. This member can be a value other than 1 if the vertexAttributeInstanceRateDivisor feature is enabled. For example, if the divisor is N, the same vertex attribute will be applied to N successive instances before moving on to the next vertex attribute. The maximum value of divisor is implementation-dependent and can be queried using VkPhysicalDeviceVertexAttributeDivisorPropertiesEXT::maxVertexAttribDivisor. A value of 0 can be used for the divisor if the vertexAttributeInstanceRateZeroDivisor feature is enabled. In this case, the same vertex attribute will be applied to all instances.

sType

public VkVertexInputBindingDescription2EXT sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkVertexInputBindingDescription2EXT sType$Default()

Sets the STRUCTURE_TYPE_VERTEX_INPUT_BINDING_DESCRIPTION_2_EXT value to the sType() field.

pNext

public VkVertexInputBindingDescription2EXT pNext(long value)

Sets the specified value to the pNext() field.

binding

public VkVertexInputBindingDescription2EXT binding(int value)

Sets the specified value to the binding() field.

stride

public VkVertexInputBindingDescription2EXT stride(int value)

Sets the specified value to the stride() field.

inputRate

public VkVertexInputBindingDescription2EXT inputRate(int value)

Sets the specified value to the inputRate() field.

divisor

public VkVertexInputBindingDescription2EXT divisor(int value)

Sets the specified value to the divisor() field.

set

public VkVertexInputBindingDescription2EXT set(int sType,
 long pNext,
 int binding,
 int stride,
 int inputRate,
 int divisor)

Initializes this struct with the specified values.

set

public VkVertexInputBindingDescription2EXT set(VkVertexInputBindingDescription2EXT src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkVertexInputBindingDescription2EXT malloc()

Returns a new VkVertexInputBindingDescription2EXT instance allocated with memAlloc. The instance must be explicitly freed.

calloc

public static VkVertexInputBindingDescription2EXT calloc()

Returns a new VkVertexInputBindingDescription2EXT instance allocated with memCalloc. The instance must be explicitly freed.

create

public static VkVertexInputBindingDescription2EXT create()

Returns a new VkVertexInputBindingDescription2EXT instance allocated with BufferUtils.

create

public static VkVertexInputBindingDescription2EXT create(long address)

Returns a new VkVertexInputBindingDescription2EXT instance for the specified memory address.

createSafe

public static @Nullable VkVertexInputBindingDescription2EXT createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkVertexInputBindingDescription2EXT.Buffer malloc(int capacity)

Returns a new VkVertexInputBindingDescription2EXT.Buffer instance allocated with memAlloc. The instance must be explicitly freed.

Parameters:

capacity - the buffer capacity

calloc

public static VkVertexInputBindingDescription2EXT.Buffer calloc(int capacity)

Returns a new VkVertexInputBindingDescription2EXT.Buffer instance allocated with memCalloc. The instance must be explicitly freed.

Parameters:

capacity - the buffer capacity

create

public static VkVertexInputBindingDescription2EXT.Buffer create(int capacity)

Returns a new VkVertexInputBindingDescription2EXT.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

public static VkVertexInputBindingDescription2EXT.Buffer create(long address,
 int capacity)

Create a VkVertexInputBindingDescription2EXT.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new VkVertexInputBindingDescription2EXT instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkVertexInputBindingDescription2EXT calloc(org.lwjgl.system.MemoryStack stack)

Returns a new VkVertexInputBindingDescription2EXT instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

public static VkVertexInputBindingDescription2EXT.Buffer calloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

Returns a new VkVertexInputBindingDescription2EXT.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

nsType

public static int nsType(long struct)

Unsafe version of sType().

npNext

public static long npNext(long struct)

Unsafe version of pNext().

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().

ndivisor

public static int ndivisor(long struct)

Unsafe version of divisor().

nsType

public static void nsType(long struct,
 int value)

Unsafe version of sType.

npNext

public static void npNext(long struct,
 long value)

Unsafe version of pNext.

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.

ndivisor

public static void ndivisor(long struct,
 int value)

Unsafe version of divisor.