Record Class VkCoarseSampleOrderCustomNV

java.lang.Object

java.lang.Record

club.doki7.vulkan.datatype.VkCoarseSampleOrderCustomNV

All Implemented Interfaces:

IPointer, IVkCoarseSampleOrderCustomNV

@ValueBasedCandidate
@UnsafeConstructor
public record VkCoarseSampleOrderCustomNV(@NotNull MemorySegment segment)
extends Record
implements IVkCoarseSampleOrderCustomNV

Represents a pointer to a VkCoarseSampleOrderCustomNV structure in native memory.

Structure

typedef struct VkCoarseSampleOrderCustomNV {
    VkShadingRatePaletteEntryNV shadingRate;
    uint32_t sampleCount;
    uint32_t sampleLocationCount;
    VkCoarseSampleLocationNV const* pSampleLocations;
} VkCoarseSampleOrderCustomNV;

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:

• VkCoarseSampleOrderCustomNV

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	VkCoarseSampleOrderCustomNV.Ptr	Represents a pointer to / an array of VkCoarseSampleOrderCustomNV 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$pSampleLocations
static final ValueLayout.OfInt	LAYOUT$sampleCount
static final ValueLayout.OfInt	LAYOUT$sampleLocationCount
static final ValueLayout.OfInt	LAYOUT$shadingRate
static final long	OFFSET$pSampleLocations
static final long	OFFSET$sampleCount
static final long	OFFSET$sampleLocationCount
static final long	OFFSET$shadingRate
static final MemoryLayout.PathElement	PATH$pSampleLocations
static final MemoryLayout.PathElement	PATH$sampleCount
static final MemoryLayout.PathElement	PATH$sampleLocationCount
static final MemoryLayout.PathElement	PATH$shadingRate
static final long	SIZE$pSampleLocations
static final long	SIZE$sampleCount
static final long	SIZE$sampleLocationCount
static final long	SIZE$shadingRate

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static VkCoarseSampleOrderCustomNV	allocate(Arena arena)
static VkCoarseSampleOrderCustomNV.Ptr	allocate(Arena arena, long count)
static VkCoarseSampleOrderCustomNV	clone(Arena arena, VkCoarseSampleOrderCustomNV 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 VkCoarseSampleLocationNV	pSampleLocations()
VkCoarseSampleLocationNV.Ptr	pSampleLocations(int assumedCount)
VkCoarseSampleOrderCustomNV	pSampleLocations(@Nullable IVkCoarseSampleLocationNV value)
@NotNull MemorySegment	pSampleLocationsRaw()
void	pSampleLocationsRaw(@NotNull MemorySegment value)
int	sampleCount()
VkCoarseSampleOrderCustomNV	sampleCount(int value)
int	sampleLocationCount()
VkCoarseSampleOrderCustomNV	sampleLocationCount(int value)
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
int	shadingRate()
VkCoarseSampleOrderCustomNV	shadingRate(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$shadingRate

public static final MemoryLayout.PathElement PATH$shadingRate

PATH$sampleCount

public static final MemoryLayout.PathElement PATH$sampleCount

PATH$sampleLocationCount

public static final MemoryLayout.PathElement PATH$sampleLocationCount

PATH$pSampleLocations

public static final MemoryLayout.PathElement PATH$pSampleLocations

LAYOUT$shadingRate

public static final ValueLayout.OfInt LAYOUT$shadingRate

LAYOUT$sampleCount

public static final ValueLayout.OfInt LAYOUT$sampleCount

LAYOUT$sampleLocationCount

public static final ValueLayout.OfInt LAYOUT$sampleLocationCount

LAYOUT$pSampleLocations

public static final AddressLayout LAYOUT$pSampleLocations

SIZE$shadingRate

public static final long SIZE$shadingRate

SIZE$sampleCount

public static final long SIZE$sampleCount

SIZE$sampleLocationCount

public static final long SIZE$sampleLocationCount

SIZE$pSampleLocations

public static final long SIZE$pSampleLocations

OFFSET$shadingRate

public static final long OFFSET$shadingRate

OFFSET$sampleCount

public static final long OFFSET$sampleCount

OFFSET$sampleLocationCount

public static final long OFFSET$sampleLocationCount

OFFSET$pSampleLocations

public static final long OFFSET$pSampleLocations

Constructor Details

VkCoarseSampleOrderCustomNV

public VkCoarseSampleOrderCustomNV(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a VkCoarseSampleOrderCustomNV record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static VkCoarseSampleOrderCustomNV allocate(Arena arena)

allocate

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

clone

public static VkCoarseSampleOrderCustomNV clone(Arena arena,
 VkCoarseSampleOrderCustomNV src)

shadingRate

@EnumType(VkShadingRatePaletteEntryNV.class)
public int shadingRate()

shadingRate

public VkCoarseSampleOrderCustomNV shadingRate(@EnumType(VkShadingRatePaletteEntryNV.class)
 int value)

sampleCount

@Unsigned
public int sampleCount()

sampleCount

public VkCoarseSampleOrderCustomNV sampleCount(@Unsigned
 int value)

sampleLocationCount

@Unsigned
public int sampleLocationCount()

sampleLocationCount

public VkCoarseSampleOrderCustomNV sampleLocationCount(@Unsigned
 int value)

pSampleLocations

public VkCoarseSampleOrderCustomNV pSampleLocations(@Nullable
 @Nullable IVkCoarseSampleLocationNV value)

pSampleLocations

@Unsafe
@Nullable
public VkCoarseSampleLocationNV.Ptr pSampleLocations(int assumedCount)

pSampleLocations

@Nullable
public @Nullable VkCoarseSampleLocationNV pSampleLocations()

pSampleLocationsRaw

@Pointer(target=VkCoarseSampleLocationNV.class)
@NotNull
public @NotNull MemorySegment pSampleLocationsRaw()

pSampleLocationsRaw

public void pSampleLocationsRaw(@Pointer(target=VkCoarseSampleLocationNV.class) @NotNull
 @NotNull 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