Record Class XrReferenceSpaceCreateInfo

java.lang.Object

java.lang.Record

club.doki7.openxr.datatype.XrReferenceSpaceCreateInfo

All Implemented Interfaces:

IPointer, IXrReferenceSpaceCreateInfo

@ValueBasedCandidate
@UnsafeConstructor
public record XrReferenceSpaceCreateInfo(@NotNull MemorySegment segment)
extends Record
implements IXrReferenceSpaceCreateInfo

Represents a pointer to a XrReferenceSpaceCreateInfo structure in native memory.

Structure

typedef struct XrReferenceSpaceCreateInfo {
    XrStructureType type;
    void const* next;
    XrReferenceSpaceType referenceSpaceType;
    XrPosef poseInReferenceSpace;
} XrReferenceSpaceCreateInfo;

Auto initialization

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

• type = XR_TYPE_REFERENCE_SPACE_CREATE_INFO

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:

• XrReferenceSpaceCreateInfo

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static XrReferenceSpaceCreateInfo	allocate(Arena arena)
static XrReferenceSpaceCreateInfo.Ptr	allocate(Arena arena, long count)
void	autoInit()
static XrReferenceSpaceCreateInfo	clone(Arena arena, XrReferenceSpaceCreateInfo 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.
@NotNull MemorySegment	next()
XrReferenceSpaceCreateInfo	next(@Nullable IPointer pointer)
XrReferenceSpaceCreateInfo	next(@NotNull MemorySegment value)
@NotNull XrPosef	poseInReferenceSpace()
XrReferenceSpaceCreateInfo	poseInReferenceSpace(@NotNull XrPosef value)
XrReferenceSpaceCreateInfo	poseInReferenceSpace(Consumer<@NotNull XrPosef> consumer)
int	referenceSpaceType()
XrReferenceSpaceCreateInfo	referenceSpaceType(int 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()
XrReferenceSpaceCreateInfo	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$referenceSpaceType

public static final MemoryLayout.PathElement PATH$referenceSpaceType

PATH$poseInReferenceSpace

public static final MemoryLayout.PathElement PATH$poseInReferenceSpace

LAYOUT$type

public static final ValueLayout.OfInt LAYOUT$type

LAYOUT$next

public static final AddressLayout LAYOUT$next

LAYOUT$referenceSpaceType

public static final ValueLayout.OfInt LAYOUT$referenceSpaceType

LAYOUT$poseInReferenceSpace

public static final StructLayout LAYOUT$poseInReferenceSpace

SIZE$type

public static final long SIZE$type

SIZE$next

public static final long SIZE$next

SIZE$referenceSpaceType

public static final long SIZE$referenceSpaceType

SIZE$poseInReferenceSpace

public static final long SIZE$poseInReferenceSpace

OFFSET$type

public static final long OFFSET$type

OFFSET$next

public static final long OFFSET$next

OFFSET$referenceSpaceType

public static final long OFFSET$referenceSpaceType

OFFSET$poseInReferenceSpace

public static final long OFFSET$poseInReferenceSpace

Constructor Details

XrReferenceSpaceCreateInfo

public XrReferenceSpaceCreateInfo(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a XrReferenceSpaceCreateInfo record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static XrReferenceSpaceCreateInfo allocate(Arena arena)

allocate

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

clone

public static XrReferenceSpaceCreateInfo clone(Arena arena,
 XrReferenceSpaceCreateInfo src)

autoInit

public void autoInit()

type

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

type

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

next

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

next

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

next

public XrReferenceSpaceCreateInfo next(@Nullable
 @Nullable IPointer pointer)

referenceSpaceType

@EnumType(XrReferenceSpaceType.class)
public int referenceSpaceType()

referenceSpaceType

public XrReferenceSpaceCreateInfo referenceSpaceType(@EnumType(XrReferenceSpaceType.class)
 int value)

poseInReferenceSpace

@NotNull
public @NotNull XrPosef poseInReferenceSpace()

poseInReferenceSpace

public XrReferenceSpaceCreateInfo poseInReferenceSpace(@NotNull
 @NotNull XrPosef value)

poseInReferenceSpace

public XrReferenceSpaceCreateInfo poseInReferenceSpace(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