Record Class XrFutureCompletionBaseHeaderEXT

java.lang.Object

java.lang.Record

club.doki7.openxr.datatype.XrFutureCompletionBaseHeaderEXT

All Implemented Interfaces:

IPointer, IXrFutureCompletionBaseHeaderEXT

@ValueBasedCandidate
@UnsafeConstructor
public record XrFutureCompletionBaseHeaderEXT(@NotNull MemorySegment segment)
extends Record
implements IXrFutureCompletionBaseHeaderEXT

Represents a pointer to a XrFutureCompletionBaseHeaderEXT structure in native memory.

Structure

typedef struct XrFutureCompletionBaseHeaderEXT {
    XrStructureType type;
    void* next;
    XrResult futureResult;
} XrFutureCompletionBaseHeaderEXT;

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:

• XrFutureCompletionBaseHeaderEXT

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static XrFutureCompletionBaseHeaderEXT	allocate(Arena arena)
static XrFutureCompletionBaseHeaderEXT.Ptr	allocate(Arena arena, long count)
static XrFutureCompletionBaseHeaderEXT	clone(Arena arena, XrFutureCompletionBaseHeaderEXT src)
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
int	futureResult()
XrFutureCompletionBaseHeaderEXT	futureResult(int value)
final int	hashCode()	Returns a hash code value for this object.
@NotNull MemorySegment	next()
XrFutureCompletionBaseHeaderEXT	next(@Nullable IPointer pointer)
XrFutureCompletionBaseHeaderEXT	next(@NotNull MemorySegment value)
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
final String	toString()	Returns a string representation of this record class.
int	type()
XrFutureCompletionBaseHeaderEXT	type(int value)

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$type

public static final MemoryLayout.PathElement PATH$type

PATH$next

public static final MemoryLayout.PathElement PATH$next

PATH$futureResult

public static final MemoryLayout.PathElement PATH$futureResult

LAYOUT$type

public static final ValueLayout.OfInt LAYOUT$type

LAYOUT$next

public static final AddressLayout LAYOUT$next

LAYOUT$futureResult

public static final ValueLayout.OfInt LAYOUT$futureResult

SIZE$type

public static final long SIZE$type

SIZE$next

public static final long SIZE$next

SIZE$futureResult

public static final long SIZE$futureResult

OFFSET$type

public static final long OFFSET$type

OFFSET$next

public static final long OFFSET$next

OFFSET$futureResult

public static final long OFFSET$futureResult

Constructor Details

XrFutureCompletionBaseHeaderEXT

public XrFutureCompletionBaseHeaderEXT(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a XrFutureCompletionBaseHeaderEXT record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static XrFutureCompletionBaseHeaderEXT allocate(Arena arena)

allocate

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

clone

public static XrFutureCompletionBaseHeaderEXT clone(Arena arena,
 XrFutureCompletionBaseHeaderEXT src)

type

@EnumType(XrStructureType.class)
public int type()

type

public XrFutureCompletionBaseHeaderEXT type(@EnumType(XrStructureType.class)
 int value)

next

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

next

public XrFutureCompletionBaseHeaderEXT next(@Pointer(comment="void*") @NotNull
 @NotNull MemorySegment value)

next

public XrFutureCompletionBaseHeaderEXT next(@Nullable
 @Nullable IPointer pointer)

futureResult

@EnumType(XrResult.class)
public int futureResult()

futureResult

public XrFutureCompletionBaseHeaderEXT futureResult(@EnumType(XrResult.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