Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkVertexInputAttributeDescription

extends Struct<VkVertexInputAttributeDescription>
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 attribute description.
Valid Usage
Valid Usage (Implicit)
See Also

VkPipelineVertexInputStateCreateInfo

Layout


struct VkVertexInputAttributeDescription {
    uint32_t location;
    uint32_t binding;
    VkFormat format;
    uint32_t offset;
}

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
FORMAT

The struct member offsets.

public static final int
LOCATION

The struct member offsets.

public static final int
OFFSET

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
VkVertexInputAttributeDescription(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public int
binding()

the binding number which this attribute takes its data from.

public VkVertexInputAttributeDescription
binding(int value)

Sets the specified value to the binding field.

public static VkVertexInputAttributeDescription
calloc()

Returns a new VkVertexInputAttributeDescription instance allocated with memCalloc.

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

Returns a new VkVertexInputAttributeDescription.Buffer instance allocated with memCalloc.

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

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

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

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

public static VkVertexInputAttributeDescription
callocStack()

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

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

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

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

Returns a new VkVertexInputAttributeDescription instance allocated with BufferUtils.

public static VkVertexInputAttributeDescription
create(long address)

Returns a new VkVertexInputAttributeDescription instance for the specified memory address.

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

Returns a new VkVertexInputAttributeDescription.Buffer instance allocated with BufferUtils.

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

Create a VkVertexInputAttributeDescription.Buffer instance at the specified memory.

public static VkVertexInputAttributeDescription
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public int
format()

the size and type of the vertex attribute data.

public VkVertexInputAttributeDescription
format(int value)

Sets the specified value to the format field.

public int
location()

the shader input location number for this attribute.

public VkVertexInputAttributeDescription
location(int value)

Sets the specified value to the location field.

public static VkVertexInputAttributeDescription
malloc()

Returns a new VkVertexInputAttributeDescription instance allocated with memAlloc.

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

Returns a new VkVertexInputAttributeDescription.Buffer instance allocated with memAlloc.

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

Returns a new VkVertexInputAttributeDescription instance allocated on the specified MemoryStack.

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

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

public static VkVertexInputAttributeDescription
mallocStack()

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

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

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

Unsafe version of format.

public static void
nformat(long struct, int value)

Unsafe version of format.

public static int
nlocation(long struct)

Unsafe version of location.

public static void
nlocation(long struct, int value)

Unsafe version of location.

public static int
noffset(long struct)

Unsafe version of offset.

public static void
noffset(long struct, int value)

Unsafe version of offset.

public int
offset()

a byte offset of this attribute relative to the start of an element in the vertex input binding.

public VkVertexInputAttributeDescription
offset(int value)

Sets the specified value to the offset field.

public VkVertexInputAttributeDescription
set(int location, int binding, int format, int offset)

Initializes this struct with the specified values.

public VkVertexInputAttributeDescription

Returns:

this struct
set
(VkVertexInputAttributeDescription
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.

FORMATback to summary
public static final int FORMAT

The struct member offsets.

LOCATIONback to summary
public static final int LOCATION

The struct member offsets.

OFFSETback to summary
public static final int OFFSET

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

Constructor Detail

VkVertexInputAttributeDescriptionback to summary
protected VkVertexInputAttributeDescription(long address, ByteBuffer container)
VkVertexInputAttributeDescriptionback to summary
public VkVertexInputAttributeDescription(ByteBuffer container)

Creates a VkVertexInputAttributeDescription 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 which this attribute takes its data from.

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

Sets the specified value to the binding field.

callocback to summary
public static VkVertexInputAttributeDescription calloc()

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkVertexInputAttributeDescription calloc(MemoryStack stack)

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

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

Returns a new VkVertexInputAttributeDescription instance allocated with BufferUtils.

createback to summary
public static VkVertexInputAttributeDescription create(long address)

Returns a new VkVertexInputAttributeDescription instance for the specified memory address.

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

Returns a new VkVertexInputAttributeDescription.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkVertexInputAttributeDescription.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkVertexInputAttributeDescription createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
formatback to summary
public int format()

the size and type of the vertex attribute data.

Annotations
@NativeType:VkFormat
formatback to summary
public VkVertexInputAttributeDescription format(int value)

Sets the specified value to the format field.

locationback to summary
public int location()

the shader input location number for this attribute.

Annotations
@NativeType:uint32_t
locationback to summary
public VkVertexInputAttributeDescription location(int value)

Sets the specified value to the location field.

mallocback to summary
public static VkVertexInputAttributeDescription malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkVertexInputAttributeDescription malloc(MemoryStack stack)

Returns a new VkVertexInputAttributeDescription instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

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

nformatback to summary
public static int nformat(long struct)

Unsafe version of format.

nformatback to summary
public static void nformat(long struct, int value)

Unsafe version of format.

nlocationback to summary
public static int nlocation(long struct)

Unsafe version of location.

nlocationback to summary
public static void nlocation(long struct, int value)

Unsafe version of location.

noffsetback to summary
public static int noffset(long struct)

Unsafe version of offset.

noffsetback to summary
public static void noffset(long struct, int value)

Unsafe version of offset.

offsetback to summary
public int offset()

a byte offset of this attribute relative to the start of an element in the vertex input binding.

Annotations
@NativeType:uint32_t
offsetback to summary
public VkVertexInputAttributeDescription offset(int value)

Sets the specified value to the offset field.

setback to summary
public VkVertexInputAttributeDescription set(int location, int binding, int format, int offset)

Initializes this struct with the specified values.

setback to summary
public VkVertexInputAttributeDescription set(VkVertexInputAttributeDescription src)

Copies the specified struct data to this struct.

Parameters
src:VkVertexInputAttributeDescription

the source struct

Returns:VkVertexInputAttributeDescription

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

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

An array of VkVertexInputAttributeDescription structs.

Field Summary

Modifier and TypeField and Description
private static final VkVertexInputAttributeDescription

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkVertexInputAttributeDescription.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 VkVertexInputAttributeDescription#binding field.
binding
()

public VkVertexInputAttributeDescription.Buffer
binding(int value)

Sets the specified value to the VkVertexInputAttributeDescription#binding field.

public int

Returns:

the value of the VkVertexInputAttributeDescription#format field.
format
()

public VkVertexInputAttributeDescription.Buffer
format(int value)

Sets the specified value to the VkVertexInputAttributeDescription#format field.

protected VkVertexInputAttributeDescription
public int

Returns:

the value of the VkVertexInputAttributeDescription#location field.
location
()

public VkVertexInputAttributeDescription.Buffer
location(int value)

Sets the specified value to the VkVertexInputAttributeDescription#location field.

public int

Returns:

the value of the VkVertexInputAttributeDescription#offset field.
offset
()

public VkVertexInputAttributeDescription.Buffer
offset(int value)

Sets the specified value to the VkVertexInputAttributeDescription#offset field.

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

Field Detail

ELEMENT_FACTORYback to summary
private static final VkVertexInputAttributeDescription ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

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

Sets the specified value to the VkVertexInputAttributeDescription#binding field.

formatback to summary
public int format()
Returns:int

the value of the VkVertexInputAttributeDescription#format field.

Annotations
@NativeType:VkFormat
formatback to summary
public VkVertexInputAttributeDescription.Buffer format(int value)

Sets the specified value to the VkVertexInputAttributeDescription#format field.

getElementFactoryback to summary
protected VkVertexInputAttributeDescription getElementFactory()

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

Annotations
@Override
locationback to summary
public int location()
Returns:int

the value of the VkVertexInputAttributeDescription#location field.

Annotations
@NativeType:uint32_t
locationback to summary
public VkVertexInputAttributeDescription.Buffer location(int value)

Sets the specified value to the VkVertexInputAttributeDescription#location field.

offsetback to summary
public int offset()
Returns:int

the value of the VkVertexInputAttributeDescription#offset field.

Annotations
@NativeType:uint32_t
offsetback to summary
public VkVertexInputAttributeDescription.Buffer offset(int value)

Sets the specified value to the VkVertexInputAttributeDescription#offset field.

selfback to summary
protected VkVertexInputAttributeDescription.Buffer self()

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

Annotations
@Override