Record Class XrSceneComponentLocationMSFT

java.lang.Object

java.lang.Record

club.doki7.openxr.datatype.XrSceneComponentLocationMSFT

All Implemented Interfaces:

IPointer, IXrSceneComponentLocationMSFT

@ValueBasedCandidate
@UnsafeConstructor
public record XrSceneComponentLocationMSFT(@NotNull MemorySegment segment)
extends Record
implements IXrSceneComponentLocationMSFT

Represents a pointer to a XrSceneComponentLocationMSFT structure in native memory.

Structure

typedef struct XrSceneComponentLocationMSFT {
    XrSpaceLocationFlags flags; // optional
    XrPosef pose;
} XrSceneComponentLocationMSFT;

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:

• XrSceneComponentLocationMSFT

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	XrSceneComponentLocationMSFT.Ptr	Represents a pointer to / an array of XrSceneComponentLocationMSFT 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$flags
static final StructLayout	LAYOUT$pose
static final long	OFFSET$flags
static final long	OFFSET$pose
static final MemoryLayout.PathElement	PATH$flags
static final MemoryLayout.PathElement	PATH$pose
static final long	SIZE$flags
static final long	SIZE$pose

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static XrSceneComponentLocationMSFT	allocate(Arena arena)
static XrSceneComponentLocationMSFT.Ptr	allocate(Arena arena, long count)
static XrSceneComponentLocationMSFT	clone(Arena arena, XrSceneComponentLocationMSFT src)
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
long	flags()
XrSceneComponentLocationMSFT	flags(long value)
final int	hashCode()	Returns a hash code value for this object.
@NotNull XrPosef	pose()
XrSceneComponentLocationMSFT	pose(@NotNull XrPosef value)
XrSceneComponentLocationMSFT	pose(Consumer<@NotNull XrPosef> consumer)
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
final String	toString()	Returns a string representation of this record class.

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$flags

public static final MemoryLayout.PathElement PATH$flags

PATH$pose

public static final MemoryLayout.PathElement PATH$pose

LAYOUT$flags

public static final ValueLayout.OfLong LAYOUT$flags

LAYOUT$pose

public static final StructLayout LAYOUT$pose

SIZE$flags

public static final long SIZE$flags

SIZE$pose

public static final long SIZE$pose

OFFSET$flags

public static final long OFFSET$flags

OFFSET$pose

public static final long OFFSET$pose

Constructor Details

XrSceneComponentLocationMSFT

public XrSceneComponentLocationMSFT(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a XrSceneComponentLocationMSFT record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static XrSceneComponentLocationMSFT allocate(Arena arena)

allocate

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

clone

public static XrSceneComponentLocationMSFT clone(Arena arena,
 XrSceneComponentLocationMSFT src)

flags

@Bitmask(XrSpaceLocationFlags.class)
public long flags()

flags

public XrSceneComponentLocationMSFT flags(@Bitmask(XrSpaceLocationFlags.class)
 long value)

pose

@NotNull
public @NotNull XrPosef pose()

pose

public XrSceneComponentLocationMSFT pose(@NotNull
 @NotNull XrPosef value)

pose

public XrSceneComponentLocationMSFT pose(Consumer<@NotNull XrPosef> consumer)

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