Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkDispatchGraphInfoAMDX

extends Struct<VkDispatchGraphInfoAMDX>
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 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
See Also

VkDeviceOrHostAddressConstAMDX, VkDispatchGraphCountInfoAMDX

Layout


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

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
NODEINDEX

The struct member offsets.

public static final int
PAYLOADCOUNT

The struct member offsets.

public static final int
PAYLOADS

The struct member offsets.

public static final int
PAYLOADSTRIDE

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
VkDispatchGraphInfoAMDX(long address, ByteBuffer container)

public
VkDispatchGraphInfoAMDX(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static VkDispatchGraphInfoAMDX
calloc()

Returns a new VkDispatchGraphInfoAMDX instance allocated with memCalloc.

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

Returns a new VkDispatchGraphInfoAMDX.Buffer instance allocated with memCalloc.

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

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

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

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

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

Returns a new VkDispatchGraphInfoAMDX instance allocated with BufferUtils.

public static VkDispatchGraphInfoAMDX
create(long address)

Returns a new VkDispatchGraphInfoAMDX instance for the specified memory address.

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

Returns a new VkDispatchGraphInfoAMDX.Buffer instance allocated with BufferUtils.

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

Create a VkDispatchGraphInfoAMDX.Buffer instance at the specified memory.

public static VkDispatchGraphInfoAMDX
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public static VkDispatchGraphInfoAMDX
malloc()

Returns a new VkDispatchGraphInfoAMDX instance allocated with memAlloc.

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

Returns a new VkDispatchGraphInfoAMDX.Buffer instance allocated with memAlloc.

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

Returns a new VkDispatchGraphInfoAMDX instance allocated on the specified MemoryStack.

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

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

public static int
nnodeIndex(long struct)

Unsafe version of nodeIndex.

public static void
nnodeIndex(long struct, int value)

Unsafe version of nodeIndex.

public int
nodeIndex()

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

public VkDispatchGraphInfoAMDX
nodeIndex(int value)

Sets the specified value to the nodeIndex field.

public static int
npayloadCount(long struct)

Unsafe version of payloadCount.

public static void
npayloadCount(long struct, int value)

Unsafe version of payloadCount.

public static VkDeviceOrHostAddressConstAMDX
npayloads(long struct)

Unsafe version of payloads.

public static void
npayloads(long struct, VkDeviceOrHostAddressConstAMDX value)

Unsafe version of payloads.

public static long
npayloadStride(long struct)

Unsafe version of payloadStride.

public static void
npayloadStride(long struct, long value)

Unsafe version of payloadStride.

public int
payloadCount()

the number of payloads to dispatch for the specified node.

public VkDispatchGraphInfoAMDX
payloadCount(int value)

Sets the specified value to the payloadCount field.

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

public VkDispatchGraphInfoAMDX
public VkDispatchGraphInfoAMDX
payloads(Consumer<VkDeviceOrHostAddressConstAMDX> consumer)

Passes the payloads field to the specified Consumer.

public long
payloadStride()

the byte stride between successive payloads in payloads

public VkDispatchGraphInfoAMDX
payloadStride(long value)

Sets the specified value to the payloadStride field.

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

Initializes this struct with the specified values.

public VkDispatchGraphInfoAMDX

Returns:

this struct
set
(VkDispatchGraphInfoAMDX
the source struct
src
)

Copies the specified struct data to this struct.

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.

NODEINDEXback to summary
public static final int NODEINDEX

The struct member offsets.

PAYLOADCOUNTback to summary
public static final int PAYLOADCOUNT

The struct member offsets.

PAYLOADSback to summary
public static final int PAYLOADS

The struct member offsets.

PAYLOADSTRIDEback to summary
public static final int PAYLOADSTRIDE

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

Constructor Detail

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

callocback to summary
public static VkDispatchGraphInfoAMDX calloc()

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkDispatchGraphInfoAMDX calloc(MemoryStack stack)

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

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

Returns a new VkDispatchGraphInfoAMDX instance allocated with BufferUtils.

createback to summary
public static VkDispatchGraphInfoAMDX create(long address)

Returns a new VkDispatchGraphInfoAMDX instance for the specified memory address.

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

Returns a new VkDispatchGraphInfoAMDX.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkDispatchGraphInfoAMDX.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkDispatchGraphInfoAMDX createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
mallocback to summary
public static VkDispatchGraphInfoAMDX malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkDispatchGraphInfoAMDX malloc(MemoryStack stack)

Returns a new VkDispatchGraphInfoAMDX instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

nnodeIndexback to summary
public static int nnodeIndex(long struct)

Unsafe version of nodeIndex.

nnodeIndexback to summary
public static void nnodeIndex(long struct, int value)

Unsafe version of nodeIndex.

nodeIndexback to summary
public int nodeIndex()

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

Annotations
@NativeType:uint32_t
nodeIndexback to summary
public VkDispatchGraphInfoAMDX nodeIndex(int value)

Sets the specified value to the nodeIndex field.

npayloadCountback to summary
public static int npayloadCount(long struct)

Unsafe version of payloadCount.

npayloadCountback to summary
public static void npayloadCount(long struct, int value)

Unsafe version of payloadCount.

npayloadsback to summary
public static VkDeviceOrHostAddressConstAMDX npayloads(long struct)

Unsafe version of payloads.

npayloadsback to summary
public static void npayloads(long struct, VkDeviceOrHostAddressConstAMDX value)

Unsafe version of payloads.

npayloadStrideback to summary
public static long npayloadStride(long struct)

Unsafe version of payloadStride.

npayloadStrideback to summary
public static void npayloadStride(long struct, long value)

Unsafe version of payloadStride.

payloadCountback to summary
public int payloadCount()

the number of payloads to dispatch for the specified node.

Annotations
@NativeType:uint32_t
payloadCountback to summary
public VkDispatchGraphInfoAMDX payloadCount(int value)

Sets the specified value to the payloadCount field.

payloadsback to summary
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

payloadsback to summary
public VkDispatchGraphInfoAMDX payloads(VkDeviceOrHostAddressConstAMDX value)

Copies the specified VkDeviceOrHostAddressConstAMDX to the payloads field.

payloadsback to summary
public VkDispatchGraphInfoAMDX payloads(Consumer<VkDeviceOrHostAddressConstAMDX> consumer)

Passes the payloads field to the specified Consumer.

payloadStrideback to summary
public long payloadStride()

the byte stride between successive payloads in payloads

Annotations
@NativeType:uint64_t
payloadStrideback to summary
public VkDispatchGraphInfoAMDX payloadStride(long value)

Sets the specified value to the payloadStride field.

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

Initializes this struct with the specified values.

setback to summary
public VkDispatchGraphInfoAMDX set(VkDispatchGraphInfoAMDX src)

Copies the specified struct data to this struct.

Parameters
src:VkDispatchGraphInfoAMDX

the source struct

Returns:VkDispatchGraphInfoAMDX

this struct

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

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

An array of VkDispatchGraphInfoAMDX structs.

Field Summary

Modifier and TypeField and Description
private static final VkDispatchGraphInfoAMDX

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkDispatchGraphInfoAMDX.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
protected VkDispatchGraphInfoAMDX
public int

Returns:

the value of the VkDispatchGraphInfoAMDX#nodeIndex field.
nodeIndex
()

public VkDispatchGraphInfoAMDX.Buffer
nodeIndex(int value)

Sets the specified value to the VkDispatchGraphInfoAMDX#nodeIndex field.

public int

Returns:

the value of the VkDispatchGraphInfoAMDX#payloadCount field.
payloadCount
()

public VkDispatchGraphInfoAMDX.Buffer
payloadCount(int value)

Sets the specified value to the VkDispatchGraphInfoAMDX#payloadCount field.

public VkDeviceOrHostAddressConstAMDX
public VkDispatchGraphInfoAMDX.Buffer
public VkDispatchGraphInfoAMDX.Buffer
public long

Returns:

the value of the VkDispatchGraphInfoAMDX#payloadStride field.
payloadStride
()

public VkDispatchGraphInfoAMDX.Buffer
payloadStride(long value)

Sets the specified value to the VkDispatchGraphInfoAMDX#payloadStride field.

protected VkDispatchGraphInfoAMDX.Buffer
Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkDispatchGraphInfoAMDX ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

getElementFactoryback to summary
protected VkDispatchGraphInfoAMDX getElementFactory()

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

Annotations
@Override
nodeIndexback to summary
public int nodeIndex()
Returns:int

the value of the VkDispatchGraphInfoAMDX#nodeIndex field.

Annotations
@NativeType:uint32_t
nodeIndexback to summary
public VkDispatchGraphInfoAMDX.Buffer nodeIndex(int value)

Sets the specified value to the VkDispatchGraphInfoAMDX#nodeIndex field.

payloadCountback to summary
public int payloadCount()
Returns:int

the value of the VkDispatchGraphInfoAMDX#payloadCount field.

Annotations
@NativeType:uint32_t
payloadCountback to summary
public VkDispatchGraphInfoAMDX.Buffer payloadCount(int value)

Sets the specified value to the VkDispatchGraphInfoAMDX#payloadCount field.

payloadsback to summary
public VkDeviceOrHostAddressConstAMDX payloads()
Returns:VkDeviceOrHostAddressConstAMDX

a VkDeviceOrHostAddressConstAMDX view of the VkDispatchGraphInfoAMDX#payloads field.

payloadsback to summary
public VkDispatchGraphInfoAMDX.Buffer payloads(VkDeviceOrHostAddressConstAMDX value)

Copies the specified VkDeviceOrHostAddressConstAMDX to the VkDispatchGraphInfoAMDX#payloads field.

payloadsback to summary
public VkDispatchGraphInfoAMDX.Buffer payloads(Consumer<VkDeviceOrHostAddressConstAMDX> consumer)

Passes the VkDispatchGraphInfoAMDX#payloads field to the specified Consumer.

payloadStrideback to summary
public long payloadStride()
Returns:long

the value of the VkDispatchGraphInfoAMDX#payloadStride field.

Annotations
@NativeType:uint64_t
payloadStrideback to summary
public VkDispatchGraphInfoAMDX.Buffer payloadStride(long value)

Sets the specified value to the VkDispatchGraphInfoAMDX#payloadStride field.

selfback to summary
protected VkDispatchGraphInfoAMDX.Buffer self()

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

Annotations
@Override