Record Class XrKeyboardTrackingDescriptionFB

java.lang.Object

java.lang.Record

club.doki7.openxr.datatype.XrKeyboardTrackingDescriptionFB

All Implemented Interfaces:

IPointer, IXrKeyboardTrackingDescriptionFB

@ValueBasedCandidate
@UnsafeConstructor
public record XrKeyboardTrackingDescriptionFB(@NotNull MemorySegment segment)
extends Record
implements IXrKeyboardTrackingDescriptionFB

Represents a pointer to a XrKeyboardTrackingDescriptionFB structure in native memory.

Structure

typedef struct XrKeyboardTrackingDescriptionFB {
    uint64_t trackedKeyboardId;
    XrVector3f size;
    XrKeyboardTrackingFlagsFB flags;
    char[XR_MAX_KEYBOARD_TRACKING_NAME_SIZE_FB] name;
} XrKeyboardTrackingDescriptionFB;

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:

• XrKeyboardTrackingDescriptionFB

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static XrKeyboardTrackingDescriptionFB	allocate(Arena arena)
static XrKeyboardTrackingDescriptionFB.Ptr	allocate(Arena arena, long count)
static XrKeyboardTrackingDescriptionFB	clone(Arena arena, XrKeyboardTrackingDescriptionFB src)
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
long	flags()
XrKeyboardTrackingDescriptionFB	flags(long value)
final int	hashCode()	Returns a hash code value for this object.
BytePtr	name()
XrKeyboardTrackingDescriptionFB	name(BytePtr value)
XrKeyboardTrackingDescriptionFB	name(@NotNull Consumer<BytePtr> consumer)
@NotNull MemorySegment	nameRaw()
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
@NotNull XrVector3f	size()
XrKeyboardTrackingDescriptionFB	size(@NotNull XrVector3f value)
XrKeyboardTrackingDescriptionFB	size(Consumer<@NotNull XrVector3f> consumer)
final String	toString()	Returns a string representation of this record class.
long	trackedKeyboardId()
XrKeyboardTrackingDescriptionFB	trackedKeyboardId(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$trackedKeyboardId

public static final MemoryLayout.PathElement PATH$trackedKeyboardId

PATH$size

public static final MemoryLayout.PathElement PATH$size

PATH$flags

public static final MemoryLayout.PathElement PATH$flags

PATH$name

public static final MemoryLayout.PathElement PATH$name

LAYOUT$trackedKeyboardId

public static final ValueLayout.OfLong LAYOUT$trackedKeyboardId

LAYOUT$size

public static final StructLayout LAYOUT$size

LAYOUT$flags

public static final ValueLayout.OfLong LAYOUT$flags

LAYOUT$name

public static final SequenceLayout LAYOUT$name

SIZE$trackedKeyboardId

public static final long SIZE$trackedKeyboardId

SIZE$size

public static final long SIZE$size

SIZE$flags

public static final long SIZE$flags

SIZE$name

public static final long SIZE$name

OFFSET$trackedKeyboardId

public static final long OFFSET$trackedKeyboardId

OFFSET$size

public static final long OFFSET$size

OFFSET$flags

public static final long OFFSET$flags

OFFSET$name

public static final long OFFSET$name

Constructor Details

XrKeyboardTrackingDescriptionFB

public XrKeyboardTrackingDescriptionFB(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a XrKeyboardTrackingDescriptionFB record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static XrKeyboardTrackingDescriptionFB allocate(Arena arena)

allocate

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

clone

public static XrKeyboardTrackingDescriptionFB clone(Arena arena,
 XrKeyboardTrackingDescriptionFB src)

trackedKeyboardId

@Unsigned
public long trackedKeyboardId()

trackedKeyboardId

public XrKeyboardTrackingDescriptionFB trackedKeyboardId(@Unsigned
 long value)

size

@NotNull
public @NotNull XrVector3f size()

size

public XrKeyboardTrackingDescriptionFB size(@NotNull
 @NotNull XrVector3f value)

size

public XrKeyboardTrackingDescriptionFB size(Consumer<@NotNull XrVector3f> consumer)

flags

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

flags

public XrKeyboardTrackingDescriptionFB flags(@Bitmask(XrKeyboardTrackingFlagsFB.class)
 long value)

name

public BytePtr name()

name

public XrKeyboardTrackingDescriptionFB name(@NotNull
 @NotNull Consumer<BytePtr> consumer)

name

public XrKeyboardTrackingDescriptionFB name(BytePtr value)

nameRaw

@NotNull
public @NotNull MemorySegment nameRaw()

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