Record Class XrScenePlanesMSFT

java.lang.Object

java.lang.Record

club.doki7.openxr.datatype.XrScenePlanesMSFT

All Implemented Interfaces:

IPointer, IXrScenePlanesMSFT

@ValueBasedCandidate
@UnsafeConstructor
public record XrScenePlanesMSFT(@NotNull MemorySegment segment)
extends Record
implements IXrScenePlanesMSFT

Represents a pointer to a XrScenePlanesMSFT structure in native memory.

Structure

typedef struct XrScenePlanesMSFT {
    XrStructureType type;
    void* next;
    uint32_t scenePlaneCount; // optional
    XrScenePlaneMSFT* scenePlanes; // optional
} XrScenePlanesMSFT;

Auto initialization

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

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

• XrScenePlanesMSFT

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static XrScenePlanesMSFT	allocate(Arena arena)
static XrScenePlanesMSFT.Ptr	allocate(Arena arena, long count)
void	autoInit()
static XrScenePlanesMSFT	clone(Arena arena, XrScenePlanesMSFT 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()
XrScenePlanesMSFT	next(@Nullable IPointer pointer)
XrScenePlanesMSFT	next(@NotNull MemorySegment value)
int	scenePlaneCount()
XrScenePlanesMSFT	scenePlaneCount(int value)
@Nullable XrScenePlaneMSFT	scenePlanes()
XrScenePlaneMSFT.Ptr	scenePlanes(int assumedCount)
XrScenePlanesMSFT	scenePlanes(@Nullable IXrScenePlaneMSFT value)
@NotNull MemorySegment	scenePlanesRaw()
void	scenePlanesRaw(@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()
XrScenePlanesMSFT	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$scenePlaneCount

public static final MemoryLayout.PathElement PATH$scenePlaneCount

PATH$scenePlanes

public static final MemoryLayout.PathElement PATH$scenePlanes

LAYOUT$type

public static final ValueLayout.OfInt LAYOUT$type

LAYOUT$next

public static final AddressLayout LAYOUT$next

LAYOUT$scenePlaneCount

public static final ValueLayout.OfInt LAYOUT$scenePlaneCount

LAYOUT$scenePlanes

public static final AddressLayout LAYOUT$scenePlanes

SIZE$type

public static final long SIZE$type

SIZE$next

public static final long SIZE$next

SIZE$scenePlaneCount

public static final long SIZE$scenePlaneCount

SIZE$scenePlanes

public static final long SIZE$scenePlanes

OFFSET$type

public static final long OFFSET$type

OFFSET$next

public static final long OFFSET$next

OFFSET$scenePlaneCount

public static final long OFFSET$scenePlaneCount

OFFSET$scenePlanes

public static final long OFFSET$scenePlanes

Constructor Details

XrScenePlanesMSFT

public XrScenePlanesMSFT(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a XrScenePlanesMSFT record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static XrScenePlanesMSFT allocate(Arena arena)

allocate

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

clone

public static XrScenePlanesMSFT clone(Arena arena,
 XrScenePlanesMSFT src)

autoInit

public void autoInit()

type

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

type

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

next

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

next

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

next

public XrScenePlanesMSFT next(@Nullable
 @Nullable IPointer pointer)

scenePlaneCount

@Unsigned
public int scenePlaneCount()

scenePlaneCount

public XrScenePlanesMSFT scenePlaneCount(@Unsigned
 int value)

scenePlanes

public XrScenePlanesMSFT scenePlanes(@Nullable
 @Nullable IXrScenePlaneMSFT value)

scenePlanes

@Unsafe
@Nullable
public XrScenePlaneMSFT.Ptr scenePlanes(int assumedCount)

scenePlanes

@Nullable
public @Nullable XrScenePlaneMSFT scenePlanes()

scenePlanesRaw

@Pointer(target=XrScenePlaneMSFT.class)
@NotNull
public @NotNull MemorySegment scenePlanesRaw()

scenePlanesRaw

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