Record Class XrSceneMarkersMSFT

java.lang.Object

java.lang.Record

club.doki7.openxr.datatype.XrSceneMarkersMSFT

All Implemented Interfaces:

IPointer, IXrSceneMarkersMSFT

@ValueBasedCandidate
@UnsafeConstructor
public record XrSceneMarkersMSFT(@NotNull MemorySegment segment)
extends Record
implements IXrSceneMarkersMSFT

Represents a pointer to a XrSceneMarkersMSFT structure in native memory.

Structure

typedef struct XrSceneMarkersMSFT {
    XrStructureType type;
    void const* next;
    uint32_t sceneMarkerCapacityInput; // optional
    XrSceneMarkerMSFT* sceneMarkers; // optional
} XrSceneMarkersMSFT;

Auto initialization

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

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

• XrSceneMarkersMSFT

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static XrSceneMarkersMSFT	allocate(Arena arena)
static XrSceneMarkersMSFT.Ptr	allocate(Arena arena, long count)
void	autoInit()
static XrSceneMarkersMSFT	clone(Arena arena, XrSceneMarkersMSFT 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()
XrSceneMarkersMSFT	next(@Nullable IPointer pointer)
XrSceneMarkersMSFT	next(@NotNull MemorySegment value)
int	sceneMarkerCapacityInput()
XrSceneMarkersMSFT	sceneMarkerCapacityInput(int value)
@Nullable XrSceneMarkerMSFT	sceneMarkers()
XrSceneMarkerMSFT.Ptr	sceneMarkers(int assumedCount)
XrSceneMarkersMSFT	sceneMarkers(@Nullable IXrSceneMarkerMSFT value)
@NotNull MemorySegment	sceneMarkersRaw()
void	sceneMarkersRaw(@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()
XrSceneMarkersMSFT	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$sceneMarkerCapacityInput

public static final MemoryLayout.PathElement PATH$sceneMarkerCapacityInput

PATH$sceneMarkers

public static final MemoryLayout.PathElement PATH$sceneMarkers

LAYOUT$type

public static final ValueLayout.OfInt LAYOUT$type

LAYOUT$next

public static final AddressLayout LAYOUT$next

LAYOUT$sceneMarkerCapacityInput

public static final ValueLayout.OfInt LAYOUT$sceneMarkerCapacityInput

LAYOUT$sceneMarkers

public static final AddressLayout LAYOUT$sceneMarkers

SIZE$type

public static final long SIZE$type

SIZE$next

public static final long SIZE$next

SIZE$sceneMarkerCapacityInput

public static final long SIZE$sceneMarkerCapacityInput

SIZE$sceneMarkers

public static final long SIZE$sceneMarkers

OFFSET$type

public static final long OFFSET$type

OFFSET$next

public static final long OFFSET$next

OFFSET$sceneMarkerCapacityInput

public static final long OFFSET$sceneMarkerCapacityInput

OFFSET$sceneMarkers

public static final long OFFSET$sceneMarkers

Constructor Details

XrSceneMarkersMSFT

public XrSceneMarkersMSFT(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a XrSceneMarkersMSFT record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static XrSceneMarkersMSFT allocate(Arena arena)

allocate

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

clone

public static XrSceneMarkersMSFT clone(Arena arena,
 XrSceneMarkersMSFT src)

autoInit

public void autoInit()

type

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

type

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

next

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

next

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

next

public XrSceneMarkersMSFT next(@Nullable
 @Nullable IPointer pointer)

sceneMarkerCapacityInput

@Unsigned
public int sceneMarkerCapacityInput()

sceneMarkerCapacityInput

public XrSceneMarkersMSFT sceneMarkerCapacityInput(@Unsigned
 int value)

sceneMarkers

public XrSceneMarkersMSFT sceneMarkers(@Nullable
 @Nullable IXrSceneMarkerMSFT value)

sceneMarkers

@Unsafe
@Nullable
public XrSceneMarkerMSFT.Ptr sceneMarkers(int assumedCount)

sceneMarkers

@Nullable
public @Nullable XrSceneMarkerMSFT sceneMarkers()

sceneMarkersRaw

@Pointer(target=XrSceneMarkerMSFT.class)
@NotNull
public @NotNull MemorySegment sceneMarkersRaw()

sceneMarkersRaw

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