Record Class VkSubpassSampleLocationsEXT

java.lang.Object

java.lang.Record

club.doki7.vulkan.datatype.VkSubpassSampleLocationsEXT

All Implemented Interfaces:

IPointer, IVkSubpassSampleLocationsEXT

@ValueBasedCandidate
@UnsafeConstructor
public record VkSubpassSampleLocationsEXT(@NotNull MemorySegment segment)
extends Record
implements IVkSubpassSampleLocationsEXT

Represents a pointer to a VkSubpassSampleLocationsEXT structure in native memory.

Structure

typedef struct VkSubpassSampleLocationsEXT {
    uint32_t subpassIndex;
    VkSampleLocationsInfoEXT sampleLocationsInfo;
} VkSubpassSampleLocationsEXT;

Auto initialization

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

• sampleLocationsInfo.autoInit()

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:

• VkSubpassSampleLocationsEXT

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static VkSubpassSampleLocationsEXT	allocate(Arena arena)
static VkSubpassSampleLocationsEXT.Ptr	allocate(Arena arena, long count)
void	autoInit()
static VkSubpassSampleLocationsEXT	clone(Arena arena, VkSubpassSampleLocationsEXT 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.
@NotNull VkSampleLocationsInfoEXT	sampleLocationsInfo()
VkSubpassSampleLocationsEXT	sampleLocationsInfo(@NotNull VkSampleLocationsInfoEXT value)
VkSubpassSampleLocationsEXT	sampleLocationsInfo(Consumer<@NotNull VkSampleLocationsInfoEXT> consumer)
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
int	subpassIndex()
VkSubpassSampleLocationsEXT	subpassIndex(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$subpassIndex

public static final MemoryLayout.PathElement PATH$subpassIndex

PATH$sampleLocationsInfo

public static final MemoryLayout.PathElement PATH$sampleLocationsInfo

LAYOUT$subpassIndex

public static final ValueLayout.OfInt LAYOUT$subpassIndex

LAYOUT$sampleLocationsInfo

public static final StructLayout LAYOUT$sampleLocationsInfo

SIZE$subpassIndex

public static final long SIZE$subpassIndex

SIZE$sampleLocationsInfo

public static final long SIZE$sampleLocationsInfo

OFFSET$subpassIndex

public static final long OFFSET$subpassIndex

OFFSET$sampleLocationsInfo

public static final long OFFSET$sampleLocationsInfo

Constructor Details

VkSubpassSampleLocationsEXT

public VkSubpassSampleLocationsEXT(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a VkSubpassSampleLocationsEXT record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static VkSubpassSampleLocationsEXT allocate(Arena arena)

allocate

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

clone

public static VkSubpassSampleLocationsEXT clone(Arena arena,
 VkSubpassSampleLocationsEXT src)

autoInit

public void autoInit()

subpassIndex

@Unsigned
public int subpassIndex()

subpassIndex

public VkSubpassSampleLocationsEXT subpassIndex(@Unsigned
 int value)

sampleLocationsInfo

@NotNull
public @NotNull VkSampleLocationsInfoEXT sampleLocationsInfo()

sampleLocationsInfo

public VkSubpassSampleLocationsEXT sampleLocationsInfo(@NotNull
 @NotNull VkSampleLocationsInfoEXT value)

sampleLocationsInfo

public VkSubpassSampleLocationsEXT sampleLocationsInfo(Consumer<@NotNull VkSampleLocationsInfoEXT> consumer)

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