Record Class VkDispatchGraphInfoAMDX

java.lang.Object

java.lang.Record

club.doki7.vulkan.datatype.VkDispatchGraphInfoAMDX

All Implemented Interfaces:

IPointer, IVkDispatchGraphInfoAMDX

@ValueBasedCandidate
@UnsafeConstructor
public record VkDispatchGraphInfoAMDX(@NotNull MemorySegment segment)
extends Record
implements IVkDispatchGraphInfoAMDX

Represents a pointer to a VkDispatchGraphInfoAMDX structure in native memory.

Structure

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

Contracts

The property segment() should always be not-null (segment != NULL && !segment.equals(MemorySegment.NULL)), and properly aligned to LAYOUT.byteAlignment() bytes. To represent null pointer, you may use a Java null instead. See the documentation of IPointer.segment() for more details.

The constructor of this class is marked as UnsafeConstructor, because it does not perform any runtime check. The constructor can be useful for automatic code generators.

See Also:

• VkDispatchGraphInfoAMDX

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	VkDispatchGraphInfoAMDX.Ptr	Represents a pointer to / an array of VkDispatchGraphInfoAMDX structure(s) in native memory.

Field Summary

Fields

Modifier and Type	Field	Description
static final long	BYTES
static final StructLayout	LAYOUT
static final ValueLayout.OfInt	LAYOUT$nodeIndex
static final ValueLayout.OfInt	LAYOUT$payloadCount
static final UnionLayout	LAYOUT$payloads
static final ValueLayout.OfLong	LAYOUT$payloadStride
static final long	OFFSET$nodeIndex
static final long	OFFSET$payloadCount
static final long	OFFSET$payloads
static final long	OFFSET$payloadStride
static final MemoryLayout.PathElement	PATH$nodeIndex
static final MemoryLayout.PathElement	PATH$payloadCount
static final MemoryLayout.PathElement	PATH$payloads
static final MemoryLayout.PathElement	PATH$payloadStride
static final long	SIZE$nodeIndex
static final long	SIZE$payloadCount
static final long	SIZE$payloads
static final long	SIZE$payloadStride

Constructor Summary

Constructors

Constructor	Description
VkDispatchGraphInfoAMDX(@NotNull MemorySegment segment)	Creates an instance of a VkDispatchGraphInfoAMDX record class.

Method Summary

Modifier and Type	Method	Description
static VkDispatchGraphInfoAMDX	allocate(Arena arena)
static VkDispatchGraphInfoAMDX.Ptr	allocate(Arena arena, long count)
static VkDispatchGraphInfoAMDX	clone(Arena arena, VkDispatchGraphInfoAMDX src)
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
int	nodeIndex()
VkDispatchGraphInfoAMDX	nodeIndex(int value)
int	payloadCount()
VkDispatchGraphInfoAMDX	payloadCount(int value)
@NotNull VkDeviceOrHostAddressConstAMDX	payloads()
VkDispatchGraphInfoAMDX	payloads(@NotNull VkDeviceOrHostAddressConstAMDX value)
VkDispatchGraphInfoAMDX	payloads(Consumer<@NotNull VkDeviceOrHostAddressConstAMDX> consumer)
long	payloadStride()
VkDispatchGraphInfoAMDX	payloadStride(long value)
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

LAYOUT

public static final StructLayout LAYOUT

BYTES

public static final long BYTES

PATH$nodeIndex

public static final MemoryLayout.PathElement PATH$nodeIndex

PATH$payloadCount

public static final MemoryLayout.PathElement PATH$payloadCount

PATH$payloads

public static final MemoryLayout.PathElement PATH$payloads

PATH$payloadStride

public static final MemoryLayout.PathElement PATH$payloadStride

LAYOUT$nodeIndex

public static final ValueLayout.OfInt LAYOUT$nodeIndex

LAYOUT$payloadCount

public static final ValueLayout.OfInt LAYOUT$payloadCount

LAYOUT$payloads

public static final UnionLayout LAYOUT$payloads

LAYOUT$payloadStride

public static final ValueLayout.OfLong LAYOUT$payloadStride

SIZE$nodeIndex

public static final long SIZE$nodeIndex

SIZE$payloadCount

public static final long SIZE$payloadCount

SIZE$payloads

public static final long SIZE$payloads

SIZE$payloadStride

public static final long SIZE$payloadStride

OFFSET$nodeIndex

public static final long OFFSET$nodeIndex

OFFSET$payloadCount

public static final long OFFSET$payloadCount

OFFSET$payloads

public static final long OFFSET$payloads

OFFSET$payloadStride

public static final long OFFSET$payloadStride

Constructor Details

VkDispatchGraphInfoAMDX

public VkDispatchGraphInfoAMDX(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a VkDispatchGraphInfoAMDX record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static VkDispatchGraphInfoAMDX allocate(Arena arena)

allocate

public static VkDispatchGraphInfoAMDX.Ptr allocate(Arena arena,
 long count)

clone

public static VkDispatchGraphInfoAMDX clone(Arena arena,
 VkDispatchGraphInfoAMDX src)

nodeIndex

@Unsigned
public int nodeIndex()

nodeIndex

public VkDispatchGraphInfoAMDX nodeIndex(@Unsigned
 int value)

payloadCount

@Unsigned
public int payloadCount()

payloadCount

public VkDispatchGraphInfoAMDX payloadCount(@Unsigned
 int value)

payloads

@NotNull
public @NotNull VkDeviceOrHostAddressConstAMDX payloads()

payloads

public VkDispatchGraphInfoAMDX payloads(@NotNull
 @NotNull VkDeviceOrHostAddressConstAMDX value)

payloads

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

payloadStride

@Unsigned
public long payloadStride()

payloadStride

public VkDispatchGraphInfoAMDX payloadStride(@Unsigned
 long value)

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

segment

@NotNull
public @NotNull MemorySegment segment()

Returns the value of the segment record component.

Specified by:

segment in interface IPointer

Returns:

the value of the segment record component