Record Class VkInputAttachmentAspectReference

java.lang.Object

java.lang.Record

club.doki7.vulkan.datatype.VkInputAttachmentAspectReference

All Implemented Interfaces:

IPointer, IVkInputAttachmentAspectReference

@ValueBasedCandidate
@UnsafeConstructor
public record VkInputAttachmentAspectReference(@NotNull MemorySegment segment)
extends Record
implements IVkInputAttachmentAspectReference

Represents a pointer to a VkInputAttachmentAspectReference structure in native memory.

Structure

typedef struct VkInputAttachmentAspectReference {
    uint32_t subpass;
    uint32_t inputAttachmentIndex;
    VkImageAspectFlags aspectMask;
} VkInputAttachmentAspectReference;

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:

• VkInputAttachmentAspectReference

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static VkInputAttachmentAspectReference	allocate(Arena arena)
static VkInputAttachmentAspectReference.Ptr	allocate(Arena arena, long count)
int	aspectMask()
VkInputAttachmentAspectReference	aspectMask(int value)
static VkInputAttachmentAspectReference	clone(Arena arena, VkInputAttachmentAspectReference 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	inputAttachmentIndex()
VkInputAttachmentAspectReference	inputAttachmentIndex(int value)
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
int	subpass()
VkInputAttachmentAspectReference	subpass(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$subpass

public static final MemoryLayout.PathElement PATH$subpass

PATH$inputAttachmentIndex

public static final MemoryLayout.PathElement PATH$inputAttachmentIndex

PATH$aspectMask

public static final MemoryLayout.PathElement PATH$aspectMask

LAYOUT$subpass

public static final ValueLayout.OfInt LAYOUT$subpass

LAYOUT$inputAttachmentIndex

public static final ValueLayout.OfInt LAYOUT$inputAttachmentIndex

LAYOUT$aspectMask

public static final ValueLayout.OfInt LAYOUT$aspectMask

SIZE$subpass

public static final long SIZE$subpass

SIZE$inputAttachmentIndex

public static final long SIZE$inputAttachmentIndex

SIZE$aspectMask

public static final long SIZE$aspectMask

OFFSET$subpass

public static final long OFFSET$subpass

OFFSET$inputAttachmentIndex

public static final long OFFSET$inputAttachmentIndex

OFFSET$aspectMask

public static final long OFFSET$aspectMask

Constructor Details

VkInputAttachmentAspectReference

public VkInputAttachmentAspectReference(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a VkInputAttachmentAspectReference record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static VkInputAttachmentAspectReference allocate(Arena arena)

allocate

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

clone

public static VkInputAttachmentAspectReference clone(Arena arena,
 VkInputAttachmentAspectReference src)

subpass

@Unsigned
public int subpass()

subpass

public VkInputAttachmentAspectReference subpass(@Unsigned
 int value)

inputAttachmentIndex

@Unsigned
public int inputAttachmentIndex()

inputAttachmentIndex

public VkInputAttachmentAspectReference inputAttachmentIndex(@Unsigned
 int value)

aspectMask

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

aspectMask

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