Record Class VkShadingRatePaletteNV

java.lang.Object

java.lang.Record

club.doki7.vulkan.datatype.VkShadingRatePaletteNV

All Implemented Interfaces:

IPointer, IVkShadingRatePaletteNV

@ValueBasedCandidate
@UnsafeConstructor
public record VkShadingRatePaletteNV(@NotNull MemorySegment segment)
extends Record
implements IVkShadingRatePaletteNV

Represents a pointer to a VkShadingRatePaletteNV structure in native memory.

Structure

typedef struct VkShadingRatePaletteNV {
    uint32_t shadingRatePaletteEntryCount;
    VkShadingRatePaletteEntryNV const* pShadingRatePaletteEntries;
} VkShadingRatePaletteNV;

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:

• VkShadingRatePaletteNV

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
static final long	BYTES
static final StructLayout	LAYOUT
static final AddressLayout	LAYOUT$pShadingRatePaletteEntries
static final ValueLayout.OfInt	LAYOUT$shadingRatePaletteEntryCount
static final long	OFFSET$pShadingRatePaletteEntries
static final long	OFFSET$shadingRatePaletteEntryCount
static final MemoryLayout.PathElement	PATH$pShadingRatePaletteEntries
static final MemoryLayout.PathElement	PATH$shadingRatePaletteEntryCount
static final long	SIZE$pShadingRatePaletteEntries
static final long	SIZE$shadingRatePaletteEntryCount

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static VkShadingRatePaletteNV	allocate(Arena arena)
static VkShadingRatePaletteNV.Ptr	allocate(Arena arena, long count)
static VkShadingRatePaletteNV	clone(Arena arena, VkShadingRatePaletteNV 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.
@Nullable IntPtr	pShadingRatePaletteEntries()	Note: the returned IntPtr does not have correct IntPtr.size() property.
VkShadingRatePaletteNV	pShadingRatePaletteEntries(@Nullable IntPtr value)
MemorySegment	pShadingRatePaletteEntriesRaw()
void	pShadingRatePaletteEntriesRaw(MemorySegment value)
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
int	shadingRatePaletteEntryCount()
VkShadingRatePaletteNV	shadingRatePaletteEntryCount(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$shadingRatePaletteEntryCount

public static final MemoryLayout.PathElement PATH$shadingRatePaletteEntryCount

PATH$pShadingRatePaletteEntries

public static final MemoryLayout.PathElement PATH$pShadingRatePaletteEntries

LAYOUT$shadingRatePaletteEntryCount

public static final ValueLayout.OfInt LAYOUT$shadingRatePaletteEntryCount

LAYOUT$pShadingRatePaletteEntries

public static final AddressLayout LAYOUT$pShadingRatePaletteEntries

SIZE$shadingRatePaletteEntryCount

public static final long SIZE$shadingRatePaletteEntryCount

SIZE$pShadingRatePaletteEntries

public static final long SIZE$pShadingRatePaletteEntries

OFFSET$shadingRatePaletteEntryCount

public static final long OFFSET$shadingRatePaletteEntryCount

OFFSET$pShadingRatePaletteEntries

public static final long OFFSET$pShadingRatePaletteEntries

Constructor Details

VkShadingRatePaletteNV

public VkShadingRatePaletteNV(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a VkShadingRatePaletteNV record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static VkShadingRatePaletteNV allocate(Arena arena)

allocate

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

clone

public static VkShadingRatePaletteNV clone(Arena arena,
 VkShadingRatePaletteNV src)

shadingRatePaletteEntryCount

@Unsigned
public int shadingRatePaletteEntryCount()

shadingRatePaletteEntryCount

public VkShadingRatePaletteNV shadingRatePaletteEntryCount(@Unsigned
 int value)

pShadingRatePaletteEntries

@Nullable
@EnumType(VkShadingRatePaletteEntryNV.class)
public @Nullable IntPtr pShadingRatePaletteEntries()

Note: the returned IntPtr does not have correct IntPtr.size() property. It's up to user to track the size of the buffer, and use IntPtr.reinterpret(long) to set the size before actually reading fro or writing to the buffer.

pShadingRatePaletteEntries

public VkShadingRatePaletteNV pShadingRatePaletteEntries(@Nullable @EnumType(VkShadingRatePaletteEntryNV.class)
 @Nullable IntPtr value)

pShadingRatePaletteEntriesRaw

@Pointer(target=VkShadingRatePaletteEntryNV.class)
public MemorySegment pShadingRatePaletteEntriesRaw()

pShadingRatePaletteEntriesRaw

public void pShadingRatePaletteEntriesRaw(@Pointer(target=VkShadingRatePaletteEntryNV.class)
 MemorySegment 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