Package org.lwjgl.vulkan

Class VkVertexInputBindingDivisorDescription

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkVertexInputBindingDivisorDescription>

org.lwjgl.vulkan.VkVertexInputBindingDivisorDescription

All Implemented Interfaces:

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

Direct Known Subclasses:

VkVertexInputBindingDivisorDescriptionEXT, VkVertexInputBindingDivisorDescriptionKHR

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

Structure specifying a divisor used in instanced rendering.

Description

If this structure is not used to define a divisor value for an attribute, then the divisor has a logical default value of 1.

Valid Usage

• binding must be less than VkPhysicalDeviceLimits::maxVertexInputBindings
• 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 VkPhysicalDeviceVertexAttributeDivisorProperties::maxVertexAttribDivisor, inclusive
• VkVertexInputBindingDescription::inputRate must be of type VERTEX_INPUT_RATE_INSTANCE for this binding

See Also

VkPipelineVertexInputDivisorStateCreateInfo

Layout

 struct VkVertexInputBindingDivisorDescription {
     uint32_t binding();
     uint32_t divisor();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkVertexInputBindingDivisorDescription.Buffer	An array of VkVertexInputBindingDivisorDescription 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	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	Description
VkVertexInputBindingDivisorDescription(ByteBuffer container)	Creates a VkVertexInputBindingDivisorDescription instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
int	binding()	the binding number for which the divisor is specified.
VkVertexInputBindingDivisorDescription	binding(int value)	Sets the specified value to the binding() field.
static VkVertexInputBindingDivisorDescription	calloc()	Returns a new VkVertexInputBindingDivisorDescription instance allocated with memCalloc.
static VkVertexInputBindingDivisorDescription.Buffer	calloc(int capacity)	Returns a new VkVertexInputBindingDivisorDescription.Buffer instance allocated with memCalloc.
static VkVertexInputBindingDivisorDescription.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkVertexInputBindingDivisorDescription.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkVertexInputBindingDivisorDescription	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkVertexInputBindingDivisorDescription instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkVertexInputBindingDivisorDescription	create()	Returns a new VkVertexInputBindingDivisorDescription instance allocated with BufferUtils.
static VkVertexInputBindingDivisorDescription.Buffer	create(int capacity)	Returns a new VkVertexInputBindingDivisorDescription.Buffer instance allocated with BufferUtils.
static VkVertexInputBindingDivisorDescription	create(long address)	Returns a new VkVertexInputBindingDivisorDescription instance for the specified memory address.
static VkVertexInputBindingDivisorDescription.Buffer	create(long address, int capacity)	Create a VkVertexInputBindingDivisorDescription.Buffer instance at the specified memory.
static @Nullable VkVertexInputBindingDivisorDescription	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkVertexInputBindingDivisorDescription.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.
VkVertexInputBindingDivisorDescription	divisor(int value)	Sets the specified value to the divisor() field.
static VkVertexInputBindingDivisorDescription	malloc()	Returns a new VkVertexInputBindingDivisorDescription instance allocated with memAlloc.
static VkVertexInputBindingDivisorDescription.Buffer	malloc(int capacity)	Returns a new VkVertexInputBindingDivisorDescription.Buffer instance allocated with memAlloc.
static VkVertexInputBindingDivisorDescription.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkVertexInputBindingDivisorDescription.Buffer instance allocated on the specified MemoryStack.
static VkVertexInputBindingDivisorDescription	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkVertexInputBindingDivisorDescription 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.
VkVertexInputBindingDivisorDescription	set(int binding, int divisor)	Initializes this struct with the specified values.
VkVertexInputBindingDivisorDescription	set(VkVertexInputBindingDivisorDescription src)	Copies the specified struct data to this struct.
int	sizeof()

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.

DIVISOR

public static final int DIVISOR

The struct member offsets.

Constructor Details

VkVertexInputBindingDivisorDescription

public VkVertexInputBindingDivisorDescription(ByteBuffer container)

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

binding

public int binding()

the binding number for which the divisor is specified.

divisor

public int divisor()

the number of successive instances that will use the same value of the vertex attribute when instanced rendering 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 VkPhysicalDeviceVertexAttributeDivisorProperties::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.

binding

public VkVertexInputBindingDivisorDescription binding(int value)

Sets the specified value to the binding() field.

divisor

public VkVertexInputBindingDivisorDescription divisor(int value)

Sets the specified value to the divisor() field.

set

public VkVertexInputBindingDivisorDescription set(int binding,
 int divisor)

Initializes this struct with the specified values.

set

public VkVertexInputBindingDivisorDescription set(VkVertexInputBindingDivisorDescription src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkVertexInputBindingDivisorDescription malloc()

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

calloc

public static VkVertexInputBindingDivisorDescription calloc()

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

create

public static VkVertexInputBindingDivisorDescription create()

Returns a new VkVertexInputBindingDivisorDescription instance allocated with BufferUtils.

create

public static VkVertexInputBindingDivisorDescription create(long address)

Returns a new VkVertexInputBindingDivisorDescription instance for the specified memory address.

createSafe

public static @Nullable VkVertexInputBindingDivisorDescription createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkVertexInputBindingDivisorDescription.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkVertexInputBindingDivisorDescription.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkVertexInputBindingDivisorDescription.Buffer create(int capacity)

Returns a new VkVertexInputBindingDivisorDescription.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkVertexInputBindingDivisorDescription.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new VkVertexInputBindingDivisorDescription instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

Returns a new VkVertexInputBindingDivisorDescription.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().

ndivisor

public static int ndivisor(long struct)

Unsafe version of divisor().

nbinding

public static void nbinding(long struct,
 int value)

Unsafe version of binding.

ndivisor

public static void ndivisor(long struct,
 int value)

Unsafe version of divisor.