Record Class XrRoomLayoutFB

java.lang.Object

java.lang.Record

club.doki7.openxr.datatype.XrRoomLayoutFB

All Implemented Interfaces:

IPointer, IXrRoomLayoutFB

@ValueBasedCandidate
@UnsafeConstructor
public record XrRoomLayoutFB(@NotNull MemorySegment segment)
extends Record
implements IXrRoomLayoutFB

Represents a pointer to a XrRoomLayoutFB structure in native memory.

Structure

typedef struct XrRoomLayoutFB {
    XrStructureType type;
    void const* next;
    XrUuidEXT floorUuid;
    XrUuidEXT ceilingUuid;
    uint32_t wallUuidCapacityInput; // optional
    uint32_t wallUuidCountOutput; // optional
    XrUuidEXT* wallUuids; // optional
} XrRoomLayoutFB;

Auto initialization

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

• type = XR_TYPE_ROOM_LAYOUT_FB

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:

• XrRoomLayoutFB

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	XrRoomLayoutFB.Ptr	Represents a pointer to / an array of XrRoomLayoutFB 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$ceilingUuid
static final StructLayout	LAYOUT$floorUuid
static final AddressLayout	LAYOUT$next
static final ValueLayout.OfInt	LAYOUT$type
static final ValueLayout.OfInt	LAYOUT$wallUuidCapacityInput
static final ValueLayout.OfInt	LAYOUT$wallUuidCountOutput
static final AddressLayout	LAYOUT$wallUuids
static final long	OFFSET$ceilingUuid
static final long	OFFSET$floorUuid
static final long	OFFSET$next
static final long	OFFSET$type
static final long	OFFSET$wallUuidCapacityInput
static final long	OFFSET$wallUuidCountOutput
static final long	OFFSET$wallUuids
static final MemoryLayout.PathElement	PATH$ceilingUuid
static final MemoryLayout.PathElement	PATH$floorUuid
static final MemoryLayout.PathElement	PATH$next
static final MemoryLayout.PathElement	PATH$type
static final MemoryLayout.PathElement	PATH$wallUuidCapacityInput
static final MemoryLayout.PathElement	PATH$wallUuidCountOutput
static final MemoryLayout.PathElement	PATH$wallUuids
static final long	SIZE$ceilingUuid
static final long	SIZE$floorUuid
static final long	SIZE$next
static final long	SIZE$type
static final long	SIZE$wallUuidCapacityInput
static final long	SIZE$wallUuidCountOutput
static final long	SIZE$wallUuids

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static XrRoomLayoutFB	allocate(Arena arena)
static XrRoomLayoutFB.Ptr	allocate(Arena arena, long count)
void	autoInit()
@NotNull XrUuidEXT	ceilingUuid()
XrRoomLayoutFB	ceilingUuid(@NotNull XrUuidEXT value)
XrRoomLayoutFB	ceilingUuid(Consumer<@NotNull XrUuidEXT> consumer)
static XrRoomLayoutFB	clone(Arena arena, XrRoomLayoutFB src)
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
@NotNull XrUuidEXT	floorUuid()
XrRoomLayoutFB	floorUuid(@NotNull XrUuidEXT value)
XrRoomLayoutFB	floorUuid(Consumer<@NotNull XrUuidEXT> consumer)
final int	hashCode()	Returns a hash code value for this object.
@NotNull MemorySegment	next()
XrRoomLayoutFB	next(@Nullable IPointer pointer)
XrRoomLayoutFB	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()
XrRoomLayoutFB	type(int value)
int	wallUuidCapacityInput()
XrRoomLayoutFB	wallUuidCapacityInput(int value)
int	wallUuidCountOutput()
XrRoomLayoutFB	wallUuidCountOutput(int value)
@Nullable XrUuidEXT	wallUuids()
XrUuidEXT.Ptr	wallUuids(int assumedCount)
XrRoomLayoutFB	wallUuids(@Nullable IXrUuidEXT value)
@NotNull MemorySegment	wallUuidsRaw()
void	wallUuidsRaw(@NotNull MemorySegment 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$floorUuid

public static final MemoryLayout.PathElement PATH$floorUuid

PATH$ceilingUuid

public static final MemoryLayout.PathElement PATH$ceilingUuid

PATH$wallUuidCapacityInput

public static final MemoryLayout.PathElement PATH$wallUuidCapacityInput

PATH$wallUuidCountOutput

public static final MemoryLayout.PathElement PATH$wallUuidCountOutput

PATH$wallUuids

public static final MemoryLayout.PathElement PATH$wallUuids

LAYOUT$type

public static final ValueLayout.OfInt LAYOUT$type

LAYOUT$next

public static final AddressLayout LAYOUT$next

LAYOUT$floorUuid

public static final StructLayout LAYOUT$floorUuid

LAYOUT$ceilingUuid

public static final StructLayout LAYOUT$ceilingUuid

LAYOUT$wallUuidCapacityInput

public static final ValueLayout.OfInt LAYOUT$wallUuidCapacityInput

LAYOUT$wallUuidCountOutput

public static final ValueLayout.OfInt LAYOUT$wallUuidCountOutput

LAYOUT$wallUuids

public static final AddressLayout LAYOUT$wallUuids

SIZE$type

public static final long SIZE$type

SIZE$next

public static final long SIZE$next

SIZE$floorUuid

public static final long SIZE$floorUuid

SIZE$ceilingUuid

public static final long SIZE$ceilingUuid

SIZE$wallUuidCapacityInput

public static final long SIZE$wallUuidCapacityInput

SIZE$wallUuidCountOutput

public static final long SIZE$wallUuidCountOutput

SIZE$wallUuids

public static final long SIZE$wallUuids

OFFSET$type

public static final long OFFSET$type

OFFSET$next

public static final long OFFSET$next

OFFSET$floorUuid

public static final long OFFSET$floorUuid

OFFSET$ceilingUuid

public static final long OFFSET$ceilingUuid

OFFSET$wallUuidCapacityInput

public static final long OFFSET$wallUuidCapacityInput

OFFSET$wallUuidCountOutput

public static final long OFFSET$wallUuidCountOutput

OFFSET$wallUuids

public static final long OFFSET$wallUuids

Constructor Details

XrRoomLayoutFB

public XrRoomLayoutFB(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a XrRoomLayoutFB record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static XrRoomLayoutFB allocate(Arena arena)

allocate

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

clone

public static XrRoomLayoutFB clone(Arena arena,
 XrRoomLayoutFB src)

autoInit

public void autoInit()

type

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

type

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

next

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

next

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

next

public XrRoomLayoutFB next(@Nullable
 @Nullable IPointer pointer)

floorUuid

@NotNull
public @NotNull XrUuidEXT floorUuid()

floorUuid

public XrRoomLayoutFB floorUuid(@NotNull
 @NotNull XrUuidEXT value)

floorUuid

public XrRoomLayoutFB floorUuid(Consumer<@NotNull XrUuidEXT> consumer)

ceilingUuid

@NotNull
public @NotNull XrUuidEXT ceilingUuid()

ceilingUuid

public XrRoomLayoutFB ceilingUuid(@NotNull
 @NotNull XrUuidEXT value)

ceilingUuid

public XrRoomLayoutFB ceilingUuid(Consumer<@NotNull XrUuidEXT> consumer)

wallUuidCapacityInput

@Unsigned
public int wallUuidCapacityInput()

wallUuidCapacityInput

public XrRoomLayoutFB wallUuidCapacityInput(@Unsigned
 int value)

wallUuidCountOutput

@Unsigned
public int wallUuidCountOutput()

wallUuidCountOutput

public XrRoomLayoutFB wallUuidCountOutput(@Unsigned
 int value)

wallUuids

public XrRoomLayoutFB wallUuids(@Nullable
 @Nullable IXrUuidEXT value)

wallUuids

@Unsafe
@Nullable
public XrUuidEXT.Ptr wallUuids(int assumedCount)

wallUuids

@Nullable
public @Nullable XrUuidEXT wallUuids()

wallUuidsRaw

@Pointer(target=XrUuidEXT.class)
@NotNull
public @NotNull MemorySegment wallUuidsRaw()

wallUuidsRaw

public void wallUuidsRaw(@Pointer(target=XrUuidEXT.class) @NotNull
 @NotNull MemorySegment 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