Record Class XrBaseOutStructure

java.lang.Object

java.lang.Record

club.doki7.openxr.datatype.XrBaseOutStructure

All Implemented Interfaces:

IPointer, IXrBaseOutStructure

@ValueBasedCandidate
@UnsafeConstructor
public record XrBaseOutStructure(@NotNull MemorySegment segment)
extends Record
implements IXrBaseOutStructure

Represents a pointer to a XrBaseOutStructure structure in native memory.

Structure

typedef struct XrBaseOutStructure {
    XrStructureType type;
    XrBaseOutStructure* next;
} XrBaseOutStructure;

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:

• XrBaseOutStructure

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static XrBaseOutStructure	allocate(Arena arena)
static XrBaseOutStructure.Ptr	allocate(Arena arena, long count)
static XrBaseOutStructure	clone(Arena arena, XrBaseOutStructure 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.
@Nullable XrBaseOutStructure	next()
XrBaseOutStructure.Ptr	next(int assumedCount)
XrBaseOutStructure	next(@Nullable IXrBaseOutStructure value)
@NotNull MemorySegment	nextRaw()
void	nextRaw(@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()
XrBaseOutStructure	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

LAYOUT$type

public static final ValueLayout.OfInt LAYOUT$type

LAYOUT$next

public static final AddressLayout LAYOUT$next

SIZE$type

public static final long SIZE$type

SIZE$next

public static final long SIZE$next

OFFSET$type

public static final long OFFSET$type

OFFSET$next

public static final long OFFSET$next

Constructor Details

XrBaseOutStructure

public XrBaseOutStructure(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a XrBaseOutStructure record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static XrBaseOutStructure allocate(Arena arena)

allocate

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

clone

public static XrBaseOutStructure clone(Arena arena,
 XrBaseOutStructure src)

type

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

type

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

next

public XrBaseOutStructure next(@Nullable
 @Nullable IXrBaseOutStructure value)

next

@Unsafe
@Nullable
public XrBaseOutStructure.Ptr next(int assumedCount)

next

@Nullable
public @Nullable XrBaseOutStructure next()

nextRaw

@Pointer(target=XrBaseOutStructure.class)
@NotNull
public @NotNull MemorySegment nextRaw()

nextRaw

public void nextRaw(@Pointer(target=XrBaseOutStructure.class) @NotNull
 @NotNull MemorySegment 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