Record Class XrScenePlaneMSFT

java.lang.Object

java.lang.Record

club.doki7.openxr.datatype.XrScenePlaneMSFT

All Implemented Interfaces:

IPointer, IXrScenePlaneMSFT

@ValueBasedCandidate
@UnsafeConstructor
public record XrScenePlaneMSFT(@NotNull MemorySegment segment)
extends Record
implements IXrScenePlaneMSFT

Represents a pointer to a XrScenePlaneMSFT structure in native memory.

Structure

typedef struct XrScenePlaneMSFT {
    XrScenePlaneAlignmentTypeMSFT alignment;
    XrExtent2Df size;
    uint64_t meshBufferId;
    XrBool32 supportsIndicesUint16;
} XrScenePlaneMSFT;

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:

• XrScenePlaneMSFT

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	XrScenePlaneMSFT.Ptr	Represents a pointer to / an array of XrScenePlaneMSFT 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$alignment
static final ValueLayout.OfLong	LAYOUT$meshBufferId
static final StructLayout	LAYOUT$size
static final ValueLayout.OfInt	LAYOUT$supportsIndicesUint16
static final long	OFFSET$alignment
static final long	OFFSET$meshBufferId
static final long	OFFSET$size
static final long	OFFSET$supportsIndicesUint16
static final MemoryLayout.PathElement	PATH$alignment
static final MemoryLayout.PathElement	PATH$meshBufferId
static final MemoryLayout.PathElement	PATH$size
static final MemoryLayout.PathElement	PATH$supportsIndicesUint16
static final long	SIZE$alignment
static final long	SIZE$meshBufferId
static final long	SIZE$size
static final long	SIZE$supportsIndicesUint16

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
int	alignment()
XrScenePlaneMSFT	alignment(int value)
static XrScenePlaneMSFT	allocate(Arena arena)
static XrScenePlaneMSFT.Ptr	allocate(Arena arena, long count)
static XrScenePlaneMSFT	clone(Arena arena, XrScenePlaneMSFT 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.
long	meshBufferId()
XrScenePlaneMSFT	meshBufferId(long value)
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
@NotNull XrExtent2Df	size()
XrScenePlaneMSFT	size(@NotNull XrExtent2Df value)
XrScenePlaneMSFT	size(Consumer<@NotNull XrExtent2Df> consumer)
int	supportsIndicesUint16()
XrScenePlaneMSFT	supportsIndicesUint16(int value)
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$alignment

public static final MemoryLayout.PathElement PATH$alignment

PATH$size

public static final MemoryLayout.PathElement PATH$size

PATH$meshBufferId

public static final MemoryLayout.PathElement PATH$meshBufferId

PATH$supportsIndicesUint16

public static final MemoryLayout.PathElement PATH$supportsIndicesUint16

LAYOUT$alignment

public static final ValueLayout.OfInt LAYOUT$alignment

LAYOUT$size

public static final StructLayout LAYOUT$size

LAYOUT$meshBufferId

public static final ValueLayout.OfLong LAYOUT$meshBufferId

LAYOUT$supportsIndicesUint16

public static final ValueLayout.OfInt LAYOUT$supportsIndicesUint16

SIZE$alignment

public static final long SIZE$alignment

SIZE$size

public static final long SIZE$size

SIZE$meshBufferId

public static final long SIZE$meshBufferId

SIZE$supportsIndicesUint16

public static final long SIZE$supportsIndicesUint16

OFFSET$alignment

public static final long OFFSET$alignment

OFFSET$size

public static final long OFFSET$size

OFFSET$meshBufferId

public static final long OFFSET$meshBufferId

OFFSET$supportsIndicesUint16

public static final long OFFSET$supportsIndicesUint16

Constructor Details

XrScenePlaneMSFT

public XrScenePlaneMSFT(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a XrScenePlaneMSFT record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static XrScenePlaneMSFT allocate(Arena arena)

allocate

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

clone

public static XrScenePlaneMSFT clone(Arena arena,
 XrScenePlaneMSFT src)

alignment

@EnumType(XrScenePlaneAlignmentTypeMSFT.class)
public int alignment()

alignment

public XrScenePlaneMSFT alignment(@EnumType(XrScenePlaneAlignmentTypeMSFT.class)
 int value)

size

@NotNull
public @NotNull XrExtent2Df size()

size

public XrScenePlaneMSFT size(@NotNull
 @NotNull XrExtent2Df value)

size

public XrScenePlaneMSFT size(Consumer<@NotNull XrExtent2Df> consumer)

meshBufferId

@Unsigned
public long meshBufferId()

meshBufferId

public XrScenePlaneMSFT meshBufferId(@Unsigned
 long value)

supportsIndicesUint16

@NativeType("XrBool32")
@Unsigned
public int supportsIndicesUint16()

supportsIndicesUint16

public XrScenePlaneMSFT supportsIndicesUint16(@NativeType("XrBool32") @Unsigned
 int 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