Record Class VkAttachmentReference2

java.lang.Object

java.lang.Record

club.doki7.vulkan.datatype.VkAttachmentReference2

All Implemented Interfaces:

IPointer, IVkAttachmentReference2

@ValueBasedCandidate
@UnsafeConstructor
public record VkAttachmentReference2(@NotNull MemorySegment segment)
extends Record
implements IVkAttachmentReference2

Represents a pointer to a VkAttachmentReference2 structure in native memory.

Structure

typedef struct VkAttachmentReference2 {
    VkStructureType sType;
    void const* pNext; // optional
    uint32_t attachment;
    VkImageLayout layout;
    VkImageAspectFlags aspectMask;
} VkAttachmentReference2;

Auto initialization

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

• sType = VK_STRUCTURE_TYPE_ATTACHMENT_REFERENCE_2

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:

• VkAttachmentReference2

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	VkAttachmentReference2.Ptr	Represents a pointer to / an array of VkAttachmentReference2 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$aspectMask
static final ValueLayout.OfInt	LAYOUT$attachment
static final ValueLayout.OfInt	LAYOUT$layout
static final AddressLayout	LAYOUT$pNext
static final ValueLayout.OfInt	LAYOUT$sType
static final long	OFFSET$aspectMask
static final long	OFFSET$attachment
static final long	OFFSET$layout
static final long	OFFSET$pNext
static final long	OFFSET$sType
static final MemoryLayout.PathElement	PATH$aspectMask
static final MemoryLayout.PathElement	PATH$attachment
static final MemoryLayout.PathElement	PATH$layout
static final MemoryLayout.PathElement	PATH$pNext
static final MemoryLayout.PathElement	PATH$sType
static final long	SIZE$aspectMask
static final long	SIZE$attachment
static final long	SIZE$layout
static final long	SIZE$pNext
static final long	SIZE$sType

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static VkAttachmentReference2	allocate(Arena arena)
static VkAttachmentReference2.Ptr	allocate(Arena arena, long count)
int	aspectMask()
VkAttachmentReference2	aspectMask(int value)
int	attachment()
VkAttachmentReference2	attachment(int value)
void	autoInit()
static VkAttachmentReference2	clone(Arena arena, VkAttachmentReference2 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.
int	layout()
VkAttachmentReference2	layout(int value)
@NotNull MemorySegment	pNext()
VkAttachmentReference2	pNext(@Nullable IPointer pointer)
VkAttachmentReference2	pNext(@NotNull MemorySegment value)
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
int	sType()
VkAttachmentReference2	sType(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$sType

public static final MemoryLayout.PathElement PATH$sType

PATH$pNext

public static final MemoryLayout.PathElement PATH$pNext

PATH$attachment

public static final MemoryLayout.PathElement PATH$attachment

PATH$layout

public static final MemoryLayout.PathElement PATH$layout

PATH$aspectMask

public static final MemoryLayout.PathElement PATH$aspectMask

LAYOUT$sType

public static final ValueLayout.OfInt LAYOUT$sType

LAYOUT$pNext

public static final AddressLayout LAYOUT$pNext

LAYOUT$attachment

public static final ValueLayout.OfInt LAYOUT$attachment

LAYOUT$layout

public static final ValueLayout.OfInt LAYOUT$layout

LAYOUT$aspectMask

public static final ValueLayout.OfInt LAYOUT$aspectMask

SIZE$sType

public static final long SIZE$sType

SIZE$pNext

public static final long SIZE$pNext

SIZE$attachment

public static final long SIZE$attachment

SIZE$layout

public static final long SIZE$layout

SIZE$aspectMask

public static final long SIZE$aspectMask

OFFSET$sType

public static final long OFFSET$sType

OFFSET$pNext

public static final long OFFSET$pNext

OFFSET$attachment

public static final long OFFSET$attachment

OFFSET$layout

public static final long OFFSET$layout

OFFSET$aspectMask

public static final long OFFSET$aspectMask

Constructor Details

VkAttachmentReference2

public VkAttachmentReference2(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a VkAttachmentReference2 record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static VkAttachmentReference2 allocate(Arena arena)

allocate

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

clone

public static VkAttachmentReference2 clone(Arena arena,
 VkAttachmentReference2 src)

autoInit

public void autoInit()

sType

@EnumType(VkStructureType.class)
public int sType()

sType

public VkAttachmentReference2 sType(@EnumType(VkStructureType.class)
 int value)

pNext

@Pointer(comment="void*")
@NotNull
public @NotNull MemorySegment pNext()

pNext

public VkAttachmentReference2 pNext(@Pointer(comment="void*") @NotNull
 @NotNull MemorySegment value)

pNext

public VkAttachmentReference2 pNext(@Nullable
 @Nullable IPointer pointer)

attachment

@Unsigned
public int attachment()

attachment

public VkAttachmentReference2 attachment(@Unsigned
 int value)

layout

@EnumType(VkImageLayout.class)
public int layout()

layout

public VkAttachmentReference2 layout(@EnumType(VkImageLayout.class)
 int value)

aspectMask

@Bitmask(VkImageAspectFlags.class)
public int aspectMask()

aspectMask

public VkAttachmentReference2 aspectMask(@Bitmask(VkImageAspectFlags.class)
 int 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