Package org.lwjgl.vulkan

Class VkIndirectCommandsIndexBufferTokenEXT

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkIndirectCommandsIndexBufferTokenEXT>

org.lwjgl.vulkan.VkIndirectCommandsIndexBufferTokenEXT

All Implemented Interfaces:

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

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

Structure specifying layout token info for a single index buffer command token.

Description

This allows for easy layering of Vulkan atop other APIs. When INDIRECT_COMMANDS_INPUT_MODE_DXGI_INDEX_BUFFER_EXT is specified, the indirect buffer can contain a D3D12_INDEX_BUFFER_VIEW instead of VkBindIndexBufferIndirectCommandEXT as D3D’s DXGI format value is mapped to the VkIndexType. It works as both structs are otherwise binary compatible.

Valid Usage

• mode must be non-zero
• mode must be one of the bits supported in VkPhysicalDeviceDeviceGeneratedCommandsPropertiesEXT::supportedIndirectCommandsInputModes

Valid Usage (Implicit)

• mode must be a valid VkIndirectCommandsInputModeFlagBitsEXT value

See Also

VkIndirectCommandsTokenDataEXT

Layout

 struct VkIndirectCommandsIndexBufferTokenEXT {
     VkIndirectCommandsInputModeFlagBitsEXT mode();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkIndirectCommandsIndexBufferTokenEXT.Buffer	An array of VkIndirectCommandsIndexBufferTokenEXT 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	MODE	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
VkIndirectCommandsIndexBufferTokenEXT(ByteBuffer container)	Creates a VkIndirectCommandsIndexBufferTokenEXT instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static VkIndirectCommandsIndexBufferTokenEXT	calloc()	Returns a new VkIndirectCommandsIndexBufferTokenEXT instance allocated with memCalloc.
static VkIndirectCommandsIndexBufferTokenEXT.Buffer	calloc(int capacity)	Returns a new VkIndirectCommandsIndexBufferTokenEXT.Buffer instance allocated with memCalloc.
static VkIndirectCommandsIndexBufferTokenEXT.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkIndirectCommandsIndexBufferTokenEXT.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkIndirectCommandsIndexBufferTokenEXT	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkIndirectCommandsIndexBufferTokenEXT instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkIndirectCommandsIndexBufferTokenEXT	create()	Returns a new VkIndirectCommandsIndexBufferTokenEXT instance allocated with BufferUtils.
static VkIndirectCommandsIndexBufferTokenEXT.Buffer	create(int capacity)	Returns a new VkIndirectCommandsIndexBufferTokenEXT.Buffer instance allocated with BufferUtils.
static VkIndirectCommandsIndexBufferTokenEXT	create(long address)	Returns a new VkIndirectCommandsIndexBufferTokenEXT instance for the specified memory address.
static VkIndirectCommandsIndexBufferTokenEXT.Buffer	create(long address, int capacity)	Create a VkIndirectCommandsIndexBufferTokenEXT.Buffer instance at the specified memory.
static @Nullable VkIndirectCommandsIndexBufferTokenEXT	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkIndirectCommandsIndexBufferTokenEXT.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static VkIndirectCommandsIndexBufferTokenEXT	malloc()	Returns a new VkIndirectCommandsIndexBufferTokenEXT instance allocated with memAlloc.
static VkIndirectCommandsIndexBufferTokenEXT.Buffer	malloc(int capacity)	Returns a new VkIndirectCommandsIndexBufferTokenEXT.Buffer instance allocated with memAlloc.
static VkIndirectCommandsIndexBufferTokenEXT.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkIndirectCommandsIndexBufferTokenEXT.Buffer instance allocated on the specified MemoryStack.
static VkIndirectCommandsIndexBufferTokenEXT	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkIndirectCommandsIndexBufferTokenEXT instance allocated on the specified MemoryStack.
int	mode()	specifies the mode to use with this token.
VkIndirectCommandsIndexBufferTokenEXT	mode(int value)	Sets the specified value to the mode() field.
static int	nmode(long struct)	Unsafe version of mode().
static void	nmode(long struct, int value)	Unsafe version of mode.
VkIndirectCommandsIndexBufferTokenEXT	set(VkIndirectCommandsIndexBufferTokenEXT 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.

MODE

public static final int MODE

The struct member offsets.

Constructor Details

VkIndirectCommandsIndexBufferTokenEXT

public VkIndirectCommandsIndexBufferTokenEXT(ByteBuffer container)

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

mode

public int mode()

specifies the mode to use with this token.

mode

public VkIndirectCommandsIndexBufferTokenEXT mode(int value)

Sets the specified value to the mode() field.

set

public VkIndirectCommandsIndexBufferTokenEXT set(VkIndirectCommandsIndexBufferTokenEXT src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkIndirectCommandsIndexBufferTokenEXT malloc()

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

calloc

public static VkIndirectCommandsIndexBufferTokenEXT calloc()

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

create

public static VkIndirectCommandsIndexBufferTokenEXT create()

Returns a new VkIndirectCommandsIndexBufferTokenEXT instance allocated with BufferUtils.

create

public static VkIndirectCommandsIndexBufferTokenEXT create(long address)

Returns a new VkIndirectCommandsIndexBufferTokenEXT instance for the specified memory address.

createSafe

public static @Nullable VkIndirectCommandsIndexBufferTokenEXT createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkIndirectCommandsIndexBufferTokenEXT.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkIndirectCommandsIndexBufferTokenEXT.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkIndirectCommandsIndexBufferTokenEXT.Buffer create(int capacity)

Returns a new VkIndirectCommandsIndexBufferTokenEXT.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkIndirectCommandsIndexBufferTokenEXT.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new VkIndirectCommandsIndexBufferTokenEXT instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nmode

public static int nmode(long struct)

Unsafe version of mode().

nmode

public static void nmode(long struct,
 int value)

Unsafe version of mode.