Record Class XrSpaceVelocity

java.lang.Object

java.lang.Record

club.doki7.openxr.datatype.XrSpaceVelocity

All Implemented Interfaces:

IPointer, IXrSpaceVelocity

@ValueBasedCandidate
@UnsafeConstructor
public record XrSpaceVelocity(@NotNull MemorySegment segment)
extends Record
implements IXrSpaceVelocity

Represents a pointer to a XrSpaceVelocity structure in native memory.

Structure

typedef struct XrSpaceVelocity {
    XrStructureType type;
    void* next;
    XrSpaceVelocityFlags velocityFlags; // optional
    XrVector3f linearVelocity;
    XrVector3f angularVelocity;
} XrSpaceVelocity;

Auto initialization

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

• type = XR_TYPE_SPACE_VELOCITY

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:

• XrSpaceVelocity

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static XrSpaceVelocity	allocate(Arena arena)
static XrSpaceVelocity.Ptr	allocate(Arena arena, long count)
@NotNull XrVector3f	angularVelocity()
XrSpaceVelocity	angularVelocity(@NotNull XrVector3f value)
XrSpaceVelocity	angularVelocity(Consumer<@NotNull XrVector3f> consumer)
void	autoInit()
static XrSpaceVelocity	clone(Arena arena, XrSpaceVelocity 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 XrVector3f	linearVelocity()
XrSpaceVelocity	linearVelocity(@NotNull XrVector3f value)
XrSpaceVelocity	linearVelocity(Consumer<@NotNull XrVector3f> consumer)
@NotNull MemorySegment	next()
XrSpaceVelocity	next(@Nullable IPointer pointer)
XrSpaceVelocity	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()
XrSpaceVelocity	type(int value)
long	velocityFlags()
XrSpaceVelocity	velocityFlags(long 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$velocityFlags

public static final MemoryLayout.PathElement PATH$velocityFlags

PATH$linearVelocity

public static final MemoryLayout.PathElement PATH$linearVelocity

PATH$angularVelocity

public static final MemoryLayout.PathElement PATH$angularVelocity

LAYOUT$type

public static final ValueLayout.OfInt LAYOUT$type

LAYOUT$next

public static final AddressLayout LAYOUT$next

LAYOUT$velocityFlags

public static final ValueLayout.OfLong LAYOUT$velocityFlags

LAYOUT$linearVelocity

public static final StructLayout LAYOUT$linearVelocity

LAYOUT$angularVelocity

public static final StructLayout LAYOUT$angularVelocity

SIZE$type

public static final long SIZE$type

SIZE$next

public static final long SIZE$next

SIZE$velocityFlags

public static final long SIZE$velocityFlags

SIZE$linearVelocity

public static final long SIZE$linearVelocity

SIZE$angularVelocity

public static final long SIZE$angularVelocity

OFFSET$type

public static final long OFFSET$type

OFFSET$next

public static final long OFFSET$next

OFFSET$velocityFlags

public static final long OFFSET$velocityFlags

OFFSET$linearVelocity

public static final long OFFSET$linearVelocity

OFFSET$angularVelocity

public static final long OFFSET$angularVelocity

Constructor Details

XrSpaceVelocity

public XrSpaceVelocity(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a XrSpaceVelocity record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static XrSpaceVelocity allocate(Arena arena)

allocate

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

clone

public static XrSpaceVelocity clone(Arena arena,
 XrSpaceVelocity src)

autoInit

public void autoInit()

type

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

type

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

next

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

next

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

next

public XrSpaceVelocity next(@Nullable
 @Nullable IPointer pointer)

velocityFlags

@Bitmask(XrSpaceVelocityFlags.class)
public long velocityFlags()

velocityFlags

public XrSpaceVelocity velocityFlags(@Bitmask(XrSpaceVelocityFlags.class)
 long value)

linearVelocity

@NotNull
public @NotNull XrVector3f linearVelocity()

linearVelocity

public XrSpaceVelocity linearVelocity(@NotNull
 @NotNull XrVector3f value)

linearVelocity

public XrSpaceVelocity linearVelocity(Consumer<@NotNull XrVector3f> consumer)

angularVelocity

@NotNull
public @NotNull XrVector3f angularVelocity()

angularVelocity

public XrSpaceVelocity angularVelocity(@NotNull
 @NotNull XrVector3f value)

angularVelocity

public XrSpaceVelocity angularVelocity(Consumer<@NotNull XrVector3f> 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