Record Class XrViewLocateInfo

java.lang.Object

java.lang.Record

club.doki7.openxr.datatype.XrViewLocateInfo

All Implemented Interfaces:

IPointer, IXrViewLocateInfo

@ValueBasedCandidate
@UnsafeConstructor
public record XrViewLocateInfo(@NotNull MemorySegment segment)
extends Record
implements IXrViewLocateInfo

Represents a pointer to a XrViewLocateInfo structure in native memory.

Structure

typedef struct XrViewLocateInfo {
    XrStructureType type;
    void const* next;
    XrViewConfigurationType viewConfigurationType;
    XrTime displayTime;
    XrSpace space;
} XrViewLocateInfo;

Auto initialization

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

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

• XrViewLocateInfo

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	XrViewLocateInfo.Ptr	Represents a pointer to / an array of XrViewLocateInfo structure(s) in native memory.

Field Summary

Fields

Modifier and Type	Field	Description
static final long	BYTES
static final StructLayout	LAYOUT
static final ValueLayout.OfLong	LAYOUT$displayTime
static final AddressLayout	LAYOUT$next
static final AddressLayout	LAYOUT$space
static final ValueLayout.OfInt	LAYOUT$type
static final ValueLayout.OfInt	LAYOUT$viewConfigurationType
static final long	OFFSET$displayTime
static final long	OFFSET$next
static final long	OFFSET$space
static final long	OFFSET$type
static final long	OFFSET$viewConfigurationType
static final MemoryLayout.PathElement	PATH$displayTime
static final MemoryLayout.PathElement	PATH$next
static final MemoryLayout.PathElement	PATH$space
static final MemoryLayout.PathElement	PATH$type
static final MemoryLayout.PathElement	PATH$viewConfigurationType
static final long	SIZE$displayTime
static final long	SIZE$next
static final long	SIZE$space
static final long	SIZE$type
static final long	SIZE$viewConfigurationType

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static XrViewLocateInfo	allocate(Arena arena)
static XrViewLocateInfo.Ptr	allocate(Arena arena, long count)
void	autoInit()
static XrViewLocateInfo	clone(Arena arena, XrViewLocateInfo src)
long	displayTime()
XrViewLocateInfo	displayTime(long value)
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()
XrViewLocateInfo	next(@Nullable IPointer pointer)
XrViewLocateInfo	next(@NotNull MemorySegment value)
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
@Nullable XrSpace	space()
XrViewLocateInfo	space(@Nullable XrSpace value)
final String	toString()	Returns a string representation of this record class.
int	type()
XrViewLocateInfo	type(int value)
int	viewConfigurationType()
XrViewLocateInfo	viewConfigurationType(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$viewConfigurationType

public static final MemoryLayout.PathElement PATH$viewConfigurationType

PATH$displayTime

public static final MemoryLayout.PathElement PATH$displayTime

PATH$space

public static final MemoryLayout.PathElement PATH$space

LAYOUT$type

public static final ValueLayout.OfInt LAYOUT$type

LAYOUT$next

public static final AddressLayout LAYOUT$next

LAYOUT$viewConfigurationType

public static final ValueLayout.OfInt LAYOUT$viewConfigurationType

LAYOUT$displayTime

public static final ValueLayout.OfLong LAYOUT$displayTime

LAYOUT$space

public static final AddressLayout LAYOUT$space

SIZE$type

public static final long SIZE$type

SIZE$next

public static final long SIZE$next

SIZE$viewConfigurationType

public static final long SIZE$viewConfigurationType

SIZE$displayTime

public static final long SIZE$displayTime

SIZE$space

public static final long SIZE$space

OFFSET$type

public static final long OFFSET$type

OFFSET$next

public static final long OFFSET$next

OFFSET$viewConfigurationType

public static final long OFFSET$viewConfigurationType

OFFSET$displayTime

public static final long OFFSET$displayTime

OFFSET$space

public static final long OFFSET$space

Constructor Details

XrViewLocateInfo

public XrViewLocateInfo(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a XrViewLocateInfo record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static XrViewLocateInfo allocate(Arena arena)

allocate

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

clone

public static XrViewLocateInfo clone(Arena arena,
 XrViewLocateInfo src)

autoInit

public void autoInit()

type

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

type

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

next

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

next

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

next

public XrViewLocateInfo next(@Nullable
 @Nullable IPointer pointer)

viewConfigurationType

@EnumType(XrViewConfigurationType.class)
public int viewConfigurationType()

viewConfigurationType

public XrViewLocateInfo viewConfigurationType(@EnumType(XrViewConfigurationType.class)
 int value)

displayTime

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

displayTime

public XrViewLocateInfo displayTime(@NativeType("XrTime")
 long value)

space

@Nullable
public @Nullable XrSpace space()

space

public XrViewLocateInfo space(@Nullable
 @Nullable XrSpace 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