Record Class XrSceneObjectsMSFT

java.lang.Object

java.lang.Record

club.doki7.openxr.datatype.XrSceneObjectsMSFT

All Implemented Interfaces:

IPointer, IXrSceneObjectsMSFT

@ValueBasedCandidate
@UnsafeConstructor
public record XrSceneObjectsMSFT(@NotNull MemorySegment segment)
extends Record
implements IXrSceneObjectsMSFT

Represents a pointer to a XrSceneObjectsMSFT structure in native memory.

Structure

typedef struct XrSceneObjectsMSFT {
    XrStructureType type;
    void* next;
    uint32_t sceneObjectCount; // optional
    XrSceneObjectMSFT* sceneObjects; // optional
} XrSceneObjectsMSFT;

Auto initialization

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

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

• XrSceneObjectsMSFT

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	XrSceneObjectsMSFT.Ptr	Represents a pointer to / an array of XrSceneObjectsMSFT 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$sceneObjectCount
static final AddressLayout	LAYOUT$sceneObjects
static final ValueLayout.OfInt	LAYOUT$type
static final long	OFFSET$next
static final long	OFFSET$sceneObjectCount
static final long	OFFSET$sceneObjects
static final long	OFFSET$type
static final MemoryLayout.PathElement	PATH$next
static final MemoryLayout.PathElement	PATH$sceneObjectCount
static final MemoryLayout.PathElement	PATH$sceneObjects
static final MemoryLayout.PathElement	PATH$type
static final long	SIZE$next
static final long	SIZE$sceneObjectCount
static final long	SIZE$sceneObjects
static final long	SIZE$type

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static XrSceneObjectsMSFT	allocate(Arena arena)
static XrSceneObjectsMSFT.Ptr	allocate(Arena arena, long count)
void	autoInit()
static XrSceneObjectsMSFT	clone(Arena arena, XrSceneObjectsMSFT 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()
XrSceneObjectsMSFT	next(@Nullable IPointer pointer)
XrSceneObjectsMSFT	next(@NotNull MemorySegment value)
int	sceneObjectCount()
XrSceneObjectsMSFT	sceneObjectCount(int value)
@Nullable XrSceneObjectMSFT	sceneObjects()
XrSceneObjectMSFT.Ptr	sceneObjects(int assumedCount)
XrSceneObjectsMSFT	sceneObjects(@Nullable IXrSceneObjectMSFT value)
@NotNull MemorySegment	sceneObjectsRaw()
void	sceneObjectsRaw(@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()
XrSceneObjectsMSFT	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$sceneObjectCount

public static final MemoryLayout.PathElement PATH$sceneObjectCount

PATH$sceneObjects

public static final MemoryLayout.PathElement PATH$sceneObjects

LAYOUT$type

public static final ValueLayout.OfInt LAYOUT$type

LAYOUT$next

public static final AddressLayout LAYOUT$next

LAYOUT$sceneObjectCount

public static final ValueLayout.OfInt LAYOUT$sceneObjectCount

LAYOUT$sceneObjects

public static final AddressLayout LAYOUT$sceneObjects

SIZE$type

public static final long SIZE$type

SIZE$next

public static final long SIZE$next

SIZE$sceneObjectCount

public static final long SIZE$sceneObjectCount

SIZE$sceneObjects

public static final long SIZE$sceneObjects

OFFSET$type

public static final long OFFSET$type

OFFSET$next

public static final long OFFSET$next

OFFSET$sceneObjectCount

public static final long OFFSET$sceneObjectCount

OFFSET$sceneObjects

public static final long OFFSET$sceneObjects

Constructor Details

XrSceneObjectsMSFT

public XrSceneObjectsMSFT(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a XrSceneObjectsMSFT record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static XrSceneObjectsMSFT allocate(Arena arena)

allocate

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

clone

public static XrSceneObjectsMSFT clone(Arena arena,
 XrSceneObjectsMSFT src)

autoInit

public void autoInit()

type

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

type

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

next

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

next

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

next

public XrSceneObjectsMSFT next(@Nullable
 @Nullable IPointer pointer)

sceneObjectCount

@Unsigned
public int sceneObjectCount()

sceneObjectCount

public XrSceneObjectsMSFT sceneObjectCount(@Unsigned
 int value)

sceneObjects

public XrSceneObjectsMSFT sceneObjects(@Nullable
 @Nullable IXrSceneObjectMSFT value)

sceneObjects

@Unsafe
@Nullable
public XrSceneObjectMSFT.Ptr sceneObjects(int assumedCount)

sceneObjects

@Nullable
public @Nullable XrSceneObjectMSFT sceneObjects()

sceneObjectsRaw

@Pointer(target=XrSceneObjectMSFT.class)
@NotNull
public @NotNull MemorySegment sceneObjectsRaw()

sceneObjectsRaw

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