Record Class XrSpaceQueryResultsFB

java.lang.Object

java.lang.Record

club.doki7.openxr.datatype.XrSpaceQueryResultsFB

All Implemented Interfaces:

IPointer, IXrSpaceQueryResultsFB

@ValueBasedCandidate
@UnsafeConstructor
public record XrSpaceQueryResultsFB(@NotNull MemorySegment segment)
extends Record
implements IXrSpaceQueryResultsFB

Represents a pointer to a XrSpaceQueryResultsFB structure in native memory.

Structure

typedef struct XrSpaceQueryResultsFB {
    XrStructureType type;
    void* next;
    uint32_t resultCapacityInput; // optional
    uint32_t resultCountOutput; // optional
    XrSpaceQueryResultFB* results; // optional
} XrSpaceQueryResultsFB;

Auto initialization

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

• type = XR_TYPE_SPACE_QUERY_RESULTS_FB

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:

• XrSpaceQueryResultsFB

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static XrSpaceQueryResultsFB	allocate(Arena arena)
static XrSpaceQueryResultsFB.Ptr	allocate(Arena arena, long count)
void	autoInit()
static XrSpaceQueryResultsFB	clone(Arena arena, XrSpaceQueryResultsFB 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()
XrSpaceQueryResultsFB	next(@Nullable IPointer pointer)
XrSpaceQueryResultsFB	next(@NotNull MemorySegment value)
int	resultCapacityInput()
XrSpaceQueryResultsFB	resultCapacityInput(int value)
int	resultCountOutput()
XrSpaceQueryResultsFB	resultCountOutput(int value)
@Nullable XrSpaceQueryResultFB	results()
XrSpaceQueryResultFB.Ptr	results(int assumedCount)
XrSpaceQueryResultsFB	results(@Nullable IXrSpaceQueryResultFB value)
@NotNull MemorySegment	resultsRaw()
void	resultsRaw(@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()
XrSpaceQueryResultsFB	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$resultCapacityInput

public static final MemoryLayout.PathElement PATH$resultCapacityInput

PATH$resultCountOutput

public static final MemoryLayout.PathElement PATH$resultCountOutput

PATH$results

public static final MemoryLayout.PathElement PATH$results

LAYOUT$type

public static final ValueLayout.OfInt LAYOUT$type

LAYOUT$next

public static final AddressLayout LAYOUT$next

LAYOUT$resultCapacityInput

public static final ValueLayout.OfInt LAYOUT$resultCapacityInput

LAYOUT$resultCountOutput

public static final ValueLayout.OfInt LAYOUT$resultCountOutput

LAYOUT$results

public static final AddressLayout LAYOUT$results

SIZE$type

public static final long SIZE$type

SIZE$next

public static final long SIZE$next

SIZE$resultCapacityInput

public static final long SIZE$resultCapacityInput

SIZE$resultCountOutput

public static final long SIZE$resultCountOutput

SIZE$results

public static final long SIZE$results

OFFSET$type

public static final long OFFSET$type

OFFSET$next

public static final long OFFSET$next

OFFSET$resultCapacityInput

public static final long OFFSET$resultCapacityInput

OFFSET$resultCountOutput

public static final long OFFSET$resultCountOutput

OFFSET$results

public static final long OFFSET$results

Constructor Details

XrSpaceQueryResultsFB

public XrSpaceQueryResultsFB(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a XrSpaceQueryResultsFB record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static XrSpaceQueryResultsFB allocate(Arena arena)

allocate

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

clone

public static XrSpaceQueryResultsFB clone(Arena arena,
 XrSpaceQueryResultsFB src)

autoInit

public void autoInit()

type

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

type

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

next

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

next

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

next

public XrSpaceQueryResultsFB next(@Nullable
 @Nullable IPointer pointer)

resultCapacityInput

@Unsigned
public int resultCapacityInput()

resultCapacityInput

public XrSpaceQueryResultsFB resultCapacityInput(@Unsigned
 int value)

resultCountOutput

@Unsigned
public int resultCountOutput()

resultCountOutput

public XrSpaceQueryResultsFB resultCountOutput(@Unsigned
 int value)

results

public XrSpaceQueryResultsFB results(@Nullable
 @Nullable IXrSpaceQueryResultFB value)

results

@Unsafe
@Nullable
public XrSpaceQueryResultFB.Ptr results(int assumedCount)

results

@Nullable
public @Nullable XrSpaceQueryResultFB results()

resultsRaw

@Pointer(target=XrSpaceQueryResultFB.class)
@NotNull
public @NotNull MemorySegment resultsRaw()

resultsRaw

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