Package org.lwjgl.vulkan

Class VkIndirectCommandsLayoutTokenEXT

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkIndirectCommandsLayoutTokenEXT>

org.lwjgl.vulkan.VkIndirectCommandsLayoutTokenEXT

All Implemented Interfaces:

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

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

Struct specifying the details of an indirect command layout token.

Valid Usage

• offset must be less than or equal to VkPhysicalDeviceDeviceGeneratedCommandsPropertiesEXT::maxIndirectCommandsTokenOffset
• offset must be aligned to 4
• If meshShader or taskShader are not enabled, type must not be INDIRECT_COMMANDS_TOKEN_TYPE_DRAW_MESH_TASKS_EXT INDIRECT_COMMANDS_TOKEN_TYPE_DRAW_MESH_TASKS_COUNT_EXT, INDIRECT_COMMANDS_TOKEN_TYPE_DRAW_MESH_TASKS_NV_EXT or INDIRECT_COMMANDS_TOKEN_TYPE_DRAW_MESH_TASKS_COUNT_NV_EXT
• If the rayTracingMaintenance1 feature is not enabled, type must not be INDIRECT_COMMANDS_TOKEN_TYPE_TRACE_RAYS2_EXT
• If VkPhysicalDeviceDeviceGeneratedCommandsPropertiesEXT::deviceGeneratedCommandsMultiDrawIndirectCount is not supported, type must not be INDIRECT_COMMANDS_TOKEN_TYPE_DRAW_INDEXED_COUNT_EXT or INDIRECT_COMMANDS_TOKEN_TYPE_DRAW_COUNT_EXT
• If VkPhysicalDeviceDeviceGeneratedCommandsPropertiesEXT::deviceGeneratedCommandsMultiDrawIndirectCount is not supported, type must not be INDIRECT_COMMANDS_TOKEN_TYPE_DRAW_MESH_TASKS_COUNT_EXT
• If VkPhysicalDeviceDeviceGeneratedCommandsPropertiesEXT::deviceGeneratedCommandsMultiDrawIndirectCount is not supported, type must not be INDIRECT_COMMANDS_TOKEN_TYPE_DRAW_MESH_TASKS_COUNT_NV_EXT

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_INDIRECT_COMMANDS_LAYOUT_TOKEN_EXT
• type must be a valid VkIndirectCommandsTokenTypeEXT value
• If type is INDIRECT_COMMANDS_TOKEN_TYPE_PUSH_CONSTANT_EXT,VK_INDIRECT_COMMANDS_TOKEN_TYPE_SEQUENCE_INDEX_EXT, the pPushConstant member of data must be a valid pointer to a valid VkIndirectCommandsPushConstantTokenEXT structure
• If type is INDIRECT_COMMANDS_TOKEN_TYPE_VERTEX_BUFFER_EXT, the pVertexBuffer member of data must be a valid pointer to a valid VkIndirectCommandsVertexBufferTokenEXT structure
• If type is INDIRECT_COMMANDS_TOKEN_TYPE_INDEX_BUFFER_EXT, the pIndexBuffer member of data must be a valid pointer to a valid VkIndirectCommandsIndexBufferTokenEXT structure
• If type is INDIRECT_COMMANDS_TOKEN_TYPE_EXECUTION_SET_EXT, the pExecutionSet member of data must be a valid pointer to a valid VkIndirectCommandsExecutionSetTokenEXT structure

See Also

VkIndirectCommandsLayoutCreateInfoEXT, VkIndirectCommandsTokenDataEXT

Layout

 struct VkIndirectCommandsLayoutTokenEXT {
     VkStructureType sType();
     void const * pNext();
     VkIndirectCommandsTokenTypeEXT type();
     VkIndirectCommandsTokenDataEXT data();
     uint32_t offset();
 }

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static VkIndirectCommandsLayoutTokenEXT	calloc()	Returns a new VkIndirectCommandsLayoutTokenEXT instance allocated with memCalloc.
static VkIndirectCommandsLayoutTokenEXT.Buffer	calloc(int capacity)	Returns a new VkIndirectCommandsLayoutTokenEXT.Buffer instance allocated with memCalloc.
static VkIndirectCommandsLayoutTokenEXT.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkIndirectCommandsLayoutTokenEXT.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkIndirectCommandsLayoutTokenEXT	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkIndirectCommandsLayoutTokenEXT instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkIndirectCommandsLayoutTokenEXT	create()	Returns a new VkIndirectCommandsLayoutTokenEXT instance allocated with BufferUtils.
static VkIndirectCommandsLayoutTokenEXT.Buffer	create(int capacity)	Returns a new VkIndirectCommandsLayoutTokenEXT.Buffer instance allocated with BufferUtils.
static VkIndirectCommandsLayoutTokenEXT	create(long address)	Returns a new VkIndirectCommandsLayoutTokenEXT instance for the specified memory address.
static VkIndirectCommandsLayoutTokenEXT.Buffer	create(long address, int capacity)	Create a VkIndirectCommandsLayoutTokenEXT.Buffer instance at the specified memory.
static @Nullable VkIndirectCommandsLayoutTokenEXT	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkIndirectCommandsLayoutTokenEXT.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
VkIndirectCommandsTokenDataEXT	data()	specifies a VkIndirectCommandsTokenDataEXT containing token-specific details for command execution.
VkIndirectCommandsLayoutTokenEXT	data(Consumer<VkIndirectCommandsTokenDataEXT> consumer)	Passes the data() field to the specified Consumer.
VkIndirectCommandsLayoutTokenEXT	data(VkIndirectCommandsTokenDataEXT value)	Copies the specified VkIndirectCommandsTokenDataEXT to the data() field.
static VkIndirectCommandsLayoutTokenEXT	malloc()	Returns a new VkIndirectCommandsLayoutTokenEXT instance allocated with memAlloc.
static VkIndirectCommandsLayoutTokenEXT.Buffer	malloc(int capacity)	Returns a new VkIndirectCommandsLayoutTokenEXT.Buffer instance allocated with memAlloc.
static VkIndirectCommandsLayoutTokenEXT.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkIndirectCommandsLayoutTokenEXT.Buffer instance allocated on the specified MemoryStack.
static VkIndirectCommandsLayoutTokenEXT	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkIndirectCommandsLayoutTokenEXT instance allocated on the specified MemoryStack.
static VkIndirectCommandsTokenDataEXT	ndata(long struct)	Unsafe version of data().
static void	ndata(long struct, VkIndirectCommandsTokenDataEXT value)	Unsafe version of data.
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.
static int	ntype(long struct)	Unsafe version of type().
static void	ntype(long struct, int value)	Unsafe version of type.
int	offset()	the relative byte offset for the token within one sequence of the indirect buffer.
VkIndirectCommandsLayoutTokenEXT	offset(int value)	Sets the specified value to the offset() field.
long	pNext()	NULL or a pointer to a structure extending this structure.
VkIndirectCommandsLayoutTokenEXT	pNext(long value)	Sets the specified value to the pNext() field.
VkIndirectCommandsLayoutTokenEXT	set(int sType, long pNext, int type, VkIndirectCommandsTokenDataEXT data, int offset)	Initializes this struct with the specified values.
VkIndirectCommandsLayoutTokenEXT	set(VkIndirectCommandsLayoutTokenEXT src)	Copies the specified struct data to this struct.
int	sizeof()
int	sType()	a VkStructureType value identifying this structure.
VkIndirectCommandsLayoutTokenEXT	sType(int value)	Sets the specified value to the sType() field.
VkIndirectCommandsLayoutTokenEXT	sType$Default()	Sets the STRUCTURE_TYPE_INDIRECT_COMMANDS_LAYOUT_TOKEN_EXT value to the sType() field.
int	type()	specifies the VkIndirectCommandsTokenTypeEXT for data.
VkIndirectCommandsLayoutTokenEXT	type(int value)	Sets the specified value to the type() 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.

TYPE

public static final int TYPE

The struct member offsets.

DATA

public static final int DATA

The struct member offsets.

OFFSET

public static final int OFFSET

The struct member offsets.

Constructor Details

VkIndirectCommandsLayoutTokenEXT

public VkIndirectCommandsLayoutTokenEXT(ByteBuffer container)

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

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

type

public int type()

specifies the VkIndirectCommandsTokenTypeEXT for data.

data

public VkIndirectCommandsTokenDataEXT data()

specifies a VkIndirectCommandsTokenDataEXT containing token-specific details for command execution. It is ignored if type does not match any member of the VkIndirectCommandsTokenDataEXT union.

offset

public int offset()

the relative byte offset for the token within one sequence of the indirect buffer. The data stored at that offset is the command data for the token, e.g. VkDispatchIndirectCommand.

sType

public VkIndirectCommandsLayoutTokenEXT sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkIndirectCommandsLayoutTokenEXT sType$Default()

Sets the STRUCTURE_TYPE_INDIRECT_COMMANDS_LAYOUT_TOKEN_EXT value to the sType() field.

pNext

public VkIndirectCommandsLayoutTokenEXT pNext(long value)

Sets the specified value to the pNext() field.

type

public VkIndirectCommandsLayoutTokenEXT type(int value)

Sets the specified value to the type() field.

data

public VkIndirectCommandsLayoutTokenEXT data(VkIndirectCommandsTokenDataEXT value)

Copies the specified VkIndirectCommandsTokenDataEXT to the data() field.

data

public VkIndirectCommandsLayoutTokenEXT data(Consumer<VkIndirectCommandsTokenDataEXT> consumer)

Passes the data() field to the specified Consumer.

offset

public VkIndirectCommandsLayoutTokenEXT offset(int value)

Sets the specified value to the offset() field.

set

public VkIndirectCommandsLayoutTokenEXT set(int sType,
 long pNext,
 int type,
 VkIndirectCommandsTokenDataEXT data,
 int offset)

Initializes this struct with the specified values.

set

public VkIndirectCommandsLayoutTokenEXT set(VkIndirectCommandsLayoutTokenEXT src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkIndirectCommandsLayoutTokenEXT malloc()

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

calloc

public static VkIndirectCommandsLayoutTokenEXT calloc()

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

create

public static VkIndirectCommandsLayoutTokenEXT create()

Returns a new VkIndirectCommandsLayoutTokenEXT instance allocated with BufferUtils.

create

public static VkIndirectCommandsLayoutTokenEXT create(long address)

Returns a new VkIndirectCommandsLayoutTokenEXT instance for the specified memory address.

createSafe

public static @Nullable VkIndirectCommandsLayoutTokenEXT createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkIndirectCommandsLayoutTokenEXT.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkIndirectCommandsLayoutTokenEXT.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkIndirectCommandsLayoutTokenEXT.Buffer create(int capacity)

Returns a new VkIndirectCommandsLayoutTokenEXT.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkIndirectCommandsLayoutTokenEXT.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new VkIndirectCommandsLayoutTokenEXT instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

Returns a new VkIndirectCommandsLayoutTokenEXT.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().

ntype

public static int ntype(long struct)

Unsafe version of type().

ndata

public static VkIndirectCommandsTokenDataEXT ndata(long struct)

Unsafe version of data().

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.

ntype

public static void ntype(long struct,
 int value)

Unsafe version of type.

ndata

public static void ndata(long struct,
 VkIndirectCommandsTokenDataEXT value)

Unsafe version of data.

noffset

public static void noffset(long struct,
 int value)

Unsafe version of offset.