Package org.lwjgl.vulkan

Class VkDispatchGraphInfoAMDX

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkDispatchGraphInfoAMDX>

org.lwjgl.vulkan.VkDispatchGraphInfoAMDX

All Implemented Interfaces:

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

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

Structure specifying node parameters for execution graph dispatch.

Description

Whether payloads is consumed as a device or host pointer is defined by the command this structure is used in.

Valid Usage

• payloadCount must be no greater than maxExecutionGraphShaderPayloadCount

See Also

VkDeviceOrHostAddressConstAMDX, VkDispatchGraphCountInfoAMDX

Layout

 struct VkDispatchGraphInfoAMDX {
     uint32_t nodeIndex();
     uint32_t payloadCount();
     VkDeviceOrHostAddressConstAMDX payloads();
     uint64_t payloadStride();
 }

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static VkDispatchGraphInfoAMDX	calloc()	Returns a new VkDispatchGraphInfoAMDX instance allocated with memCalloc.
static VkDispatchGraphInfoAMDX.Buffer	calloc(int capacity)	Returns a new VkDispatchGraphInfoAMDX.Buffer instance allocated with memCalloc.
static VkDispatchGraphInfoAMDX.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkDispatchGraphInfoAMDX.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkDispatchGraphInfoAMDX	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkDispatchGraphInfoAMDX instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkDispatchGraphInfoAMDX	create()	Returns a new VkDispatchGraphInfoAMDX instance allocated with BufferUtils.
static VkDispatchGraphInfoAMDX.Buffer	create(int capacity)	Returns a new VkDispatchGraphInfoAMDX.Buffer instance allocated with BufferUtils.
static VkDispatchGraphInfoAMDX	create(long address)	Returns a new VkDispatchGraphInfoAMDX instance for the specified memory address.
static VkDispatchGraphInfoAMDX.Buffer	create(long address, int capacity)	Create a VkDispatchGraphInfoAMDX.Buffer instance at the specified memory.
static @Nullable VkDispatchGraphInfoAMDX	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkDispatchGraphInfoAMDX.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static VkDispatchGraphInfoAMDX	malloc()	Returns a new VkDispatchGraphInfoAMDX instance allocated with memAlloc.
static VkDispatchGraphInfoAMDX.Buffer	malloc(int capacity)	Returns a new VkDispatchGraphInfoAMDX.Buffer instance allocated with memAlloc.
static VkDispatchGraphInfoAMDX.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkDispatchGraphInfoAMDX.Buffer instance allocated on the specified MemoryStack.
static VkDispatchGraphInfoAMDX	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkDispatchGraphInfoAMDX instance allocated on the specified MemoryStack.
static int	nnodeIndex(long struct)	Unsafe version of nodeIndex().
static void	nnodeIndex(long struct, int value)	Unsafe version of nodeIndex.
int	nodeIndex()	the index of a node in an execution graph to be dispatched.
VkDispatchGraphInfoAMDX	nodeIndex(int value)	Sets the specified value to the nodeIndex() field.
static int	npayloadCount(long struct)	Unsafe version of payloadCount().
static void	npayloadCount(long struct, int value)	Unsafe version of payloadCount.
static VkDeviceOrHostAddressConstAMDX	npayloads(long struct)	Unsafe version of payloads().
static void	npayloads(long struct, VkDeviceOrHostAddressConstAMDX value)	Unsafe version of payloads.
static long	npayloadStride(long struct)	Unsafe version of payloadStride().
static void	npayloadStride(long struct, long value)	Unsafe version of payloadStride.
int	payloadCount()	the number of payloads to dispatch for the specified node.
VkDispatchGraphInfoAMDX	payloadCount(int value)	Sets the specified value to the payloadCount() field.
VkDeviceOrHostAddressConstAMDX	payloads()	a device or host address pointer to a flat array of payloads with size equal to the product of payloadCount and payloadStride
VkDispatchGraphInfoAMDX	payloads(Consumer<VkDeviceOrHostAddressConstAMDX> consumer)	Passes the payloads() field to the specified Consumer.
VkDispatchGraphInfoAMDX	payloads(VkDeviceOrHostAddressConstAMDX value)	Copies the specified VkDeviceOrHostAddressConstAMDX to the payloads() field.
long	payloadStride()	the byte stride between successive payloads in payloads
VkDispatchGraphInfoAMDX	payloadStride(long value)	Sets the specified value to the payloadStride() field.
VkDispatchGraphInfoAMDX	set(int nodeIndex, int payloadCount, VkDeviceOrHostAddressConstAMDX payloads, long payloadStride)	Initializes this struct with the specified values.
VkDispatchGraphInfoAMDX	set(VkDispatchGraphInfoAMDX 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.

NODEINDEX

public static final int NODEINDEX

The struct member offsets.

PAYLOADCOUNT

public static final int PAYLOADCOUNT

The struct member offsets.

PAYLOADS

public static final int PAYLOADS

The struct member offsets.

PAYLOADSTRIDE

public static final int PAYLOADSTRIDE

The struct member offsets.

Constructor Details

VkDispatchGraphInfoAMDX

public VkDispatchGraphInfoAMDX(ByteBuffer container)

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

nodeIndex

public int nodeIndex()

the index of a node in an execution graph to be dispatched.

payloadCount

public int payloadCount()

the number of payloads to dispatch for the specified node.

payloads

public VkDeviceOrHostAddressConstAMDX payloads()

a device or host address pointer to a flat array of payloads with size equal to the product of payloadCount and payloadStride

payloadStride

public long payloadStride()

the byte stride between successive payloads in payloads

nodeIndex

public VkDispatchGraphInfoAMDX nodeIndex(int value)

Sets the specified value to the nodeIndex() field.

payloadCount

public VkDispatchGraphInfoAMDX payloadCount(int value)

Sets the specified value to the payloadCount() field.

payloads

public VkDispatchGraphInfoAMDX payloads(VkDeviceOrHostAddressConstAMDX value)

Copies the specified VkDeviceOrHostAddressConstAMDX to the payloads() field.

payloads

public VkDispatchGraphInfoAMDX payloads(Consumer<VkDeviceOrHostAddressConstAMDX> consumer)

Passes the payloads() field to the specified Consumer.

payloadStride

public VkDispatchGraphInfoAMDX payloadStride(long value)

Sets the specified value to the payloadStride() field.

set

public VkDispatchGraphInfoAMDX set(int nodeIndex,
 int payloadCount,
 VkDeviceOrHostAddressConstAMDX payloads,
 long payloadStride)

Initializes this struct with the specified values.

set

public VkDispatchGraphInfoAMDX set(VkDispatchGraphInfoAMDX src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkDispatchGraphInfoAMDX malloc()

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

calloc

public static VkDispatchGraphInfoAMDX calloc()

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

create

public static VkDispatchGraphInfoAMDX create()

Returns a new VkDispatchGraphInfoAMDX instance allocated with BufferUtils.

create

public static VkDispatchGraphInfoAMDX create(long address)

Returns a new VkDispatchGraphInfoAMDX instance for the specified memory address.

createSafe

public static @Nullable VkDispatchGraphInfoAMDX createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkDispatchGraphInfoAMDX.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkDispatchGraphInfoAMDX.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkDispatchGraphInfoAMDX.Buffer create(int capacity)

Returns a new VkDispatchGraphInfoAMDX.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkDispatchGraphInfoAMDX.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new VkDispatchGraphInfoAMDX instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nnodeIndex

public static int nnodeIndex(long struct)

Unsafe version of nodeIndex().

npayloadCount

public static int npayloadCount(long struct)

Unsafe version of payloadCount().

npayloads

public static VkDeviceOrHostAddressConstAMDX npayloads(long struct)

Unsafe version of payloads().

npayloadStride

public static long npayloadStride(long struct)

Unsafe version of payloadStride().

nnodeIndex

public static void nnodeIndex(long struct,
 int value)

Unsafe version of nodeIndex.

npayloadCount

public static void npayloadCount(long struct,
 int value)

Unsafe version of payloadCount.

npayloads

public static void npayloads(long struct,
 VkDeviceOrHostAddressConstAMDX value)

Unsafe version of payloads.

npayloadStride

public static void npayloadStride(long struct,
 long value)

Unsafe version of payloadStride.