Record Class VkShaderStatisticsInfoAMD

java.lang.Object

java.lang.Record

club.doki7.vulkan.datatype.VkShaderStatisticsInfoAMD

All Implemented Interfaces:

IPointer, IVkShaderStatisticsInfoAMD

@ValueBasedCandidate
@UnsafeConstructor
public record VkShaderStatisticsInfoAMD(@NotNull MemorySegment segment)
extends Record
implements IVkShaderStatisticsInfoAMD

Represents a pointer to a VkShaderStatisticsInfoAMD structure in native memory.

Structure

typedef struct VkShaderStatisticsInfoAMD {
    VkShaderStageFlags shaderStageMask;
    VkShaderResourceUsageAMD resourceUsage;
    uint32_t numPhysicalVgprs;
    uint32_t numPhysicalSgprs;
    uint32_t numAvailableVgprs;
    uint32_t numAvailableSgprs;
    uint32_t[3] computeWorkGroupSize;
} VkShaderStatisticsInfoAMD;

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:

• VkShaderStatisticsInfoAMD

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
static final long	BYTES
static final StructLayout	LAYOUT
static final SequenceLayout	LAYOUT$computeWorkGroupSize
static final ValueLayout.OfInt	LAYOUT$numAvailableSgprs
static final ValueLayout.OfInt	LAYOUT$numAvailableVgprs
static final ValueLayout.OfInt	LAYOUT$numPhysicalSgprs
static final ValueLayout.OfInt	LAYOUT$numPhysicalVgprs
static final StructLayout	LAYOUT$resourceUsage
static final ValueLayout.OfInt	LAYOUT$shaderStageMask
static final long	OFFSET$computeWorkGroupSize
static final long	OFFSET$numAvailableSgprs
static final long	OFFSET$numAvailableVgprs
static final long	OFFSET$numPhysicalSgprs
static final long	OFFSET$numPhysicalVgprs
static final long	OFFSET$resourceUsage
static final long	OFFSET$shaderStageMask
static final MemoryLayout.PathElement	PATH$computeWorkGroupSize
static final MemoryLayout.PathElement	PATH$numAvailableSgprs
static final MemoryLayout.PathElement	PATH$numAvailableVgprs
static final MemoryLayout.PathElement	PATH$numPhysicalSgprs
static final MemoryLayout.PathElement	PATH$numPhysicalVgprs
static final MemoryLayout.PathElement	PATH$resourceUsage
static final MemoryLayout.PathElement	PATH$shaderStageMask
static final long	SIZE$computeWorkGroupSize
static final long	SIZE$numAvailableSgprs
static final long	SIZE$numAvailableVgprs
static final long	SIZE$numPhysicalSgprs
static final long	SIZE$numPhysicalVgprs
static final long	SIZE$resourceUsage
static final long	SIZE$shaderStageMask

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static VkShaderStatisticsInfoAMD	allocate(Arena arena)
static VkShaderStatisticsInfoAMD.Ptr	allocate(Arena arena, long count)
static VkShaderStatisticsInfoAMD	clone(Arena arena, VkShaderStatisticsInfoAMD src)
IntPtr	computeWorkGroupSize()
VkShaderStatisticsInfoAMD	computeWorkGroupSize(IntPtr value)
VkShaderStatisticsInfoAMD	computeWorkGroupSize(@NotNull Consumer<IntPtr> consumer)
@NotNull MemorySegment	computeWorkGroupSizeRaw()
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	numAvailableSgprs()
VkShaderStatisticsInfoAMD	numAvailableSgprs(int value)
int	numAvailableVgprs()
VkShaderStatisticsInfoAMD	numAvailableVgprs(int value)
int	numPhysicalSgprs()
VkShaderStatisticsInfoAMD	numPhysicalSgprs(int value)
int	numPhysicalVgprs()
VkShaderStatisticsInfoAMD	numPhysicalVgprs(int value)
@NotNull VkShaderResourceUsageAMD	resourceUsage()
VkShaderStatisticsInfoAMD	resourceUsage(@NotNull VkShaderResourceUsageAMD value)
VkShaderStatisticsInfoAMD	resourceUsage(Consumer<@NotNull VkShaderResourceUsageAMD> consumer)
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
int	shaderStageMask()
VkShaderStatisticsInfoAMD	shaderStageMask(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$shaderStageMask

public static final MemoryLayout.PathElement PATH$shaderStageMask

PATH$resourceUsage

public static final MemoryLayout.PathElement PATH$resourceUsage

PATH$numPhysicalVgprs

public static final MemoryLayout.PathElement PATH$numPhysicalVgprs

PATH$numPhysicalSgprs

public static final MemoryLayout.PathElement PATH$numPhysicalSgprs

PATH$numAvailableVgprs

public static final MemoryLayout.PathElement PATH$numAvailableVgprs

PATH$numAvailableSgprs

public static final MemoryLayout.PathElement PATH$numAvailableSgprs

PATH$computeWorkGroupSize

public static final MemoryLayout.PathElement PATH$computeWorkGroupSize

LAYOUT$shaderStageMask

public static final ValueLayout.OfInt LAYOUT$shaderStageMask

LAYOUT$resourceUsage

public static final StructLayout LAYOUT$resourceUsage

LAYOUT$numPhysicalVgprs

public static final ValueLayout.OfInt LAYOUT$numPhysicalVgprs

LAYOUT$numPhysicalSgprs

public static final ValueLayout.OfInt LAYOUT$numPhysicalSgprs

LAYOUT$numAvailableVgprs

public static final ValueLayout.OfInt LAYOUT$numAvailableVgprs

LAYOUT$numAvailableSgprs

public static final ValueLayout.OfInt LAYOUT$numAvailableSgprs

LAYOUT$computeWorkGroupSize

public static final SequenceLayout LAYOUT$computeWorkGroupSize

SIZE$shaderStageMask

public static final long SIZE$shaderStageMask

SIZE$resourceUsage

public static final long SIZE$resourceUsage

SIZE$numPhysicalVgprs

public static final long SIZE$numPhysicalVgprs

SIZE$numPhysicalSgprs

public static final long SIZE$numPhysicalSgprs

SIZE$numAvailableVgprs

public static final long SIZE$numAvailableVgprs

SIZE$numAvailableSgprs

public static final long SIZE$numAvailableSgprs

SIZE$computeWorkGroupSize

public static final long SIZE$computeWorkGroupSize

OFFSET$shaderStageMask

public static final long OFFSET$shaderStageMask

OFFSET$resourceUsage

public static final long OFFSET$resourceUsage

OFFSET$numPhysicalVgprs

public static final long OFFSET$numPhysicalVgprs

OFFSET$numPhysicalSgprs

public static final long OFFSET$numPhysicalSgprs

OFFSET$numAvailableVgprs

public static final long OFFSET$numAvailableVgprs

OFFSET$numAvailableSgprs

public static final long OFFSET$numAvailableSgprs

OFFSET$computeWorkGroupSize

public static final long OFFSET$computeWorkGroupSize

Constructor Details

VkShaderStatisticsInfoAMD

public VkShaderStatisticsInfoAMD(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a VkShaderStatisticsInfoAMD record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static VkShaderStatisticsInfoAMD allocate(Arena arena)

allocate

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

clone

public static VkShaderStatisticsInfoAMD clone(Arena arena,
 VkShaderStatisticsInfoAMD src)

shaderStageMask

@Bitmask(VkShaderStageFlags.class)
public int shaderStageMask()

shaderStageMask

public VkShaderStatisticsInfoAMD shaderStageMask(@Bitmask(VkShaderStageFlags.class)
 int value)

resourceUsage

@NotNull
public @NotNull VkShaderResourceUsageAMD resourceUsage()

resourceUsage

public VkShaderStatisticsInfoAMD resourceUsage(@NotNull
 @NotNull VkShaderResourceUsageAMD value)

resourceUsage

public VkShaderStatisticsInfoAMD resourceUsage(Consumer<@NotNull VkShaderResourceUsageAMD> consumer)

numPhysicalVgprs

@Unsigned
public int numPhysicalVgprs()

numPhysicalVgprs

public VkShaderStatisticsInfoAMD numPhysicalVgprs(@Unsigned
 int value)

numPhysicalSgprs

@Unsigned
public int numPhysicalSgprs()

numPhysicalSgprs

public VkShaderStatisticsInfoAMD numPhysicalSgprs(@Unsigned
 int value)

numAvailableVgprs

@Unsigned
public int numAvailableVgprs()

numAvailableVgprs

public VkShaderStatisticsInfoAMD numAvailableVgprs(@Unsigned
 int value)

numAvailableSgprs

@Unsigned
public int numAvailableSgprs()

numAvailableSgprs

public VkShaderStatisticsInfoAMD numAvailableSgprs(@Unsigned
 int value)

computeWorkGroupSize

@Unsigned
public IntPtr computeWorkGroupSize()

computeWorkGroupSize

public VkShaderStatisticsInfoAMD computeWorkGroupSize(@NotNull
 @NotNull Consumer<IntPtr> consumer)

computeWorkGroupSize

public VkShaderStatisticsInfoAMD computeWorkGroupSize(@Unsigned
 IntPtr value)

computeWorkGroupSizeRaw

@NotNull
public @NotNull MemorySegment computeWorkGroupSizeRaw()

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