Record Class XrSpacesLocateInfo

java.lang.Object

java.lang.Record

club.doki7.openxr.datatype.XrSpacesLocateInfo

All Implemented Interfaces:

IPointer, IXrSpacesLocateInfo

@ValueBasedCandidate
@UnsafeConstructor
public record XrSpacesLocateInfo(@NotNull MemorySegment segment)
extends Record
implements IXrSpacesLocateInfo

Represents a pointer to a XrSpacesLocateInfo structure in native memory.

Structure

typedef struct XrSpacesLocateInfo {
    XrStructureType type;
    void const* next;
    XrSpace baseSpace;
    XrTime time;
    uint32_t spaceCount;
    XrSpace const* spaces;
} XrSpacesLocateInfo;

Auto initialization

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

• type = XR_TYPE_SPACES_LOCATE_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:

• XrSpacesLocateInfo

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static XrSpacesLocateInfo	allocate(Arena arena)
static XrSpacesLocateInfo.Ptr	allocate(Arena arena, long count)
void	autoInit()
@Nullable XrSpace	baseSpace()
XrSpacesLocateInfo	baseSpace(@Nullable XrSpace value)
static XrSpacesLocateInfo	clone(Arena arena, XrSpacesLocateInfo 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()
XrSpacesLocateInfo	next(@Nullable IPointer pointer)
XrSpacesLocateInfo	next(@NotNull MemorySegment value)
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
int	spaceCount()
XrSpacesLocateInfo	spaceCount(int value)
XrSpace.Ptr	spaces()	Note: the returned XrSpace.Ptr does not have correct XrSpace.Ptr.size() property.
XrSpacesLocateInfo	spaces(XrSpace.Ptr value)
@NotNull MemorySegment	spacesRaw()
void	spacesRaw(@NotNull MemorySegment value)
long	time()
XrSpacesLocateInfo	time(long value)
final String	toString()	Returns a string representation of this record class.
int	type()
XrSpacesLocateInfo	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$baseSpace

public static final MemoryLayout.PathElement PATH$baseSpace

PATH$time

public static final MemoryLayout.PathElement PATH$time

PATH$spaceCount

public static final MemoryLayout.PathElement PATH$spaceCount

PATH$spaces

public static final MemoryLayout.PathElement PATH$spaces

LAYOUT$type

public static final ValueLayout.OfInt LAYOUT$type

LAYOUT$next

public static final AddressLayout LAYOUT$next

LAYOUT$baseSpace

public static final AddressLayout LAYOUT$baseSpace

LAYOUT$time

public static final ValueLayout.OfLong LAYOUT$time

LAYOUT$spaceCount

public static final ValueLayout.OfInt LAYOUT$spaceCount

LAYOUT$spaces

public static final AddressLayout LAYOUT$spaces

SIZE$type

public static final long SIZE$type

SIZE$next

public static final long SIZE$next

SIZE$baseSpace

public static final long SIZE$baseSpace

SIZE$time

public static final long SIZE$time

SIZE$spaceCount

public static final long SIZE$spaceCount

SIZE$spaces

public static final long SIZE$spaces

OFFSET$type

public static final long OFFSET$type

OFFSET$next

public static final long OFFSET$next

OFFSET$baseSpace

public static final long OFFSET$baseSpace

OFFSET$time

public static final long OFFSET$time

OFFSET$spaceCount

public static final long OFFSET$spaceCount

OFFSET$spaces

public static final long OFFSET$spaces

Constructor Details

XrSpacesLocateInfo

public XrSpacesLocateInfo(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a XrSpacesLocateInfo record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static XrSpacesLocateInfo allocate(Arena arena)

allocate

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

clone

public static XrSpacesLocateInfo clone(Arena arena,
 XrSpacesLocateInfo src)

autoInit

public void autoInit()

type

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

type

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

next

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

next

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

next

public XrSpacesLocateInfo next(@Nullable
 @Nullable IPointer pointer)

baseSpace

@Nullable
public @Nullable XrSpace baseSpace()

baseSpace

public XrSpacesLocateInfo baseSpace(@Nullable
 @Nullable XrSpace value)

time

@NativeType("XrTime")
public long time()

time

public XrSpacesLocateInfo time(@NativeType("XrTime")
 long value)

spaceCount

@Unsigned
public int spaceCount()

spaceCount

public XrSpacesLocateInfo spaceCount(@Unsigned
 int value)

spaces

@Nullable
public XrSpace.Ptr spaces()

Note: the returned XrSpace.Ptr does not have correct XrSpace.Ptr.size() property. It's up to user to track the size of the buffer, and use XrSpace.Ptr.reinterpret(long) to set the size before actually reading from or writing to the buffer.

spaces

public XrSpacesLocateInfo spaces(@Nullable
 XrSpace.Ptr value)

spacesRaw

@Pointer(target=XrSpace.class)
@NotNull
public @NotNull MemorySegment spacesRaw()

spacesRaw

public void spacesRaw(@Pointer(target=XrSpace.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