Record Class XrSceneComponentsMSFT

java.lang.Object

java.lang.Record

club.doki7.openxr.datatype.XrSceneComponentsMSFT

All Implemented Interfaces:

IPointer, IXrSceneComponentsMSFT

@ValueBasedCandidate
@UnsafeConstructor
public record XrSceneComponentsMSFT(@NotNull MemorySegment segment)
extends Record
implements IXrSceneComponentsMSFT

Represents a pointer to a XrSceneComponentsMSFT structure in native memory.

Structure

typedef struct XrSceneComponentsMSFT {
    XrStructureType type;
    void* next;
    uint32_t componentCapacityInput; // optional
    uint32_t componentCountOutput; // optional
    XrSceneComponentMSFT* components; // optional
} XrSceneComponentsMSFT;

Auto initialization

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

• type = XR_TYPE_SCENE_COMPONENTS_MSFT

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:

• XrSceneComponentsMSFT

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
static final long	BYTES
static final StructLayout	LAYOUT
static final ValueLayout.OfInt	LAYOUT$componentCapacityInput
static final ValueLayout.OfInt	LAYOUT$componentCountOutput
static final AddressLayout	LAYOUT$components
static final AddressLayout	LAYOUT$next
static final ValueLayout.OfInt	LAYOUT$type
static final long	OFFSET$componentCapacityInput
static final long	OFFSET$componentCountOutput
static final long	OFFSET$components
static final long	OFFSET$next
static final long	OFFSET$type
static final MemoryLayout.PathElement	PATH$componentCapacityInput
static final MemoryLayout.PathElement	PATH$componentCountOutput
static final MemoryLayout.PathElement	PATH$components
static final MemoryLayout.PathElement	PATH$next
static final MemoryLayout.PathElement	PATH$type
static final long	SIZE$componentCapacityInput
static final long	SIZE$componentCountOutput
static final long	SIZE$components
static final long	SIZE$next
static final long	SIZE$type

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static XrSceneComponentsMSFT	allocate(Arena arena)
static XrSceneComponentsMSFT.Ptr	allocate(Arena arena, long count)
void	autoInit()
static XrSceneComponentsMSFT	clone(Arena arena, XrSceneComponentsMSFT src)
int	componentCapacityInput()
XrSceneComponentsMSFT	componentCapacityInput(int value)
int	componentCountOutput()
XrSceneComponentsMSFT	componentCountOutput(int value)
@Nullable XrSceneComponentMSFT	components()
XrSceneComponentMSFT.Ptr	components(int assumedCount)
XrSceneComponentsMSFT	components(@Nullable IXrSceneComponentMSFT value)
@NotNull MemorySegment	componentsRaw()
void	componentsRaw(@NotNull MemorySegment value)
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()
XrSceneComponentsMSFT	next(@Nullable IPointer pointer)
XrSceneComponentsMSFT	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()
XrSceneComponentsMSFT	type(int 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$componentCapacityInput

public static final MemoryLayout.PathElement PATH$componentCapacityInput

PATH$componentCountOutput

public static final MemoryLayout.PathElement PATH$componentCountOutput

PATH$components

public static final MemoryLayout.PathElement PATH$components

LAYOUT$type

public static final ValueLayout.OfInt LAYOUT$type

LAYOUT$next

public static final AddressLayout LAYOUT$next

LAYOUT$componentCapacityInput

public static final ValueLayout.OfInt LAYOUT$componentCapacityInput

LAYOUT$componentCountOutput

public static final ValueLayout.OfInt LAYOUT$componentCountOutput

LAYOUT$components

public static final AddressLayout LAYOUT$components

SIZE$type

public static final long SIZE$type

SIZE$next

public static final long SIZE$next

SIZE$componentCapacityInput

public static final long SIZE$componentCapacityInput

SIZE$componentCountOutput

public static final long SIZE$componentCountOutput

SIZE$components

public static final long SIZE$components

OFFSET$type

public static final long OFFSET$type

OFFSET$next

public static final long OFFSET$next

OFFSET$componentCapacityInput

public static final long OFFSET$componentCapacityInput

OFFSET$componentCountOutput

public static final long OFFSET$componentCountOutput

OFFSET$components

public static final long OFFSET$components

Constructor Details

XrSceneComponentsMSFT

public XrSceneComponentsMSFT(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a XrSceneComponentsMSFT record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static XrSceneComponentsMSFT allocate(Arena arena)

allocate

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

clone

public static XrSceneComponentsMSFT clone(Arena arena,
 XrSceneComponentsMSFT src)

autoInit

public void autoInit()

type

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

type

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

next

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

next

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

next

public XrSceneComponentsMSFT next(@Nullable
 @Nullable IPointer pointer)

componentCapacityInput

@Unsigned
public int componentCapacityInput()

componentCapacityInput

public XrSceneComponentsMSFT componentCapacityInput(@Unsigned
 int value)

componentCountOutput

@Unsigned
public int componentCountOutput()

componentCountOutput

public XrSceneComponentsMSFT componentCountOutput(@Unsigned
 int value)

components

public XrSceneComponentsMSFT components(@Nullable
 @Nullable IXrSceneComponentMSFT value)

components

@Unsafe
@Nullable
public XrSceneComponentMSFT.Ptr components(int assumedCount)

components

@Nullable
public @Nullable XrSceneComponentMSFT components()

componentsRaw

@Pointer(target=XrSceneComponentMSFT.class)
@NotNull
public @NotNull MemorySegment componentsRaw()

componentsRaw

public void componentsRaw(@Pointer(target=XrSceneComponentMSFT.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