Record Class XrSpaceContainerFB

java.lang.Object

java.lang.Record

club.doki7.openxr.datatype.XrSpaceContainerFB

All Implemented Interfaces:

IPointer, IXrSpaceContainerFB

@ValueBasedCandidate
@UnsafeConstructor
public record XrSpaceContainerFB(@NotNull MemorySegment segment)
extends Record
implements IXrSpaceContainerFB

Represents a pointer to a XrSpaceContainerFB structure in native memory.

Structure

typedef struct XrSpaceContainerFB {
    XrStructureType type;
    void const* next;
    uint32_t uuidCapacityInput; // optional
    uint32_t uuidCountOutput; // optional
    XrUuidEXT* uuids; // optional
} XrSpaceContainerFB;

Auto initialization

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

• type = XR_TYPE_SPACE_CONTAINER_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:

• XrSpaceContainerFB

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
static final long	BYTES
static final StructLayout	LAYOUT
static final AddressLayout	LAYOUT$next
static final ValueLayout.OfInt	LAYOUT$type
static final ValueLayout.OfInt	LAYOUT$uuidCapacityInput
static final ValueLayout.OfInt	LAYOUT$uuidCountOutput
static final AddressLayout	LAYOUT$uuids
static final long	OFFSET$next
static final long	OFFSET$type
static final long	OFFSET$uuidCapacityInput
static final long	OFFSET$uuidCountOutput
static final long	OFFSET$uuids
static final MemoryLayout.PathElement	PATH$next
static final MemoryLayout.PathElement	PATH$type
static final MemoryLayout.PathElement	PATH$uuidCapacityInput
static final MemoryLayout.PathElement	PATH$uuidCountOutput
static final MemoryLayout.PathElement	PATH$uuids
static final long	SIZE$next
static final long	SIZE$type
static final long	SIZE$uuidCapacityInput
static final long	SIZE$uuidCountOutput
static final long	SIZE$uuids

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static XrSpaceContainerFB	allocate(Arena arena)
static XrSpaceContainerFB.Ptr	allocate(Arena arena, long count)
void	autoInit()
static XrSpaceContainerFB	clone(Arena arena, XrSpaceContainerFB 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 MemorySegment	next()
XrSpaceContainerFB	next(@Nullable IPointer pointer)
XrSpaceContainerFB	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()
XrSpaceContainerFB	type(int value)
int	uuidCapacityInput()
XrSpaceContainerFB	uuidCapacityInput(int value)
int	uuidCountOutput()
XrSpaceContainerFB	uuidCountOutput(int value)
@Nullable XrUuidEXT	uuids()
XrUuidEXT.Ptr	uuids(int assumedCount)
XrSpaceContainerFB	uuids(@Nullable IXrUuidEXT value)
@NotNull MemorySegment	uuidsRaw()
void	uuidsRaw(@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$uuidCapacityInput

public static final MemoryLayout.PathElement PATH$uuidCapacityInput

PATH$uuidCountOutput

public static final MemoryLayout.PathElement PATH$uuidCountOutput

PATH$uuids

public static final MemoryLayout.PathElement PATH$uuids

LAYOUT$type

public static final ValueLayout.OfInt LAYOUT$type

LAYOUT$next

public static final AddressLayout LAYOUT$next

LAYOUT$uuidCapacityInput

public static final ValueLayout.OfInt LAYOUT$uuidCapacityInput

LAYOUT$uuidCountOutput

public static final ValueLayout.OfInt LAYOUT$uuidCountOutput

LAYOUT$uuids

public static final AddressLayout LAYOUT$uuids

SIZE$type

public static final long SIZE$type

SIZE$next

public static final long SIZE$next

SIZE$uuidCapacityInput

public static final long SIZE$uuidCapacityInput

SIZE$uuidCountOutput

public static final long SIZE$uuidCountOutput

SIZE$uuids

public static final long SIZE$uuids

OFFSET$type

public static final long OFFSET$type

OFFSET$next

public static final long OFFSET$next

OFFSET$uuidCapacityInput

public static final long OFFSET$uuidCapacityInput

OFFSET$uuidCountOutput

public static final long OFFSET$uuidCountOutput

OFFSET$uuids

public static final long OFFSET$uuids

Constructor Details

XrSpaceContainerFB

public XrSpaceContainerFB(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a XrSpaceContainerFB record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static XrSpaceContainerFB allocate(Arena arena)

allocate

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

clone

public static XrSpaceContainerFB clone(Arena arena,
 XrSpaceContainerFB src)

autoInit

public void autoInit()

type

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

type

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

next

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

next

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

next

public XrSpaceContainerFB next(@Nullable
 @Nullable IPointer pointer)

uuidCapacityInput

@Unsigned
public int uuidCapacityInput()

uuidCapacityInput

public XrSpaceContainerFB uuidCapacityInput(@Unsigned
 int value)

uuidCountOutput

@Unsigned
public int uuidCountOutput()

uuidCountOutput

public XrSpaceContainerFB uuidCountOutput(@Unsigned
 int value)

uuids

public XrSpaceContainerFB uuids(@Nullable
 @Nullable IXrUuidEXT value)

uuids

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

uuids

@Nullable
public @Nullable XrUuidEXT uuids()

uuidsRaw

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

uuidsRaw

public void uuidsRaw(@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