Record Class XrSpatialMarkerDataEXT

java.lang.Object

java.lang.Record

club.doki7.openxr.datatype.XrSpatialMarkerDataEXT

All Implemented Interfaces:

IPointer, IXrSpatialMarkerDataEXT

@ValueBasedCandidate
@UnsafeConstructor
public record XrSpatialMarkerDataEXT(@NotNull MemorySegment segment)
extends Record
implements IXrSpatialMarkerDataEXT

Represents a pointer to a XrSpatialMarkerDataEXT structure in native memory.

Structure

typedef struct XrSpatialMarkerDataEXT {
    XrSpatialCapabilityEXT capability;
    uint32_t markerId;
    XrSpatialBufferEXT data;
} XrSpatialMarkerDataEXT;

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:

• XrSpatialMarkerDataEXT

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	XrSpatialMarkerDataEXT.Ptr	Represents a pointer to / an array of XrSpatialMarkerDataEXT 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$capability
static final StructLayout	LAYOUT$data
static final ValueLayout.OfInt	LAYOUT$markerId
static final long	OFFSET$capability
static final long	OFFSET$data
static final long	OFFSET$markerId
static final MemoryLayout.PathElement	PATH$capability
static final MemoryLayout.PathElement	PATH$data
static final MemoryLayout.PathElement	PATH$markerId
static final long	SIZE$capability
static final long	SIZE$data
static final long	SIZE$markerId

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static XrSpatialMarkerDataEXT	allocate(Arena arena)
static XrSpatialMarkerDataEXT.Ptr	allocate(Arena arena, long count)
int	capability()
XrSpatialMarkerDataEXT	capability(int value)
static XrSpatialMarkerDataEXT	clone(Arena arena, XrSpatialMarkerDataEXT src)
@NotNull XrSpatialBufferEXT	data()
XrSpatialMarkerDataEXT	data(@NotNull XrSpatialBufferEXT value)
XrSpatialMarkerDataEXT	data(Consumer<@NotNull XrSpatialBufferEXT> consumer)
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.
int	markerId()
XrSpatialMarkerDataEXT	markerId(int value)
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
final String	toString()	Returns a string representation of this record class.

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$capability

public static final MemoryLayout.PathElement PATH$capability

PATH$markerId

public static final MemoryLayout.PathElement PATH$markerId

PATH$data

public static final MemoryLayout.PathElement PATH$data

LAYOUT$capability

public static final ValueLayout.OfInt LAYOUT$capability

LAYOUT$markerId

public static final ValueLayout.OfInt LAYOUT$markerId

LAYOUT$data

public static final StructLayout LAYOUT$data

SIZE$capability

public static final long SIZE$capability

SIZE$markerId

public static final long SIZE$markerId

SIZE$data

public static final long SIZE$data

OFFSET$capability

public static final long OFFSET$capability

OFFSET$markerId

public static final long OFFSET$markerId

OFFSET$data

public static final long OFFSET$data

Constructor Details

XrSpatialMarkerDataEXT

public XrSpatialMarkerDataEXT(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a XrSpatialMarkerDataEXT record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static XrSpatialMarkerDataEXT allocate(Arena arena)

allocate

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

clone

public static XrSpatialMarkerDataEXT clone(Arena arena,
 XrSpatialMarkerDataEXT src)

capability

@EnumType(XrSpatialCapabilityEXT.class)
public int capability()

capability

public XrSpatialMarkerDataEXT capability(@EnumType(XrSpatialCapabilityEXT.class)
 int value)

markerId

@Unsigned
public int markerId()

markerId

public XrSpatialMarkerDataEXT markerId(@Unsigned
 int value)

data

@NotNull
public @NotNull XrSpatialBufferEXT data()

data

public XrSpatialMarkerDataEXT data(@NotNull
 @NotNull XrSpatialBufferEXT value)

data

public XrSpatialMarkerDataEXT data(Consumer<@NotNull XrSpatialBufferEXT> consumer)

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