Record Class XrSpaceLocation

java.lang.Object

java.lang.Record

club.doki7.openxr.datatype.XrSpaceLocation

All Implemented Interfaces:

IPointer, IXrSpaceLocation

@ValueBasedCandidate
@UnsafeConstructor
public record XrSpaceLocation(@NotNull MemorySegment segment)
extends Record
implements IXrSpaceLocation

Represents a pointer to a XrSpaceLocation structure in native memory.

Structure

typedef struct XrSpaceLocation {
    XrStructureType type;
    void* next;
    XrSpaceLocationFlags locationFlags; // optional
    XrPosef pose;
} XrSpaceLocation;

Auto initialization

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

• type = XR_TYPE_SPACE_LOCATION

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:

• XrSpaceLocation

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static XrSpaceLocation	allocate(Arena arena)
static XrSpaceLocation.Ptr	allocate(Arena arena, long count)
void	autoInit()
static XrSpaceLocation	clone(Arena arena, XrSpaceLocation 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.
long	locationFlags()
XrSpaceLocation	locationFlags(long value)
@NotNull MemorySegment	next()
XrSpaceLocation	next(@Nullable IPointer pointer)
XrSpaceLocation	next(@NotNull MemorySegment value)
@NotNull XrPosef	pose()
XrSpaceLocation	pose(@NotNull XrPosef value)
XrSpaceLocation	pose(Consumer<@NotNull XrPosef> consumer)
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
final String	toString()	Returns a string representation of this record class.
int	type()
XrSpaceLocation	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$locationFlags

public static final MemoryLayout.PathElement PATH$locationFlags

PATH$pose

public static final MemoryLayout.PathElement PATH$pose

LAYOUT$type

public static final ValueLayout.OfInt LAYOUT$type

LAYOUT$next

public static final AddressLayout LAYOUT$next

LAYOUT$locationFlags

public static final ValueLayout.OfLong LAYOUT$locationFlags

LAYOUT$pose

public static final StructLayout LAYOUT$pose

SIZE$type

public static final long SIZE$type

SIZE$next

public static final long SIZE$next

SIZE$locationFlags

public static final long SIZE$locationFlags

SIZE$pose

public static final long SIZE$pose

OFFSET$type

public static final long OFFSET$type

OFFSET$next

public static final long OFFSET$next

OFFSET$locationFlags

public static final long OFFSET$locationFlags

OFFSET$pose

public static final long OFFSET$pose

Constructor Details

XrSpaceLocation

public XrSpaceLocation(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a XrSpaceLocation record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static XrSpaceLocation allocate(Arena arena)

allocate

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

clone

public static XrSpaceLocation clone(Arena arena,
 XrSpaceLocation src)

autoInit

public void autoInit()

type

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

type

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

next

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

next

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

next

public XrSpaceLocation next(@Nullable
 @Nullable IPointer pointer)

locationFlags

@Bitmask(XrSpaceLocationFlags.class)
public long locationFlags()

locationFlags

public XrSpaceLocation locationFlags(@Bitmask(XrSpaceLocationFlags.class)
 long value)

pose

@NotNull
public @NotNull XrPosef pose()

pose

public XrSpaceLocation pose(@NotNull
 @NotNull XrPosef value)

pose

public XrSpaceLocation pose(Consumer<@NotNull XrPosef> 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