Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkVertexInputBindingDescription

extends Struct<VkVertexInputBindingDescription>
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 vertex input binding description.
Valid Usage
Valid Usage (Implicit)
See Also

VkPipelineVertexInputStateCreateInfo

Layout


struct VkVertexInputBindingDescription {
    uint32_t binding;
    uint32_t stride;
    VkVertexInputRate inputRate;
}

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
INPUTRATE

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
STRIDE

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
public
VkVertexInputBindingDescription(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public int
binding()

the binding number that this structure describes.

public VkVertexInputBindingDescription
binding(int value)

Sets the specified value to the binding field.

public static VkVertexInputBindingDescription
calloc()

Returns a new VkVertexInputBindingDescription instance allocated with memCalloc.

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

Returns a new VkVertexInputBindingDescription.Buffer instance allocated with memCalloc.

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

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

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

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

public static VkVertexInputBindingDescription
callocStack()

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

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

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

Deprecated
Deprecated for removal in 3.4.0.
protected VkVertexInputBindingDescription
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 VkVertexInputBindingDescription
create()

Returns a new VkVertexInputBindingDescription instance allocated with BufferUtils.

public static VkVertexInputBindingDescription
create(long address)

Returns a new VkVertexInputBindingDescription instance for the specified memory address.

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

Returns a new VkVertexInputBindingDescription.Buffer instance allocated with BufferUtils.

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

Create a VkVertexInputBindingDescription.Buffer instance at the specified memory.

public static VkVertexInputBindingDescription
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public int
inputRate()

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

public VkVertexInputBindingDescription
inputRate(int value)

Sets the specified value to the inputRate field.

public static VkVertexInputBindingDescription
malloc()

Returns a new VkVertexInputBindingDescription instance allocated with memAlloc.

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

Returns a new VkVertexInputBindingDescription.Buffer instance allocated with memAlloc.

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

Returns a new VkVertexInputBindingDescription instance allocated on the specified MemoryStack.

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

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

public static VkVertexInputBindingDescription
mallocStack()

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

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

Deprecated
Deprecated for removal in 3.4.0.
public static VkVertexInputBindingDescription.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
ninputRate(long struct)

Unsafe version of inputRate.

public static void
ninputRate(long struct, int value)

Unsafe version of inputRate.

public static int
nstride(long struct)

Unsafe version of stride.

public static void
nstride(long struct, int value)

Unsafe version of stride.

public VkVertexInputBindingDescription
set(int binding, int stride, int inputRate)

Initializes this struct with the specified values.

public VkVertexInputBindingDescription

Returns:

this struct
set
(VkVertexInputBindingDescription
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).
public int
stride()

the byte stride between consecutive elements within the buffer.

public VkVertexInputBindingDescription
stride(int value)

Sets the specified value to the stride field.

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.

INPUTRATEback to summary
public static final int INPUTRATE

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

STRIDEback to summary
public static final int STRIDE

The struct member offsets.

Constructor Detail

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

bindingback to summary
public int binding()

the binding number that this structure describes.

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

Sets the specified value to the binding field.

callocback to summary
public static VkVertexInputBindingDescription calloc()

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkVertexInputBindingDescription calloc(MemoryStack stack)

Returns a new VkVertexInputBindingDescription 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 VkVertexInputBindingDescription.Buffer calloc(int capacity, MemoryStack stack)

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

Annotations
@Deprecated
callocStackback to summary
public static VkVertexInputBindingDescription.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 VkVertexInputBindingDescription 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 VkVertexInputBindingDescription create()

Returns a new VkVertexInputBindingDescription instance allocated with BufferUtils.

createback to summary
public static VkVertexInputBindingDescription create(long address)

Returns a new VkVertexInputBindingDescription instance for the specified memory address.

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

Returns a new VkVertexInputBindingDescription.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkVertexInputBindingDescription.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkVertexInputBindingDescription createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
inputRateback to summary
public int inputRate()

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

Annotations
@NativeType:VkVertexInputRate
inputRateback to summary
public VkVertexInputBindingDescription inputRate(int value)

Sets the specified value to the inputRate field.

mallocback to summary
public static VkVertexInputBindingDescription malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkVertexInputBindingDescription malloc(MemoryStack stack)

Returns a new VkVertexInputBindingDescription instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

Annotations
@Deprecated
mallocStackback to summary
public static VkVertexInputBindingDescription.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.

ninputRateback to summary
public static int ninputRate(long struct)

Unsafe version of inputRate.

ninputRateback to summary
public static void ninputRate(long struct, int value)

Unsafe version of inputRate.

nstrideback to summary
public static int nstride(long struct)

Unsafe version of stride.

nstrideback to summary
public static void nstride(long struct, int value)

Unsafe version of stride.

setback to summary
public VkVertexInputBindingDescription set(int binding, int stride, int inputRate)

Initializes this struct with the specified values.

setback to summary
public VkVertexInputBindingDescription set(VkVertexInputBindingDescription src)

Copies the specified struct data to this struct.

Parameters
src:VkVertexInputBindingDescription

the source struct

Returns:VkVertexInputBindingDescription

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
strideback to summary
public int stride()

the byte stride between consecutive elements within the buffer.

Annotations
@NativeType:uint32_t
strideback to summary
public VkVertexInputBindingDescription stride(int value)

Sets the specified value to the stride field.

org.lwjgl.vulkan back to summary

public Class VkVertexInputBindingDescription.Buffer

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

An array of VkVertexInputBindingDescription structs.

Field Summary

Modifier and TypeField and Description
private static final VkVertexInputBindingDescription

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkVertexInputBindingDescription.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

Returns:

the value of the VkVertexInputBindingDescription#binding field.
binding
()

public VkVertexInputBindingDescription.Buffer
binding(int value)

Sets the specified value to the VkVertexInputBindingDescription#binding field.

protected VkVertexInputBindingDescription
public int

Returns:

the value of the VkVertexInputBindingDescription#inputRate field.
inputRate
()

public VkVertexInputBindingDescription.Buffer
inputRate(int value)

Sets the specified value to the VkVertexInputBindingDescription#inputRate field.

protected VkVertexInputBindingDescription.Buffer
public int

Returns:

the value of the VkVertexInputBindingDescription#stride field.
stride
()

public VkVertexInputBindingDescription.Buffer
stride(int value)

Sets the specified value to the VkVertexInputBindingDescription#stride field.

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkVertexInputBindingDescription ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new VkVertexInputBindingDescription.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 VkVertexInputBindingDescription#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 VkVertexInputBindingDescription#binding field.

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

Sets the specified value to the VkVertexInputBindingDescription#binding field.

getElementFactoryback to summary
protected VkVertexInputBindingDescription getElementFactory()

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

Annotations
@Override
inputRateback to summary
public int inputRate()
Returns:int

the value of the VkVertexInputBindingDescription#inputRate field.

Annotations
@NativeType:VkVertexInputRate
inputRateback to summary
public VkVertexInputBindingDescription.Buffer inputRate(int value)

Sets the specified value to the VkVertexInputBindingDescription#inputRate field.

selfback to summary
protected VkVertexInputBindingDescription.Buffer self()

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

Annotations
@Override
strideback to summary
public int stride()
Returns:int

the value of the VkVertexInputBindingDescription#stride field.

Annotations
@NativeType:uint32_t
strideback to summary
public VkVertexInputBindingDescription.Buffer stride(int value)

Sets the specified value to the VkVertexInputBindingDescription#stride field.