Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkBindIndexBufferIndirectCommandNV

extends Struct<VkBindIndexBufferIndirectCommandNV>
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 input data for a single index buffer command token.
Valid Usage
Valid Usage (Implicit)

Layout


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

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
BUFFERADDRESS

The struct member offsets.

public static final int
INDEXTYPE

The struct member offsets.

public static final int
SIZE

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

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

Method Summary

Modifier and TypeMethod and Description
public long
bufferAddress()

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

public VkBindIndexBufferIndirectCommandNV
bufferAddress(long value)

Sets the specified value to the bufferAddress field.

public static VkBindIndexBufferIndirectCommandNV
calloc()

Returns a new VkBindIndexBufferIndirectCommandNV instance allocated with memCalloc.

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

Returns a new VkBindIndexBufferIndirectCommandNV.Buffer instance allocated with memCalloc.

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

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

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

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

protected VkBindIndexBufferIndirectCommandNV
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 VkBindIndexBufferIndirectCommandNV
create()

Returns a new VkBindIndexBufferIndirectCommandNV instance allocated with BufferUtils.

public static VkBindIndexBufferIndirectCommandNV
create(long address)

Returns a new VkBindIndexBufferIndirectCommandNV instance for the specified memory address.

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

Returns a new VkBindIndexBufferIndirectCommandNV.Buffer instance allocated with BufferUtils.

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

Create a VkBindIndexBufferIndirectCommandNV.Buffer instance at the specified memory.

public static VkBindIndexBufferIndirectCommandNV
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public int
indexType()

a VkIndexType value specifying how indices are treated.

public VkBindIndexBufferIndirectCommandNV
indexType(int value)

Sets the specified value to the indexType field.

public static VkBindIndexBufferIndirectCommandNV
malloc()

Returns a new VkBindIndexBufferIndirectCommandNV instance allocated with memAlloc.

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

Returns a new VkBindIndexBufferIndirectCommandNV.Buffer instance allocated with memAlloc.

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

Returns a new VkBindIndexBufferIndirectCommandNV instance allocated on the specified MemoryStack.

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

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

public static long
nbufferAddress(long struct)

Unsafe version of bufferAddress.

public static void
nbufferAddress(long struct, long value)

Unsafe version of bufferAddress.

public static int
nindexType(long struct)

Unsafe version of indexType.

public static void
nindexType(long struct, int value)

Unsafe version of indexType.

public static int
nsize(long struct)

Unsafe version of size.

public static void
nsize(long struct, int value)

Unsafe version of size.

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

Initializes this struct with the specified values.

public VkBindIndexBufferIndirectCommandNV

Returns:

this struct
set
(VkBindIndexBufferIndirectCommandNV
the source struct
src
)

Copies the specified struct data to this struct.

public int
size()

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

public VkBindIndexBufferIndirectCommandNV
size(int value)

Sets the specified value to the size field.

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.

BUFFERADDRESSback to summary
public static final int BUFFERADDRESS

The struct member offsets.

INDEXTYPEback to summary
public static final int INDEXTYPE

The struct member offsets.

SIZEback to summary
public static final int SIZE

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

Constructor Detail

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

bufferAddressback to summary
public long bufferAddress()

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

Annotations
@NativeType:VkDeviceAddress
bufferAddressback to summary
public VkBindIndexBufferIndirectCommandNV bufferAddress(long value)

Sets the specified value to the bufferAddress field.

callocback to summary
public static VkBindIndexBufferIndirectCommandNV calloc()

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkBindIndexBufferIndirectCommandNV calloc(MemoryStack stack)

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

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

createback to summary
protected VkBindIndexBufferIndirectCommandNV 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 VkBindIndexBufferIndirectCommandNV create()

Returns a new VkBindIndexBufferIndirectCommandNV instance allocated with BufferUtils.

createback to summary
public static VkBindIndexBufferIndirectCommandNV create(long address)

Returns a new VkBindIndexBufferIndirectCommandNV instance for the specified memory address.

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

Returns a new VkBindIndexBufferIndirectCommandNV.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkBindIndexBufferIndirectCommandNV.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkBindIndexBufferIndirectCommandNV createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
indexTypeback to summary
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 an VkIndexType by specifying the VkIndirectCommandsLayoutTokenNV::pIndexTypes and VkIndirectCommandsLayoutTokenNV::pIndexTypeValues arrays.

Annotations
@NativeType:VkIndexType
indexTypeback to summary
public VkBindIndexBufferIndirectCommandNV indexType(int value)

Sets the specified value to the indexType field.

mallocback to summary
public static VkBindIndexBufferIndirectCommandNV malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkBindIndexBufferIndirectCommandNV malloc(MemoryStack stack)

Returns a new VkBindIndexBufferIndirectCommandNV instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

nbufferAddressback to summary
public static long nbufferAddress(long struct)

Unsafe version of bufferAddress.

nbufferAddressback to summary
public static void nbufferAddress(long struct, long value)

Unsafe version of bufferAddress.

nindexTypeback to summary
public static int nindexType(long struct)

Unsafe version of indexType.

nindexTypeback to summary
public static void nindexType(long struct, int value)

Unsafe version of indexType.

nsizeback to summary
public static int nsize(long struct)

Unsafe version of size.

nsizeback to summary
public static void nsize(long struct, int value)

Unsafe version of size.

setback to summary
public VkBindIndexBufferIndirectCommandNV set(long bufferAddress, int size, int indexType)

Initializes this struct with the specified values.

setback to summary
public VkBindIndexBufferIndirectCommandNV set(VkBindIndexBufferIndirectCommandNV src)

Copies the specified struct data to this struct.

Parameters
src:VkBindIndexBufferIndirectCommandNV

the source struct

Returns:VkBindIndexBufferIndirectCommandNV

this struct

sizeback to summary
public int size()

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

Annotations
@NativeType:uint32_t
sizeback to summary
public VkBindIndexBufferIndirectCommandNV size(int value)

Sets the specified value to the size field.

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

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

An array of VkBindIndexBufferIndirectCommandNV structs.

Field Summary

Modifier and TypeField and Description
private static final VkBindIndexBufferIndirectCommandNV

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkBindIndexBufferIndirectCommandNV.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 long
public VkBindIndexBufferIndirectCommandNV.Buffer
bufferAddress(long value)

Sets the specified value to the VkBindIndexBufferIndirectCommandNV#bufferAddress field.

protected VkBindIndexBufferIndirectCommandNV
public int

Returns:

the value of the VkBindIndexBufferIndirectCommandNV#indexType field.
indexType
()

public VkBindIndexBufferIndirectCommandNV.Buffer
indexType(int value)

Sets the specified value to the VkBindIndexBufferIndirectCommandNV#indexType field.

protected VkBindIndexBufferIndirectCommandNV.Buffer
public int

Returns:

the value of the VkBindIndexBufferIndirectCommandNV#size field.
size
()

public VkBindIndexBufferIndirectCommandNV.Buffer
size(int value)

Sets the specified value to the VkBindIndexBufferIndirectCommandNV#size field.

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkBindIndexBufferIndirectCommandNV ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

bufferAddressback to summary
public long bufferAddress()
Returns:long

the value of the VkBindIndexBufferIndirectCommandNV#bufferAddress field.

Annotations
@NativeType:VkDeviceAddress
bufferAddressback to summary
public VkBindIndexBufferIndirectCommandNV.Buffer bufferAddress(long value)

Sets the specified value to the VkBindIndexBufferIndirectCommandNV#bufferAddress field.

getElementFactoryback to summary
protected VkBindIndexBufferIndirectCommandNV getElementFactory()

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

Annotations
@Override
indexTypeback to summary
public int indexType()
Returns:int

the value of the VkBindIndexBufferIndirectCommandNV#indexType field.

Annotations
@NativeType:VkIndexType
indexTypeback to summary
public VkBindIndexBufferIndirectCommandNV.Buffer indexType(int value)

Sets the specified value to the VkBindIndexBufferIndirectCommandNV#indexType field.

selfback to summary
protected VkBindIndexBufferIndirectCommandNV.Buffer self()

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

Annotations
@Override
sizeback to summary
public int size()
Returns:int

the value of the VkBindIndexBufferIndirectCommandNV#size field.

Annotations
@NativeType:uint32_t
sizeback to summary
public VkBindIndexBufferIndirectCommandNV.Buffer size(int value)

Sets the specified value to the VkBindIndexBufferIndirectCommandNV#size field.