Record Class XrPlaneDetectorLocationsEXT

java.lang.Object

java.lang.Record

club.doki7.openxr.datatype.XrPlaneDetectorLocationsEXT

All Implemented Interfaces:

IPointer, IXrPlaneDetectorLocationsEXT

@ValueBasedCandidate
@UnsafeConstructor
public record XrPlaneDetectorLocationsEXT(@NotNull MemorySegment segment)
extends Record
implements IXrPlaneDetectorLocationsEXT

Represents a pointer to a XrPlaneDetectorLocationsEXT structure in native memory.

Structure

typedef struct XrPlaneDetectorLocationsEXT {
    XrStructureType type;
    void* next;
    uint32_t planeLocationCapacityInput; // optional
    uint32_t planeLocationCountOutput; // optional
    XrPlaneDetectorLocationEXT* planeLocations; // optional
} XrPlaneDetectorLocationsEXT;

Auto initialization

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

• type = XR_TYPE_PLANE_DETECTOR_LOCATIONS_EXT

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:

• XrPlaneDetectorLocationsEXT

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static XrPlaneDetectorLocationsEXT	allocate(Arena arena)
static XrPlaneDetectorLocationsEXT.Ptr	allocate(Arena arena, long count)
void	autoInit()
static XrPlaneDetectorLocationsEXT	clone(Arena arena, XrPlaneDetectorLocationsEXT 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()
XrPlaneDetectorLocationsEXT	next(@Nullable IPointer pointer)
XrPlaneDetectorLocationsEXT	next(@NotNull MemorySegment value)
int	planeLocationCapacityInput()
XrPlaneDetectorLocationsEXT	planeLocationCapacityInput(int value)
int	planeLocationCountOutput()
XrPlaneDetectorLocationsEXT	planeLocationCountOutput(int value)
@Nullable XrPlaneDetectorLocationEXT	planeLocations()
XrPlaneDetectorLocationEXT.Ptr	planeLocations(int assumedCount)
XrPlaneDetectorLocationsEXT	planeLocations(@Nullable IXrPlaneDetectorLocationEXT value)
@NotNull MemorySegment	planeLocationsRaw()
void	planeLocationsRaw(@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()
XrPlaneDetectorLocationsEXT	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$planeLocationCapacityInput

public static final MemoryLayout.PathElement PATH$planeLocationCapacityInput

PATH$planeLocationCountOutput

public static final MemoryLayout.PathElement PATH$planeLocationCountOutput

PATH$planeLocations

public static final MemoryLayout.PathElement PATH$planeLocations

LAYOUT$type

public static final ValueLayout.OfInt LAYOUT$type

LAYOUT$next

public static final AddressLayout LAYOUT$next

LAYOUT$planeLocationCapacityInput

public static final ValueLayout.OfInt LAYOUT$planeLocationCapacityInput

LAYOUT$planeLocationCountOutput

public static final ValueLayout.OfInt LAYOUT$planeLocationCountOutput

LAYOUT$planeLocations

public static final AddressLayout LAYOUT$planeLocations

SIZE$type

public static final long SIZE$type

SIZE$next

public static final long SIZE$next

SIZE$planeLocationCapacityInput

public static final long SIZE$planeLocationCapacityInput

SIZE$planeLocationCountOutput

public static final long SIZE$planeLocationCountOutput

SIZE$planeLocations

public static final long SIZE$planeLocations

OFFSET$type

public static final long OFFSET$type

OFFSET$next

public static final long OFFSET$next

OFFSET$planeLocationCapacityInput

public static final long OFFSET$planeLocationCapacityInput

OFFSET$planeLocationCountOutput

public static final long OFFSET$planeLocationCountOutput

OFFSET$planeLocations

public static final long OFFSET$planeLocations

Constructor Details

XrPlaneDetectorLocationsEXT

public XrPlaneDetectorLocationsEXT(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a XrPlaneDetectorLocationsEXT record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static XrPlaneDetectorLocationsEXT allocate(Arena arena)

allocate

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

clone

public static XrPlaneDetectorLocationsEXT clone(Arena arena,
 XrPlaneDetectorLocationsEXT src)

autoInit

public void autoInit()

type

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

type

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

next

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

next

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

next

public XrPlaneDetectorLocationsEXT next(@Nullable
 @Nullable IPointer pointer)

planeLocationCapacityInput

@Unsigned
public int planeLocationCapacityInput()

planeLocationCapacityInput

public XrPlaneDetectorLocationsEXT planeLocationCapacityInput(@Unsigned
 int value)

planeLocationCountOutput

@Unsigned
public int planeLocationCountOutput()

planeLocationCountOutput

public XrPlaneDetectorLocationsEXT planeLocationCountOutput(@Unsigned
 int value)

planeLocations

public XrPlaneDetectorLocationsEXT planeLocations(@Nullable
 @Nullable IXrPlaneDetectorLocationEXT value)

planeLocations

@Unsafe
@Nullable
public XrPlaneDetectorLocationEXT.Ptr planeLocations(int assumedCount)

planeLocations

@Nullable
public @Nullable XrPlaneDetectorLocationEXT planeLocations()

planeLocationsRaw

@Pointer(target=XrPlaneDetectorLocationEXT.class)
@NotNull
public @NotNull MemorySegment planeLocationsRaw()

planeLocationsRaw

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