Record Class XrSpaceVelocityDataKHR

java.lang.Object

java.lang.Record

club.doki7.openxr.datatype.XrSpaceVelocityDataKHR

All Implemented Interfaces:

IPointer, IXrSpaceVelocityDataKHR

@ValueBasedCandidate
@UnsafeConstructor
public record XrSpaceVelocityDataKHR(@NotNull MemorySegment segment)
extends Record
implements IXrSpaceVelocityDataKHR

Represents a pointer to a XrSpaceVelocityDataKHR structure in native memory.

Structure

typedef struct XrSpaceVelocityDataKHR {
    XrSpaceVelocityFlags velocityFlags;
    XrVector3f linearVelocity;
    XrVector3f angularVelocity;
} XrSpaceVelocityDataKHR;

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:

• XrSpaceVelocityDataKHR

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	XrSpaceVelocityDataKHR.Ptr	Represents a pointer to / an array of XrSpaceVelocityDataKHR 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 ValueLayout.OfLong	LAYOUT$velocityFlags
static final long	OFFSET$angularVelocity
static final long	OFFSET$linearVelocity
static final long	OFFSET$velocityFlags
static final MemoryLayout.PathElement	PATH$angularVelocity
static final MemoryLayout.PathElement	PATH$linearVelocity
static final MemoryLayout.PathElement	PATH$velocityFlags
static final long	SIZE$angularVelocity
static final long	SIZE$linearVelocity
static final long	SIZE$velocityFlags

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static XrSpaceVelocityDataKHR	allocate(Arena arena)
static XrSpaceVelocityDataKHR.Ptr	allocate(Arena arena, long count)
@NotNull XrVector3f	angularVelocity()
XrSpaceVelocityDataKHR	angularVelocity(@NotNull XrVector3f value)
XrSpaceVelocityDataKHR	angularVelocity(Consumer<@NotNull XrVector3f> consumer)
static XrSpaceVelocityDataKHR	clone(Arena arena, XrSpaceVelocityDataKHR 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()
XrSpaceVelocityDataKHR	linearVelocity(@NotNull XrVector3f value)
XrSpaceVelocityDataKHR	linearVelocity(Consumer<@NotNull XrVector3f> consumer)
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
final String	toString()	Returns a string representation of this record class.
long	velocityFlags()
XrSpaceVelocityDataKHR	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$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$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$velocityFlags

public static final long SIZE$velocityFlags

SIZE$linearVelocity

public static final long SIZE$linearVelocity

SIZE$angularVelocity

public static final long SIZE$angularVelocity

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

XrSpaceVelocityDataKHR

public XrSpaceVelocityDataKHR(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a XrSpaceVelocityDataKHR record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static XrSpaceVelocityDataKHR allocate(Arena arena)

allocate

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

clone

public static XrSpaceVelocityDataKHR clone(Arena arena,
 XrSpaceVelocityDataKHR src)

velocityFlags

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

velocityFlags

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

linearVelocity

@NotNull
public @NotNull XrVector3f linearVelocity()

linearVelocity

public XrSpaceVelocityDataKHR linearVelocity(@NotNull
 @NotNull XrVector3f value)

linearVelocity

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

angularVelocity

@NotNull
public @NotNull XrVector3f angularVelocity()

angularVelocity

public XrSpaceVelocityDataKHR angularVelocity(@NotNull
 @NotNull XrVector3f value)

angularVelocity

public XrSpaceVelocityDataKHR 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