Package org.lwjgl.vulkan

Class VkVertexInputAttributeDescription2EXT

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkVertexInputAttributeDescription2EXT>

org.lwjgl.vulkan.VkVertexInputAttributeDescription2EXT

All Implemented Interfaces:

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

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

Structure specifying the extended 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 VkVertexInputBindingDescription2EXT referenced in binding

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_VERTEX_INPUT_ATTRIBUTE_DESCRIPTION_2_EXT
• format must be a valid VkFormat value

See Also

CmdSetVertexInputEXT

Layout

 struct VkVertexInputAttributeDescription2EXT {
     VkStructureType sType();
     void * pNext();
     uint32_t location();
     uint32_t binding();
     VkFormat format();
     uint32_t offset();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkVertexInputAttributeDescription2EXT.Buffer	An array of VkVertexInputAttributeDescription2EXT 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	PNEXT	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	STYPE	The struct member offsets.

Fields inherited from interface org.lwjgl.system.Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

Constructor	Description
VkVertexInputAttributeDescription2EXT(ByteBuffer container)	Creates a VkVertexInputAttributeDescription2EXT 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.
VkVertexInputAttributeDescription2EXT	binding(int value)	Sets the specified value to the binding() field.
static VkVertexInputAttributeDescription2EXT	calloc()	Returns a new VkVertexInputAttributeDescription2EXT instance allocated with memCalloc.
static VkVertexInputAttributeDescription2EXT.Buffer	calloc(int capacity)	Returns a new VkVertexInputAttributeDescription2EXT.Buffer instance allocated with memCalloc.
static VkVertexInputAttributeDescription2EXT.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkVertexInputAttributeDescription2EXT.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkVertexInputAttributeDescription2EXT	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkVertexInputAttributeDescription2EXT instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkVertexInputAttributeDescription2EXT	create()	Returns a new VkVertexInputAttributeDescription2EXT instance allocated with BufferUtils.
static VkVertexInputAttributeDescription2EXT.Buffer	create(int capacity)	Returns a new VkVertexInputAttributeDescription2EXT.Buffer instance allocated with BufferUtils.
static VkVertexInputAttributeDescription2EXT	create(long address)	Returns a new VkVertexInputAttributeDescription2EXT instance for the specified memory address.
static VkVertexInputAttributeDescription2EXT.Buffer	create(long address, int capacity)	Create a VkVertexInputAttributeDescription2EXT.Buffer instance at the specified memory.
static @Nullable VkVertexInputAttributeDescription2EXT	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkVertexInputAttributeDescription2EXT.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.
VkVertexInputAttributeDescription2EXT	format(int value)	Sets the specified value to the format() field.
int	location()	the shader input location number for this attribute.
VkVertexInputAttributeDescription2EXT	location(int value)	Sets the specified value to the location() field.
static VkVertexInputAttributeDescription2EXT	malloc()	Returns a new VkVertexInputAttributeDescription2EXT instance allocated with memAlloc.
static VkVertexInputAttributeDescription2EXT.Buffer	malloc(int capacity)	Returns a new VkVertexInputAttributeDescription2EXT.Buffer instance allocated with memAlloc.
static VkVertexInputAttributeDescription2EXT.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkVertexInputAttributeDescription2EXT.Buffer instance allocated on the specified MemoryStack.
static VkVertexInputAttributeDescription2EXT	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkVertexInputAttributeDescription2EXT instance allocated on the specified MemoryStack.
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.
static long	npNext(long struct)	Unsafe version of pNext().
static void	npNext(long struct, long value)	Unsafe version of pNext.
static int	nsType(long struct)	Unsafe version of sType().
static void	nsType(long struct, int value)	Unsafe version of sType.
int	offset()	a byte offset of this attribute relative to the start of an element in the vertex input binding.
VkVertexInputAttributeDescription2EXT	offset(int value)	Sets the specified value to the offset() field.
long	pNext()	NULL or a pointer to a structure extending this structure.
VkVertexInputAttributeDescription2EXT	pNext(long value)	Sets the specified value to the pNext() field.
VkVertexInputAttributeDescription2EXT	set(int sType, long pNext, int location, int binding, int format, int offset)	Initializes this struct with the specified values.
VkVertexInputAttributeDescription2EXT	set(VkVertexInputAttributeDescription2EXT src)	Copies the specified struct data to this struct.
int	sizeof()
int	sType()	a VkStructureType value identifying this structure.
VkVertexInputAttributeDescription2EXT	sType(int value)	Sets the specified value to the sType() field.
VkVertexInputAttributeDescription2EXT	sType$Default()	Sets the STRUCTURE_TYPE_VERTEX_INPUT_ATTRIBUTE_DESCRIPTION_2_EXT value to the sType() field.

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.

STYPE

public static final int STYPE

The struct member offsets.

PNEXT

public static final int PNEXT

The struct member offsets.

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

VkVertexInputAttributeDescription2EXT

public VkVertexInputAttributeDescription2EXT(ByteBuffer container)

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

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

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.

sType

public VkVertexInputAttributeDescription2EXT sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkVertexInputAttributeDescription2EXT sType$Default()

Sets the STRUCTURE_TYPE_VERTEX_INPUT_ATTRIBUTE_DESCRIPTION_2_EXT value to the sType() field.

pNext

public VkVertexInputAttributeDescription2EXT pNext(long value)

Sets the specified value to the pNext() field.

location

public VkVertexInputAttributeDescription2EXT location(int value)

Sets the specified value to the location() field.

binding

public VkVertexInputAttributeDescription2EXT binding(int value)

Sets the specified value to the binding() field.

format

public VkVertexInputAttributeDescription2EXT format(int value)

Sets the specified value to the format() field.

offset

public VkVertexInputAttributeDescription2EXT offset(int value)

Sets the specified value to the offset() field.

set

public VkVertexInputAttributeDescription2EXT set(int sType,
 long pNext,
 int location,
 int binding,
 int format,
 int offset)

Initializes this struct with the specified values.

set

public VkVertexInputAttributeDescription2EXT set(VkVertexInputAttributeDescription2EXT src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkVertexInputAttributeDescription2EXT malloc()

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

calloc

public static VkVertexInputAttributeDescription2EXT calloc()

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

create

public static VkVertexInputAttributeDescription2EXT create()

Returns a new VkVertexInputAttributeDescription2EXT instance allocated with BufferUtils.

create

public static VkVertexInputAttributeDescription2EXT create(long address)

Returns a new VkVertexInputAttributeDescription2EXT instance for the specified memory address.

createSafe

public static @Nullable VkVertexInputAttributeDescription2EXT createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkVertexInputAttributeDescription2EXT.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkVertexInputAttributeDescription2EXT.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkVertexInputAttributeDescription2EXT.Buffer create(int capacity)

Returns a new VkVertexInputAttributeDescription2EXT.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkVertexInputAttributeDescription2EXT.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

public static VkVertexInputAttributeDescription2EXT malloc(org.lwjgl.system.MemoryStack stack)

Returns a new VkVertexInputAttributeDescription2EXT instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nsType

public static int nsType(long struct)

Unsafe version of sType().

npNext

public static long npNext(long struct)

Unsafe version of pNext().

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

nsType

public static void nsType(long struct,
 int value)

Unsafe version of sType.

npNext

public static void npNext(long struct,
 long value)

Unsafe version of pNext.

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.