Record Class VkPhysicalDeviceShaderEnqueuePropertiesAMDX

java.lang.Object

java.lang.Record

club.doki7.vulkan.datatype.VkPhysicalDeviceShaderEnqueuePropertiesAMDX

All Implemented Interfaces:

IPointer, IVkPhysicalDeviceShaderEnqueuePropertiesAMDX

@ValueBasedCandidate
@UnsafeConstructor
public record VkPhysicalDeviceShaderEnqueuePropertiesAMDX(@NotNull MemorySegment segment)
extends Record
implements IVkPhysicalDeviceShaderEnqueuePropertiesAMDX

Represents a pointer to a VkPhysicalDeviceShaderEnqueuePropertiesAMDX structure in native memory.

Structure

typedef struct VkPhysicalDeviceShaderEnqueuePropertiesAMDX {
    VkStructureType sType;
    void* pNext; // optional
    uint32_t maxExecutionGraphDepth;
    uint32_t maxExecutionGraphShaderOutputNodes;
    uint32_t maxExecutionGraphShaderPayloadSize;
    uint32_t maxExecutionGraphShaderPayloadCount;
    uint32_t executionGraphDispatchAddressAlignment;
    uint32_t[3] maxExecutionGraphWorkgroupCount;
    uint32_t maxExecutionGraphWorkgroups;
} VkPhysicalDeviceShaderEnqueuePropertiesAMDX;

Auto initialization

This structure has the following members that can be automatically initialized:

• sType = VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_SHADER_ENQUEUE_PROPERTIES_AMDX

The allocate (allocate(Arena), allocate(Arena, long)) functions will automatically initialize these fields. Also, you may call autoInit() to initialize these fields manually for non-allocated instances.

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:

• VkPhysicalDeviceShaderEnqueuePropertiesAMDX

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	VkPhysicalDeviceShaderEnqueuePropertiesAMDX.Ptr	Represents a pointer to / an array of VkPhysicalDeviceShaderEnqueuePropertiesAMDX 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$executionGraphDispatchAddressAlignment
static final ValueLayout.OfInt	LAYOUT$maxExecutionGraphDepth
static final ValueLayout.OfInt	LAYOUT$maxExecutionGraphShaderOutputNodes
static final ValueLayout.OfInt	LAYOUT$maxExecutionGraphShaderPayloadCount
static final ValueLayout.OfInt	LAYOUT$maxExecutionGraphShaderPayloadSize
static final SequenceLayout	LAYOUT$maxExecutionGraphWorkgroupCount
static final ValueLayout.OfInt	LAYOUT$maxExecutionGraphWorkgroups
static final AddressLayout	LAYOUT$pNext
static final ValueLayout.OfInt	LAYOUT$sType
static final long	OFFSET$executionGraphDispatchAddressAlignment
static final long	OFFSET$maxExecutionGraphDepth
static final long	OFFSET$maxExecutionGraphShaderOutputNodes
static final long	OFFSET$maxExecutionGraphShaderPayloadCount
static final long	OFFSET$maxExecutionGraphShaderPayloadSize
static final long	OFFSET$maxExecutionGraphWorkgroupCount
static final long	OFFSET$maxExecutionGraphWorkgroups
static final long	OFFSET$pNext
static final long	OFFSET$sType
static final MemoryLayout.PathElement	PATH$executionGraphDispatchAddressAlignment
static final MemoryLayout.PathElement	PATH$maxExecutionGraphDepth
static final MemoryLayout.PathElement	PATH$maxExecutionGraphShaderOutputNodes
static final MemoryLayout.PathElement	PATH$maxExecutionGraphShaderPayloadCount
static final MemoryLayout.PathElement	PATH$maxExecutionGraphShaderPayloadSize
static final MemoryLayout.PathElement	PATH$maxExecutionGraphWorkgroupCount
static final MemoryLayout.PathElement	PATH$maxExecutionGraphWorkgroups
static final MemoryLayout.PathElement	PATH$pNext
static final MemoryLayout.PathElement	PATH$sType
static final long	SIZE$executionGraphDispatchAddressAlignment
static final long	SIZE$maxExecutionGraphDepth
static final long	SIZE$maxExecutionGraphShaderOutputNodes
static final long	SIZE$maxExecutionGraphShaderPayloadCount
static final long	SIZE$maxExecutionGraphShaderPayloadSize
static final long	SIZE$maxExecutionGraphWorkgroupCount
static final long	SIZE$maxExecutionGraphWorkgroups
static final long	SIZE$pNext
static final long	SIZE$sType

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static VkPhysicalDeviceShaderEnqueuePropertiesAMDX	allocate(Arena arena)
static VkPhysicalDeviceShaderEnqueuePropertiesAMDX.Ptr	allocate(Arena arena, long count)
void	autoInit()
static VkPhysicalDeviceShaderEnqueuePropertiesAMDX	clone(Arena arena, VkPhysicalDeviceShaderEnqueuePropertiesAMDX src)
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
int	executionGraphDispatchAddressAlignment()
VkPhysicalDeviceShaderEnqueuePropertiesAMDX	executionGraphDispatchAddressAlignment(int value)
final int	hashCode()	Returns a hash code value for this object.
int	maxExecutionGraphDepth()
VkPhysicalDeviceShaderEnqueuePropertiesAMDX	maxExecutionGraphDepth(int value)
int	maxExecutionGraphShaderOutputNodes()
VkPhysicalDeviceShaderEnqueuePropertiesAMDX	maxExecutionGraphShaderOutputNodes(int value)
int	maxExecutionGraphShaderPayloadCount()
VkPhysicalDeviceShaderEnqueuePropertiesAMDX	maxExecutionGraphShaderPayloadCount(int value)
int	maxExecutionGraphShaderPayloadSize()
VkPhysicalDeviceShaderEnqueuePropertiesAMDX	maxExecutionGraphShaderPayloadSize(int value)
IntPtr	maxExecutionGraphWorkgroupCount()
VkPhysicalDeviceShaderEnqueuePropertiesAMDX	maxExecutionGraphWorkgroupCount(IntPtr value)
VkPhysicalDeviceShaderEnqueuePropertiesAMDX	maxExecutionGraphWorkgroupCount(@NotNull Consumer<IntPtr> consumer)
@NotNull MemorySegment	maxExecutionGraphWorkgroupCountRaw()
int	maxExecutionGraphWorkgroups()
VkPhysicalDeviceShaderEnqueuePropertiesAMDX	maxExecutionGraphWorkgroups(int value)
@NotNull MemorySegment	pNext()
VkPhysicalDeviceShaderEnqueuePropertiesAMDX	pNext(@Nullable IPointer pointer)
VkPhysicalDeviceShaderEnqueuePropertiesAMDX	pNext(@NotNull MemorySegment value)
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
int	sType()
VkPhysicalDeviceShaderEnqueuePropertiesAMDX	sType(int value)
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$sType

public static final MemoryLayout.PathElement PATH$sType

PATH$pNext

public static final MemoryLayout.PathElement PATH$pNext

PATH$maxExecutionGraphDepth

public static final MemoryLayout.PathElement PATH$maxExecutionGraphDepth

PATH$maxExecutionGraphShaderOutputNodes

public static final MemoryLayout.PathElement PATH$maxExecutionGraphShaderOutputNodes

PATH$maxExecutionGraphShaderPayloadSize

public static final MemoryLayout.PathElement PATH$maxExecutionGraphShaderPayloadSize

PATH$maxExecutionGraphShaderPayloadCount

public static final MemoryLayout.PathElement PATH$maxExecutionGraphShaderPayloadCount

PATH$executionGraphDispatchAddressAlignment

public static final MemoryLayout.PathElement PATH$executionGraphDispatchAddressAlignment

PATH$maxExecutionGraphWorkgroupCount

public static final MemoryLayout.PathElement PATH$maxExecutionGraphWorkgroupCount

PATH$maxExecutionGraphWorkgroups

public static final MemoryLayout.PathElement PATH$maxExecutionGraphWorkgroups

LAYOUT$sType

public static final ValueLayout.OfInt LAYOUT$sType

LAYOUT$pNext

public static final AddressLayout LAYOUT$pNext

LAYOUT$maxExecutionGraphDepth

public static final ValueLayout.OfInt LAYOUT$maxExecutionGraphDepth

LAYOUT$maxExecutionGraphShaderOutputNodes

public static final ValueLayout.OfInt LAYOUT$maxExecutionGraphShaderOutputNodes

LAYOUT$maxExecutionGraphShaderPayloadSize

public static final ValueLayout.OfInt LAYOUT$maxExecutionGraphShaderPayloadSize

LAYOUT$maxExecutionGraphShaderPayloadCount

public static final ValueLayout.OfInt LAYOUT$maxExecutionGraphShaderPayloadCount

LAYOUT$executionGraphDispatchAddressAlignment

public static final ValueLayout.OfInt LAYOUT$executionGraphDispatchAddressAlignment

LAYOUT$maxExecutionGraphWorkgroupCount

public static final SequenceLayout LAYOUT$maxExecutionGraphWorkgroupCount

LAYOUT$maxExecutionGraphWorkgroups

public static final ValueLayout.OfInt LAYOUT$maxExecutionGraphWorkgroups

SIZE$sType

public static final long SIZE$sType

SIZE$pNext

public static final long SIZE$pNext

SIZE$maxExecutionGraphDepth

public static final long SIZE$maxExecutionGraphDepth

SIZE$maxExecutionGraphShaderOutputNodes

public static final long SIZE$maxExecutionGraphShaderOutputNodes

SIZE$maxExecutionGraphShaderPayloadSize

public static final long SIZE$maxExecutionGraphShaderPayloadSize

SIZE$maxExecutionGraphShaderPayloadCount

public static final long SIZE$maxExecutionGraphShaderPayloadCount

SIZE$executionGraphDispatchAddressAlignment

public static final long SIZE$executionGraphDispatchAddressAlignment

SIZE$maxExecutionGraphWorkgroupCount

public static final long SIZE$maxExecutionGraphWorkgroupCount

SIZE$maxExecutionGraphWorkgroups

public static final long SIZE$maxExecutionGraphWorkgroups

OFFSET$sType

public static final long OFFSET$sType

OFFSET$pNext

public static final long OFFSET$pNext

OFFSET$maxExecutionGraphDepth

public static final long OFFSET$maxExecutionGraphDepth

OFFSET$maxExecutionGraphShaderOutputNodes

public static final long OFFSET$maxExecutionGraphShaderOutputNodes

OFFSET$maxExecutionGraphShaderPayloadSize

public static final long OFFSET$maxExecutionGraphShaderPayloadSize

OFFSET$maxExecutionGraphShaderPayloadCount

public static final long OFFSET$maxExecutionGraphShaderPayloadCount

OFFSET$executionGraphDispatchAddressAlignment

public static final long OFFSET$executionGraphDispatchAddressAlignment

OFFSET$maxExecutionGraphWorkgroupCount

public static final long OFFSET$maxExecutionGraphWorkgroupCount

OFFSET$maxExecutionGraphWorkgroups

public static final long OFFSET$maxExecutionGraphWorkgroups

Constructor Details

VkPhysicalDeviceShaderEnqueuePropertiesAMDX

public VkPhysicalDeviceShaderEnqueuePropertiesAMDX(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a VkPhysicalDeviceShaderEnqueuePropertiesAMDX record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static VkPhysicalDeviceShaderEnqueuePropertiesAMDX allocate(Arena arena)

allocate

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

clone

public static VkPhysicalDeviceShaderEnqueuePropertiesAMDX clone(Arena arena,
 VkPhysicalDeviceShaderEnqueuePropertiesAMDX src)

autoInit

public void autoInit()

sType

@EnumType(VkStructureType.class)
public int sType()

sType

public VkPhysicalDeviceShaderEnqueuePropertiesAMDX sType(@EnumType(VkStructureType.class)
 int value)

pNext

@Pointer(comment="void*")
@NotNull
public @NotNull MemorySegment pNext()

pNext

public VkPhysicalDeviceShaderEnqueuePropertiesAMDX pNext(@Pointer(comment="void*") @NotNull
 @NotNull MemorySegment value)

pNext

public VkPhysicalDeviceShaderEnqueuePropertiesAMDX pNext(@Nullable
 @Nullable IPointer pointer)

maxExecutionGraphDepth

@Unsigned
public int maxExecutionGraphDepth()

maxExecutionGraphDepth

public VkPhysicalDeviceShaderEnqueuePropertiesAMDX maxExecutionGraphDepth(@Unsigned
 int value)

maxExecutionGraphShaderOutputNodes

@Unsigned
public int maxExecutionGraphShaderOutputNodes()

maxExecutionGraphShaderOutputNodes

public VkPhysicalDeviceShaderEnqueuePropertiesAMDX maxExecutionGraphShaderOutputNodes(@Unsigned
 int value)

maxExecutionGraphShaderPayloadSize

@Unsigned
public int maxExecutionGraphShaderPayloadSize()

maxExecutionGraphShaderPayloadSize

public VkPhysicalDeviceShaderEnqueuePropertiesAMDX maxExecutionGraphShaderPayloadSize(@Unsigned
 int value)

maxExecutionGraphShaderPayloadCount

@Unsigned
public int maxExecutionGraphShaderPayloadCount()

maxExecutionGraphShaderPayloadCount

public VkPhysicalDeviceShaderEnqueuePropertiesAMDX maxExecutionGraphShaderPayloadCount(@Unsigned
 int value)

executionGraphDispatchAddressAlignment

@Unsigned
public int executionGraphDispatchAddressAlignment()

executionGraphDispatchAddressAlignment

public VkPhysicalDeviceShaderEnqueuePropertiesAMDX executionGraphDispatchAddressAlignment(@Unsigned
 int value)

maxExecutionGraphWorkgroupCount

@Unsigned
public IntPtr maxExecutionGraphWorkgroupCount()

maxExecutionGraphWorkgroupCount

public VkPhysicalDeviceShaderEnqueuePropertiesAMDX maxExecutionGraphWorkgroupCount(@NotNull
 @NotNull Consumer<IntPtr> consumer)

maxExecutionGraphWorkgroupCount

public VkPhysicalDeviceShaderEnqueuePropertiesAMDX maxExecutionGraphWorkgroupCount(@Unsigned
 IntPtr value)

maxExecutionGraphWorkgroupCountRaw

@NotNull
public @NotNull MemorySegment maxExecutionGraphWorkgroupCountRaw()

maxExecutionGraphWorkgroups

@Unsigned
public int maxExecutionGraphWorkgroups()

maxExecutionGraphWorkgroups

public VkPhysicalDeviceShaderEnqueuePropertiesAMDX maxExecutionGraphWorkgroups(@Unsigned
 int 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