Package org.lwjgl.vulkan

Class VkVertexInputAttributeDescription

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkVertexInputAttributeDescription>

org.lwjgl.vulkan.VkVertexInputAttributeDescription

All Implemented Interfaces:

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

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

Structure specifying vertex input attribute description.

Valid Usage

• location must be less than VkPhysicalDeviceLimits::maxVertexInputAttributes
• binding must be less than VkPhysicalDeviceLimits::maxVertexInputBindings
• offset must be less than or equal to VkPhysicalDeviceLimits::maxVertexInputAttributeOffset
• The format features of format must contain FORMAT_FEATURE_VERTEX_BUFFER_BIT
• If the VK_KHR_portability_subset extension is enabled, and VkPhysicalDevicePortabilitySubsetFeaturesKHR::vertexAttributeAccessBeyondStride is FALSE, the sum of offset plus the size of the vertex attribute data described by format must not be greater than stride in the VkVertexInputBindingDescription referenced in binding

Valid Usage (Implicit)

• format must be a valid VkFormat value

See Also

VkPipelineVertexInputStateCreateInfo

Layout

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkVertexInputAttributeDescription.Buffer	An array of VkVertexInputAttributeDescription 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	FORMAT	The struct member offsets.
static final int	LOCATION	The struct member offsets.
static final int	OFFSET	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
VkVertexInputAttributeDescription(ByteBuffer container)	Creates a VkVertexInputAttributeDescription instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
int	binding()	the binding number which this attribute takes its data from.
VkVertexInputAttributeDescription	binding(int value)	Sets the specified value to the binding() field.
static VkVertexInputAttributeDescription	calloc()	Returns a new VkVertexInputAttributeDescription instance allocated with memCalloc.
static VkVertexInputAttributeDescription.Buffer	calloc(int capacity)	Returns a new VkVertexInputAttributeDescription.Buffer instance allocated with memCalloc.
static VkVertexInputAttributeDescription.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkVertexInputAttributeDescription.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkVertexInputAttributeDescription	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkVertexInputAttributeDescription instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkVertexInputAttributeDescription	callocStack()	Deprecated.
static VkVertexInputAttributeDescription.Buffer	callocStack(int capacity)	Deprecated.
static VkVertexInputAttributeDescription.Buffer	callocStack(int capacity, org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkVertexInputAttributeDescription	callocStack(org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkVertexInputAttributeDescription	create()	Returns a new VkVertexInputAttributeDescription instance allocated with BufferUtils.
static VkVertexInputAttributeDescription.Buffer	create(int capacity)	Returns a new VkVertexInputAttributeDescription.Buffer instance allocated with BufferUtils.
static VkVertexInputAttributeDescription	create(long address)	Returns a new VkVertexInputAttributeDescription instance for the specified memory address.
static VkVertexInputAttributeDescription.Buffer	create(long address, int capacity)	Create a VkVertexInputAttributeDescription.Buffer instance at the specified memory.
static @Nullable VkVertexInputAttributeDescription	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkVertexInputAttributeDescription.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
int	format()	the size and type of the vertex attribute data.
VkVertexInputAttributeDescription	format(int value)	Sets the specified value to the format() field.
int	location()	the shader input location number for this attribute.
VkVertexInputAttributeDescription	location(int value)	Sets the specified value to the location() field.
static VkVertexInputAttributeDescription	malloc()	Returns a new VkVertexInputAttributeDescription instance allocated with memAlloc.
static VkVertexInputAttributeDescription.Buffer	malloc(int capacity)	Returns a new VkVertexInputAttributeDescription.Buffer instance allocated with memAlloc.
static VkVertexInputAttributeDescription.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkVertexInputAttributeDescription.Buffer instance allocated on the specified MemoryStack.
static VkVertexInputAttributeDescription	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkVertexInputAttributeDescription instance allocated on the specified MemoryStack.
static VkVertexInputAttributeDescription	mallocStack()	Deprecated.
static VkVertexInputAttributeDescription.Buffer	mallocStack(int capacity)	Deprecated.
static VkVertexInputAttributeDescription.Buffer	mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkVertexInputAttributeDescription	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	nformat(long struct)	Unsafe version of format().
static void	nformat(long struct, int value)	Unsafe version of format.
static int	nlocation(long struct)	Unsafe version of location().
static void	nlocation(long struct, int value)	Unsafe version of location.
static int	noffset(long struct)	Unsafe version of offset().
static void	noffset(long struct, int value)	Unsafe version of offset.
int	offset()	a byte offset of this attribute relative to the start of an element in the vertex input binding.
VkVertexInputAttributeDescription	offset(int value)	Sets the specified value to the offset() field.
VkVertexInputAttributeDescription	set(int location, int binding, int format, int offset)	Initializes this struct with the specified values.
VkVertexInputAttributeDescription	set(VkVertexInputAttributeDescription 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.

LOCATION

public static final int LOCATION

The struct member offsets.

BINDING

public static final int BINDING

The struct member offsets.

FORMAT

public static final int FORMAT

The struct member offsets.

OFFSET

public static final int OFFSET

The struct member offsets.

Constructor Details

VkVertexInputAttributeDescription

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 Details

sizeof

public int sizeof()

Specified by:

sizeof in class org.lwjgl.system.Struct<VkVertexInputAttributeDescription>

location

public int location()

the shader input location number for this attribute.

binding

public int binding()

the binding number which this attribute takes its data from.

format

public int format()

the size and type of the vertex attribute data.

offset

public int offset()

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

location

public VkVertexInputAttributeDescription location(int value)

Sets the specified value to the location() field.

binding

public VkVertexInputAttributeDescription binding(int value)

Sets the specified value to the binding() field.

format

public VkVertexInputAttributeDescription format(int value)

Sets the specified value to the format() field.

offset

public VkVertexInputAttributeDescription offset(int value)

Sets the specified value to the offset() field.

set

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

Initializes this struct with the specified values.

set

public VkVertexInputAttributeDescription set(VkVertexInputAttributeDescription src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkVertexInputAttributeDescription malloc()

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

calloc

public static VkVertexInputAttributeDescription calloc()

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

create

public static VkVertexInputAttributeDescription create()

Returns a new VkVertexInputAttributeDescription instance allocated with BufferUtils.

create

public static VkVertexInputAttributeDescription create(long address)

Returns a new VkVertexInputAttributeDescription instance for the specified memory address.

createSafe

public static @Nullable VkVertexInputAttributeDescription createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkVertexInputAttributeDescription.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkVertexInputAttributeDescription.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkVertexInputAttributeDescription.Buffer create(int capacity)

Returns a new VkVertexInputAttributeDescription.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkVertexInputAttributeDescription.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

mallocStack

@Deprecated
public static VkVertexInputAttributeDescription mallocStack()

Deprecated.

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

callocStack

@Deprecated
public static VkVertexInputAttributeDescription callocStack()

Deprecated.

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

mallocStack

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

Deprecated.

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

callocStack

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

Deprecated.

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

mallocStack

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

Deprecated.

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

callocStack

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

Deprecated.

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

mallocStack

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

Returns a new VkVertexInputAttributeDescription instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nlocation

public static int nlocation(long struct)

Unsafe version of location().

nbinding

public static int nbinding(long struct)

Unsafe version of binding().

nformat

public static int nformat(long struct)

Unsafe version of format().

noffset

public static int noffset(long struct)

Unsafe version of offset().

nlocation

public static void nlocation(long struct,
 int value)

Unsafe version of location.

nbinding

public static void nbinding(long struct,
 int value)

Unsafe version of binding.

nformat

public static void nformat(long struct,
 int value)

Unsafe version of format.

noffset

public static void noffset(long struct,
 int value)

Unsafe version of offset.