Record Class VkAttachmentSampleLocationsEXT

java.lang.Object

java.lang.Record

club.doki7.vulkan.datatype.VkAttachmentSampleLocationsEXT

All Implemented Interfaces:

IPointer, IVkAttachmentSampleLocationsEXT

@ValueBasedCandidate
@UnsafeConstructor
public record VkAttachmentSampleLocationsEXT(@NotNull MemorySegment segment)
extends Record
implements IVkAttachmentSampleLocationsEXT

Represents a pointer to a VkAttachmentSampleLocationsEXT structure in native memory.

Structure

typedef struct VkAttachmentSampleLocationsEXT {
    uint32_t attachmentIndex;
    VkSampleLocationsInfoEXT sampleLocationsInfo;
} VkAttachmentSampleLocationsEXT;

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:

• VkAttachmentSampleLocationsEXT

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	VkAttachmentSampleLocationsEXT.Ptr	Represents a pointer to / an array of VkAttachmentSampleLocationsEXT 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$attachmentIndex
static final StructLayout	LAYOUT$sampleLocationsInfo
static final long	OFFSET$attachmentIndex
static final long	OFFSET$sampleLocationsInfo
static final MemoryLayout.PathElement	PATH$attachmentIndex
static final MemoryLayout.PathElement	PATH$sampleLocationsInfo
static final long	SIZE$attachmentIndex
static final long	SIZE$sampleLocationsInfo

Constructor Summary

Constructors

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

Method Summary

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

public static final MemoryLayout.PathElement PATH$attachmentIndex

PATH$sampleLocationsInfo

public static final MemoryLayout.PathElement PATH$sampleLocationsInfo

LAYOUT$attachmentIndex

public static final ValueLayout.OfInt LAYOUT$attachmentIndex

LAYOUT$sampleLocationsInfo

public static final StructLayout LAYOUT$sampleLocationsInfo

SIZE$attachmentIndex

public static final long SIZE$attachmentIndex

SIZE$sampleLocationsInfo

public static final long SIZE$sampleLocationsInfo

OFFSET$attachmentIndex

public static final long OFFSET$attachmentIndex

OFFSET$sampleLocationsInfo

public static final long OFFSET$sampleLocationsInfo

Constructor Details

VkAttachmentSampleLocationsEXT

public VkAttachmentSampleLocationsEXT(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a VkAttachmentSampleLocationsEXT record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static VkAttachmentSampleLocationsEXT allocate(Arena arena)

allocate

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

clone

public static VkAttachmentSampleLocationsEXT clone(Arena arena,
 VkAttachmentSampleLocationsEXT src)

autoInit

public void autoInit()

attachmentIndex

@Unsigned
public int attachmentIndex()

attachmentIndex

public VkAttachmentSampleLocationsEXT attachmentIndex(@Unsigned
 int value)

sampleLocationsInfo

@NotNull
public @NotNull VkSampleLocationsInfoEXT sampleLocationsInfo()

sampleLocationsInfo

public VkAttachmentSampleLocationsEXT sampleLocationsInfo(@NotNull
 @NotNull VkSampleLocationsInfoEXT value)

sampleLocationsInfo

public VkAttachmentSampleLocationsEXT 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