Record Class XrSpaceLocations

java.lang.Object

java.lang.Record

club.doki7.openxr.datatype.XrSpaceLocations

All Implemented Interfaces:

IPointer, IXrSpaceLocations

@ValueBasedCandidate
@UnsafeConstructor
public record XrSpaceLocations(@NotNull MemorySegment segment)
extends Record
implements IXrSpaceLocations

Represents a pointer to a XrSpaceLocations structure in native memory.

Structure

typedef struct XrSpaceLocations {
    XrStructureType type;
    void* next;
    uint32_t locationCount;
    XrSpaceLocationData* locations;
} XrSpaceLocations;

Auto initialization

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

• type = XR_TYPE_SPACE_LOCATIONS

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:

• XrSpaceLocations

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static XrSpaceLocations	allocate(Arena arena)
static XrSpaceLocations.Ptr	allocate(Arena arena, long count)
void	autoInit()
static XrSpaceLocations	clone(Arena arena, XrSpaceLocations 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.
int	locationCount()
XrSpaceLocations	locationCount(int value)
@Nullable XrSpaceLocationData	locations()
XrSpaceLocationData.Ptr	locations(int assumedCount)
XrSpaceLocations	locations(@Nullable IXrSpaceLocationData value)
@NotNull MemorySegment	locationsRaw()
void	locationsRaw(@NotNull MemorySegment value)
@NotNull MemorySegment	next()
XrSpaceLocations	next(@Nullable IPointer pointer)
XrSpaceLocations	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()
XrSpaceLocations	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$locationCount

public static final MemoryLayout.PathElement PATH$locationCount

PATH$locations

public static final MemoryLayout.PathElement PATH$locations

LAYOUT$type

public static final ValueLayout.OfInt LAYOUT$type

LAYOUT$next

public static final AddressLayout LAYOUT$next

LAYOUT$locationCount

public static final ValueLayout.OfInt LAYOUT$locationCount

LAYOUT$locations

public static final AddressLayout LAYOUT$locations

SIZE$type

public static final long SIZE$type

SIZE$next

public static final long SIZE$next

SIZE$locationCount

public static final long SIZE$locationCount

SIZE$locations

public static final long SIZE$locations

OFFSET$type

public static final long OFFSET$type

OFFSET$next

public static final long OFFSET$next

OFFSET$locationCount

public static final long OFFSET$locationCount

OFFSET$locations

public static final long OFFSET$locations

Constructor Details

XrSpaceLocations

public XrSpaceLocations(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a XrSpaceLocations record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static XrSpaceLocations allocate(Arena arena)

allocate

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

clone

public static XrSpaceLocations clone(Arena arena,
 XrSpaceLocations src)

autoInit

public void autoInit()

type

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

type

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

next

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

next

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

next

public XrSpaceLocations next(@Nullable
 @Nullable IPointer pointer)

locationCount

@Unsigned
public int locationCount()

locationCount

public XrSpaceLocations locationCount(@Unsigned
 int value)

locations

public XrSpaceLocations locations(@Nullable
 @Nullable IXrSpaceLocationData value)

locations

@Unsafe
@Nullable
public XrSpaceLocationData.Ptr locations(int assumedCount)

locations

@Nullable
public @Nullable XrSpaceLocationData locations()

locationsRaw

@Pointer(target=XrSpaceLocationData.class)
@NotNull
public @NotNull MemorySegment locationsRaw()

locationsRaw

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