Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkVertexInputBindingDivisorDescriptionEXT

extends Struct<VkVertexInputBindingDivisorDescriptionEXT>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*

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
See Also

VkPipelineVertexInputDivisorStateCreateInfoEXT

Layout


struct VkVertexInputBindingDivisorDescriptionEXT {
    uint32_t binding;
    uint32_t divisor;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
BINDING

The struct member offsets.

public static final int
DIVISOR

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
public
VkVertexInputBindingDivisorDescriptionEXT(ByteBuffer container)

Creates a VkVertexInputBindingDivisorDescriptionEXT instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and TypeMethod and Description
public int
binding()

the binding number for which the divisor is specified.

public VkVertexInputBindingDivisorDescriptionEXT
binding(int value)

Sets the specified value to the binding field.

public static VkVertexInputBindingDivisorDescriptionEXT
calloc()

Returns a new VkVertexInputBindingDivisorDescriptionEXT instance allocated with memCalloc.

public static VkVertexInputBindingDivisorDescriptionEXT.Buffer
calloc(int
the buffer capacity
capacity
)

Returns a new VkVertexInputBindingDivisorDescriptionEXT.Buffer instance allocated with memCalloc.

public static VkVertexInputBindingDivisorDescriptionEXT
calloc(MemoryStack
the stack from which to allocate
stack
)

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

public static VkVertexInputBindingDivisorDescriptionEXT.Buffer
calloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

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

public static VkVertexInputBindingDivisorDescriptionEXT
callocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static VkVertexInputBindingDivisorDescriptionEXT
callocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static VkVertexInputBindingDivisorDescriptionEXT.Buffer
callocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static VkVertexInputBindingDivisorDescriptionEXT.Buffer
callocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
protected VkVertexInputBindingDivisorDescriptionEXT
create(long
the struct memory address
address
,
ByteBuffer
an optional container buffer, to be referenced strongly by the struct instance.
container
)

Implements abstract org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.
public static VkVertexInputBindingDivisorDescriptionEXT
create()

Returns a new VkVertexInputBindingDivisorDescriptionEXT instance allocated with BufferUtils.

public static VkVertexInputBindingDivisorDescriptionEXT
create(long address)

Returns a new VkVertexInputBindingDivisorDescriptionEXT instance for the specified memory address.

public static VkVertexInputBindingDivisorDescriptionEXT.Buffer
create(int
the buffer capacity
capacity
)

Returns a new VkVertexInputBindingDivisorDescriptionEXT.Buffer instance allocated with BufferUtils.

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

Create a VkVertexInputBindingDivisorDescriptionEXT.Buffer instance at the specified memory.

public static VkVertexInputBindingDivisorDescriptionEXT
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public int
divisor()

the number of successive instances that will use the same value of the vertex attribute when instanced rendering is enabled.

public VkVertexInputBindingDivisorDescriptionEXT
divisor(int value)

Sets the specified value to the divisor field.

public static VkVertexInputBindingDivisorDescriptionEXT
malloc()

Returns a new VkVertexInputBindingDivisorDescriptionEXT instance allocated with memAlloc.

public static VkVertexInputBindingDivisorDescriptionEXT.Buffer
malloc(int
the buffer capacity
capacity
)

Returns a new VkVertexInputBindingDivisorDescriptionEXT.Buffer instance allocated with memAlloc.

public static VkVertexInputBindingDivisorDescriptionEXT
malloc(MemoryStack
the stack from which to allocate
stack
)

Returns a new VkVertexInputBindingDivisorDescriptionEXT instance allocated on the specified MemoryStack.

public static VkVertexInputBindingDivisorDescriptionEXT.Buffer
malloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

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

public static VkVertexInputBindingDivisorDescriptionEXT
mallocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static VkVertexInputBindingDivisorDescriptionEXT
mallocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static VkVertexInputBindingDivisorDescriptionEXT.Buffer
mallocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static VkVertexInputBindingDivisorDescriptionEXT.Buffer
mallocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static int
nbinding(long struct)

Unsafe version of binding.

public static void
nbinding(long struct, int value)

Unsafe version of binding.

public static int
ndivisor(long struct)

Unsafe version of divisor.

public static void
ndivisor(long struct, int value)

Unsafe version of divisor.

public VkVertexInputBindingDivisorDescriptionEXT
set(int binding, int divisor)

Initializes this struct with the specified values.

public VkVertexInputBindingDivisorDescriptionEXT

Returns:

this struct
set
(VkVertexInputBindingDivisorDescriptionEXT
the source struct
src
)

Copies the specified struct data to this struct.

public int
sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).
Inherited from org.lwjgl.system.Struct:
__array__array__array__checkContainer__checkMalloc__create__getContainer__getContainer__member__member__member__padding__padding__struct__struct__union__unionclearfreeisNullvalidate

Field Detail

ALIGNOFback to summary
public static final int ALIGNOF

The struct alignment in bytes.

BINDINGback to summary
public static final int BINDING

The struct member offsets.

DIVISORback to summary
public static final int DIVISOR

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

Constructor Detail

VkVertexInputBindingDivisorDescriptionEXTback to summary
protected VkVertexInputBindingDivisorDescriptionEXT(long address, ByteBuffer container)
VkVertexInputBindingDivisorDescriptionEXTback to summary
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 Detail

bindingback to summary
public int binding()

the binding number for which the divisor is specified.

Annotations
@NativeType:uint32_t
bindingback to summary
public VkVertexInputBindingDivisorDescriptionEXT binding(int value)

Sets the specified value to the binding field.

callocback to summary
public static VkVertexInputBindingDivisorDescriptionEXT calloc()

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

callocback to summary
public static VkVertexInputBindingDivisorDescriptionEXT.Buffer calloc(int capacity)

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkVertexInputBindingDivisorDescriptionEXT calloc(MemoryStack stack)

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

Parameters
stack:MemoryStack

the stack from which to allocate

callocback to summary
public static VkVertexInputBindingDivisorDescriptionEXT.Buffer calloc(int capacity, MemoryStack stack)

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

callocStackback to summary
public static VkVertexInputBindingDivisorDescriptionEXT callocStack()

Deprecated

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

Annotations
@Deprecated
callocStackback to summary
public static VkVertexInputBindingDivisorDescriptionEXT callocStack(MemoryStack stack)

Deprecated

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

Annotations
@Deprecated
callocStackback to summary
public static VkVertexInputBindingDivisorDescriptionEXT.Buffer callocStack(int capacity)

Deprecated

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

Annotations
@Deprecated
callocStackback to summary
public static VkVertexInputBindingDivisorDescriptionEXT.Buffer callocStack(int capacity, MemoryStack stack)

Deprecated

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

Annotations
@Deprecated
createback to summary
protected VkVertexInputBindingDivisorDescriptionEXT create(long address, ByteBuffer container)

Implements abstract org.lwjgl.system.Struct.create.

Doc from org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.

Effectively, every Struct instance is a factory for more instances of the same type. This is used by StructBuffer.

Parameters
address:long

the struct memory address

container:ByteBuffer

an optional container buffer, to be referenced strongly by the struct instance.

Annotations
@Override
createback to summary
public static VkVertexInputBindingDivisorDescriptionEXT create()

Returns a new VkVertexInputBindingDivisorDescriptionEXT instance allocated with BufferUtils.

createback to summary
public static VkVertexInputBindingDivisorDescriptionEXT create(long address)

Returns a new VkVertexInputBindingDivisorDescriptionEXT instance for the specified memory address.

createback to summary
public static VkVertexInputBindingDivisorDescriptionEXT.Buffer create(int capacity)

Returns a new VkVertexInputBindingDivisorDescriptionEXT.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkVertexInputBindingDivisorDescriptionEXT.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkVertexInputBindingDivisorDescriptionEXT createSafe(long address)

Like create, but returns null if address is NULL.

Annotations
@Nullable
createSafeback to summary
public static VkVertexInputBindingDivisorDescriptionEXT.Buffer createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

Annotations
@Nullable
divisorback to summary
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.

Annotations
@NativeType:uint32_t
divisorback to summary
public VkVertexInputBindingDivisorDescriptionEXT divisor(int value)

Sets the specified value to the divisor field.

mallocback to summary
public static VkVertexInputBindingDivisorDescriptionEXT malloc()

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

mallocback to summary
public static VkVertexInputBindingDivisorDescriptionEXT.Buffer malloc(int capacity)

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkVertexInputBindingDivisorDescriptionEXT malloc(MemoryStack stack)

Returns a new VkVertexInputBindingDivisorDescriptionEXT instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

mallocback to summary
public static VkVertexInputBindingDivisorDescriptionEXT.Buffer malloc(int capacity, MemoryStack stack)

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

mallocStackback to summary
public static VkVertexInputBindingDivisorDescriptionEXT mallocStack()

Deprecated

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

Annotations
@Deprecated
mallocStackback to summary
public static VkVertexInputBindingDivisorDescriptionEXT mallocStack(MemoryStack stack)

Deprecated

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

Annotations
@Deprecated
mallocStackback to summary
public static VkVertexInputBindingDivisorDescriptionEXT.Buffer mallocStack(int capacity)

Deprecated

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

Annotations
@Deprecated
mallocStackback to summary
public static VkVertexInputBindingDivisorDescriptionEXT.Buffer mallocStack(int capacity, MemoryStack stack)

Deprecated

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

Annotations
@Deprecated
nbindingback to summary
public static int nbinding(long struct)

Unsafe version of binding.

nbindingback to summary
public static void nbinding(long struct, int value)

Unsafe version of binding.

ndivisorback to summary
public static int ndivisor(long struct)

Unsafe version of divisor.

ndivisorback to summary
public static void ndivisor(long struct, int value)

Unsafe version of divisor.

setback to summary
public VkVertexInputBindingDivisorDescriptionEXT set(int binding, int divisor)

Initializes this struct with the specified values.

setback to summary
public VkVertexInputBindingDivisorDescriptionEXT set(VkVertexInputBindingDivisorDescriptionEXT src)

Copies the specified struct data to this struct.

Parameters
src:VkVertexInputBindingDivisorDescriptionEXT

the source struct

Returns:VkVertexInputBindingDivisorDescriptionEXT

this struct

sizeofback to summary
public int sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Doc from org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).

Annotations
@Override
org.lwjgl.vulkan back to summary

public Class VkVertexInputBindingDivisorDescriptionEXT.Buffer

extends StructBuffer<VkVertexInputBindingDivisorDescriptionEXT, VkVertexInputBindingDivisorDescriptionEXT.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable

An array of VkVertexInputBindingDivisorDescriptionEXT structs.

Field Summary

Modifier and TypeField and Description
private static final VkVertexInputBindingDivisorDescriptionEXT

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkVertexInputBindingDivisorDescriptionEXT.Buffer instance backed by the specified container.

public
Buffer(long address, int cap)

pack-priv
Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Summary

Modifier and TypeMethod and Description
public int
public VkVertexInputBindingDivisorDescriptionEXT.Buffer
binding(int value)

Sets the specified value to the VkVertexInputBindingDivisorDescriptionEXT#binding field.

public int
public VkVertexInputBindingDivisorDescriptionEXT.Buffer
divisor(int value)

Sets the specified value to the VkVertexInputBindingDivisorDescriptionEXT#divisor field.

protected VkVertexInputBindingDivisorDescriptionEXT
protected VkVertexInputBindingDivisorDescriptionEXT.Buffer
Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkVertexInputBindingDivisorDescriptionEXT ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new VkVertexInputBindingDivisorDescriptionEXT.Buffer instance backed by the specified container.

Changes to the container's content will be visible to the struct buffer instance and vice versa. The two buffers' position, limit, and mark values will be independent. The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer divided by VkVertexInputBindingDivisorDescriptionEXT#SIZEOF, and its mark will be undefined.

The created buffer instance holds a strong reference to the container object.

Bufferback to summary
public Buffer(long address, int cap)
Bufferback to summary
pack-priv Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Detail

bindingback to summary
public int binding()
Returns:int

the value of the VkVertexInputBindingDivisorDescriptionEXT#binding field.

Annotations
@NativeType:uint32_t
bindingback to summary
public VkVertexInputBindingDivisorDescriptionEXT.Buffer binding(int value)

Sets the specified value to the VkVertexInputBindingDivisorDescriptionEXT#binding field.

divisorback to summary
public int divisor()
Returns:int

the value of the VkVertexInputBindingDivisorDescriptionEXT#divisor field.

Annotations
@NativeType:uint32_t
divisorback to summary
public VkVertexInputBindingDivisorDescriptionEXT.Buffer divisor(int value)

Sets the specified value to the VkVertexInputBindingDivisorDescriptionEXT#divisor field.

getElementFactoryback to summary
protected VkVertexInputBindingDivisorDescriptionEXT getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

Annotations
@Override
selfback to summary
protected VkVertexInputBindingDivisorDescriptionEXT.Buffer self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

Annotations
@Override