Package org.lwjgl.vulkan

Class VkBindIndexBufferIndirectCommandNV

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkBindIndexBufferIndirectCommandNV>

org.lwjgl.vulkan.VkBindIndexBufferIndirectCommandNV

All Implemented Interfaces:

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

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

Structure specifying input data for a single index buffer command token.

Valid Usage

• The buffer’s usage flag from which the address was acquired must have the BUFFER_USAGE_INDEX_BUFFER_BIT bit set
• The bufferAddress must be aligned to the indexType used
• Each element of the buffer from which the address was acquired and that is non-sparse must be bound completely and contiguously to a single VkDeviceMemory object

Valid Usage (Implicit)

• indexType must be a valid VkIndexType value

Layout

 struct VkBindIndexBufferIndirectCommandNV {
     VkDeviceAddress bufferAddress();
     uint32_t size();
     VkIndexType indexType();
 }

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
long	bufferAddress()	specifies a physical address of the VkBuffer used as index buffer.
VkBindIndexBufferIndirectCommandNV	bufferAddress(long value)	Sets the specified value to the bufferAddress() field.
static VkBindIndexBufferIndirectCommandNV	calloc()	Returns a new VkBindIndexBufferIndirectCommandNV instance allocated with memCalloc.
static VkBindIndexBufferIndirectCommandNV.Buffer	calloc(int capacity)	Returns a new VkBindIndexBufferIndirectCommandNV.Buffer instance allocated with memCalloc.
static VkBindIndexBufferIndirectCommandNV.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkBindIndexBufferIndirectCommandNV.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkBindIndexBufferIndirectCommandNV	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkBindIndexBufferIndirectCommandNV instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkBindIndexBufferIndirectCommandNV	create()	Returns a new VkBindIndexBufferIndirectCommandNV instance allocated with BufferUtils.
static VkBindIndexBufferIndirectCommandNV.Buffer	create(int capacity)	Returns a new VkBindIndexBufferIndirectCommandNV.Buffer instance allocated with BufferUtils.
static VkBindIndexBufferIndirectCommandNV	create(long address)	Returns a new VkBindIndexBufferIndirectCommandNV instance for the specified memory address.
static VkBindIndexBufferIndirectCommandNV.Buffer	create(long address, int capacity)	Create a VkBindIndexBufferIndirectCommandNV.Buffer instance at the specified memory.
static @Nullable VkBindIndexBufferIndirectCommandNV	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkBindIndexBufferIndirectCommandNV.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
int	indexType()	a VkIndexType value specifying how indices are treated.
VkBindIndexBufferIndirectCommandNV	indexType(int value)	Sets the specified value to the indexType() field.
static VkBindIndexBufferIndirectCommandNV	malloc()	Returns a new VkBindIndexBufferIndirectCommandNV instance allocated with memAlloc.
static VkBindIndexBufferIndirectCommandNV.Buffer	malloc(int capacity)	Returns a new VkBindIndexBufferIndirectCommandNV.Buffer instance allocated with memAlloc.
static VkBindIndexBufferIndirectCommandNV.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkBindIndexBufferIndirectCommandNV.Buffer instance allocated on the specified MemoryStack.
static VkBindIndexBufferIndirectCommandNV	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkBindIndexBufferIndirectCommandNV instance allocated on the specified MemoryStack.
static long	nbufferAddress(long struct)	Unsafe version of bufferAddress().
static void	nbufferAddress(long struct, long value)	Unsafe version of bufferAddress.
static int	nindexType(long struct)	Unsafe version of indexType().
static void	nindexType(long struct, int value)	Unsafe version of indexType.
static int	nsize(long struct)	Unsafe version of size().
static void	nsize(long struct, int value)	Unsafe version of size.
VkBindIndexBufferIndirectCommandNV	set(long bufferAddress, int size, int indexType)	Initializes this struct with the specified values.
VkBindIndexBufferIndirectCommandNV	set(VkBindIndexBufferIndirectCommandNV src)	Copies the specified struct data to this struct.
int	size()	the byte size range which is available for this operation from the provided address.
VkBindIndexBufferIndirectCommandNV	size(int value)	Sets the specified value to the size() field.
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.

BUFFERADDRESS

public static final int BUFFERADDRESS

The struct member offsets.

SIZE

public static final int SIZE

The struct member offsets.

INDEXTYPE

public static final int INDEXTYPE

The struct member offsets.

Constructor Details

VkBindIndexBufferIndirectCommandNV

public VkBindIndexBufferIndirectCommandNV(ByteBuffer container)

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

bufferAddress

public long bufferAddress()

specifies a physical address of the VkBuffer used as index buffer.

size

public int size()

the byte size range which is available for this operation from the provided address.

indexType

public int indexType()

a VkIndexType value specifying how indices are treated. Instead of the Vulkan enum values, a custom uint32_t value can be mapped to VkIndexType by specifying the VkIndirectCommandsLayoutTokenNV::pIndexTypes and VkIndirectCommandsLayoutTokenNV::pIndexTypeValues arrays.

bufferAddress

public VkBindIndexBufferIndirectCommandNV bufferAddress(long value)

Sets the specified value to the bufferAddress() field.

size

public VkBindIndexBufferIndirectCommandNV size(int value)

Sets the specified value to the size() field.

indexType

public VkBindIndexBufferIndirectCommandNV indexType(int value)

Sets the specified value to the indexType() field.

set

public VkBindIndexBufferIndirectCommandNV set(long bufferAddress,
 int size,
 int indexType)

Initializes this struct with the specified values.

set

public VkBindIndexBufferIndirectCommandNV set(VkBindIndexBufferIndirectCommandNV src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkBindIndexBufferIndirectCommandNV malloc()

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

calloc

public static VkBindIndexBufferIndirectCommandNV calloc()

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

create

public static VkBindIndexBufferIndirectCommandNV create()

Returns a new VkBindIndexBufferIndirectCommandNV instance allocated with BufferUtils.

create

public static VkBindIndexBufferIndirectCommandNV create(long address)

Returns a new VkBindIndexBufferIndirectCommandNV instance for the specified memory address.

createSafe

public static @Nullable VkBindIndexBufferIndirectCommandNV createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkBindIndexBufferIndirectCommandNV.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkBindIndexBufferIndirectCommandNV.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkBindIndexBufferIndirectCommandNV.Buffer create(int capacity)

Returns a new VkBindIndexBufferIndirectCommandNV.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkBindIndexBufferIndirectCommandNV.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new VkBindIndexBufferIndirectCommandNV instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nbufferAddress

public static long nbufferAddress(long struct)

Unsafe version of bufferAddress().

nsize

public static int nsize(long struct)

Unsafe version of size().

nindexType

public static int nindexType(long struct)

Unsafe version of indexType().

nbufferAddress

public static void nbufferAddress(long struct,
 long value)

Unsafe version of bufferAddress.

nsize

public static void nsize(long struct,
 int value)

Unsafe version of size.

nindexType

public static void nindexType(long struct,
 int value)

Unsafe version of indexType.