Package org.lwjgl.vulkan

Class VkVertexInputBindingDivisorDescriptionEXT

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkVertexInputBindingDivisorDescriptionEXT>

org.lwjgl.vulkan.VkVertexInputBindingDivisorDescriptionEXT

All Implemented Interfaces:

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

public class VkVertexInputBindingDivisorDescriptionEXT
extends org.lwjgl.system.Struct<VkVertexInputBindingDivisorDescriptionEXT>
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 VkPhysicalDeviceVertexAttributeDivisorPropertiesEXT::maxVertexAttribDivisor, inclusive
• VkVertexInputBindingDescription::inputRate must be of type VERTEX_INPUT_RATE_INSTANCE for this binding

See Also

VkPipelineVertexInputDivisorStateCreateInfoEXT

Layout

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkVertexInputBindingDivisorDescriptionEXT.Buffer	An array of VkVertexInputBindingDivisorDescriptionEXT 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
VkVertexInputBindingDivisorDescriptionEXT(ByteBuffer container)	Creates a VkVertexInputBindingDivisorDescriptionEXT 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.
VkVertexInputBindingDivisorDescriptionEXT	binding(int value)	Sets the specified value to the binding() field.
static VkVertexInputBindingDivisorDescriptionEXT	calloc()	Returns a new VkVertexInputBindingDivisorDescriptionEXT instance allocated with memCalloc.
static VkVertexInputBindingDivisorDescriptionEXT.Buffer	calloc(int capacity)	Returns a new VkVertexInputBindingDivisorDescriptionEXT.Buffer instance allocated with memCalloc.
static VkVertexInputBindingDivisorDescriptionEXT.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkVertexInputBindingDivisorDescriptionEXT.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkVertexInputBindingDivisorDescriptionEXT	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkVertexInputBindingDivisorDescriptionEXT instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkVertexInputBindingDivisorDescriptionEXT	callocStack()	Deprecated.
static VkVertexInputBindingDivisorDescriptionEXT.Buffer	callocStack(int capacity)	Deprecated.
static VkVertexInputBindingDivisorDescriptionEXT.Buffer	callocStack(int capacity, org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkVertexInputBindingDivisorDescriptionEXT	callocStack(org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkVertexInputBindingDivisorDescriptionEXT	create()	Returns a new VkVertexInputBindingDivisorDescriptionEXT instance allocated with BufferUtils.
static VkVertexInputBindingDivisorDescriptionEXT.Buffer	create(int capacity)	Returns a new VkVertexInputBindingDivisorDescriptionEXT.Buffer instance allocated with BufferUtils.
static VkVertexInputBindingDivisorDescriptionEXT	create(long address)	Returns a new VkVertexInputBindingDivisorDescriptionEXT instance for the specified memory address.
static VkVertexInputBindingDivisorDescriptionEXT.Buffer	create(long address, int capacity)	Create a VkVertexInputBindingDivisorDescriptionEXT.Buffer instance at the specified memory.
static VkVertexInputBindingDivisorDescriptionEXT	createSafe(long address)	Like create, but returns null if address is NULL.
static VkVertexInputBindingDivisorDescriptionEXT.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.
VkVertexInputBindingDivisorDescriptionEXT	divisor(int value)	Sets the specified value to the divisor() field.
static VkVertexInputBindingDivisorDescriptionEXT	malloc()	Returns a new VkVertexInputBindingDivisorDescriptionEXT instance allocated with memAlloc.
static VkVertexInputBindingDivisorDescriptionEXT.Buffer	malloc(int capacity)	Returns a new VkVertexInputBindingDivisorDescriptionEXT.Buffer instance allocated with memAlloc.
static VkVertexInputBindingDivisorDescriptionEXT.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkVertexInputBindingDivisorDescriptionEXT.Buffer instance allocated on the specified MemoryStack.
static VkVertexInputBindingDivisorDescriptionEXT	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkVertexInputBindingDivisorDescriptionEXT instance allocated on the specified MemoryStack.
static VkVertexInputBindingDivisorDescriptionEXT	mallocStack()	Deprecated.
static VkVertexInputBindingDivisorDescriptionEXT.Buffer	mallocStack(int capacity)	Deprecated.
static VkVertexInputBindingDivisorDescriptionEXT.Buffer	mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkVertexInputBindingDivisorDescriptionEXT	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	ndivisor(long struct)	Unsafe version of divisor().
static void	ndivisor(long struct, int value)	Unsafe version of divisor.
VkVertexInputBindingDivisorDescriptionEXT	set(int binding, int divisor)	Initializes this struct with the specified values.
VkVertexInputBindingDivisorDescriptionEXT	set(VkVertexInputBindingDivisorDescriptionEXT src)	Copies the specified struct data to this struct.
int	sizeof()

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull, 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

VkVertexInputBindingDivisorDescriptionEXT

public VkVertexInputBindingDivisorDescriptionEXT(ByteBuffer container)

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

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

binding

public VkVertexInputBindingDivisorDescriptionEXT binding(int value)

Sets the specified value to the binding() field.

divisor

public VkVertexInputBindingDivisorDescriptionEXT divisor(int value)

Sets the specified value to the divisor() field.

set

public VkVertexInputBindingDivisorDescriptionEXT set(int binding,
 int divisor)

Initializes this struct with the specified values.

set

public VkVertexInputBindingDivisorDescriptionEXT set(VkVertexInputBindingDivisorDescriptionEXT src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkVertexInputBindingDivisorDescriptionEXT malloc()

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

calloc

public static VkVertexInputBindingDivisorDescriptionEXT calloc()

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

create

public static VkVertexInputBindingDivisorDescriptionEXT create()

Returns a new VkVertexInputBindingDivisorDescriptionEXT instance allocated with BufferUtils.

create

public static VkVertexInputBindingDivisorDescriptionEXT create(long address)

Returns a new VkVertexInputBindingDivisorDescriptionEXT instance for the specified memory address.

createSafe

@Nullable
public static VkVertexInputBindingDivisorDescriptionEXT createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkVertexInputBindingDivisorDescriptionEXT.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkVertexInputBindingDivisorDescriptionEXT.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkVertexInputBindingDivisorDescriptionEXT.Buffer create(int capacity)

Returns a new VkVertexInputBindingDivisorDescriptionEXT.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkVertexInputBindingDivisorDescriptionEXT.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

mallocStack

@Deprecated
public static VkVertexInputBindingDivisorDescriptionEXT mallocStack()

Deprecated.

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

callocStack

@Deprecated
public static VkVertexInputBindingDivisorDescriptionEXT callocStack()

Deprecated.

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

mallocStack

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

Deprecated.

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

callocStack

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

Deprecated.

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

mallocStack

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

Deprecated.

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

callocStack

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

Deprecated.

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

mallocStack

@Deprecated
public static VkVertexInputBindingDivisorDescriptionEXT.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 VkVertexInputBindingDivisorDescriptionEXT.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 VkVertexInputBindingDivisorDescriptionEXT malloc(org.lwjgl.system.MemoryStack stack)

Returns a new VkVertexInputBindingDivisorDescriptionEXT instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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