Record Class XrDeserializeSceneFragmentMSFT

java.lang.Object

java.lang.Record

club.doki7.openxr.datatype.XrDeserializeSceneFragmentMSFT

All Implemented Interfaces:

IPointer, IXrDeserializeSceneFragmentMSFT

@ValueBasedCandidate
@UnsafeConstructor
public record XrDeserializeSceneFragmentMSFT(@NotNull MemorySegment segment)
extends Record
implements IXrDeserializeSceneFragmentMSFT

Represents a pointer to a XrDeserializeSceneFragmentMSFT structure in native memory.

Structure

typedef struct XrDeserializeSceneFragmentMSFT {
    uint32_t bufferSize; // optional
    uint8_t const* buffer; // optional
} XrDeserializeSceneFragmentMSFT;

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:

• XrDeserializeSceneFragmentMSFT

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static XrDeserializeSceneFragmentMSFT	allocate(Arena arena)
static XrDeserializeSceneFragmentMSFT.Ptr	allocate(Arena arena, long count)
@Nullable BytePtr	buffer()	Note: the returned BytePtr does not have correct BytePtr.size() property.
XrDeserializeSceneFragmentMSFT	buffer(@Nullable BytePtr value)
@NotNull MemorySegment	bufferRaw()
void	bufferRaw(@NotNull MemorySegment value)
int	bufferSize()
XrDeserializeSceneFragmentMSFT	bufferSize(int value)
static XrDeserializeSceneFragmentMSFT	clone(Arena arena, XrDeserializeSceneFragmentMSFT 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	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$bufferSize

public static final MemoryLayout.PathElement PATH$bufferSize

PATH$buffer

public static final MemoryLayout.PathElement PATH$buffer

LAYOUT$bufferSize

public static final ValueLayout.OfInt LAYOUT$bufferSize

LAYOUT$buffer

public static final AddressLayout LAYOUT$buffer

SIZE$bufferSize

public static final long SIZE$bufferSize

SIZE$buffer

public static final long SIZE$buffer

OFFSET$bufferSize

public static final long OFFSET$bufferSize

OFFSET$buffer

public static final long OFFSET$buffer

Constructor Details

XrDeserializeSceneFragmentMSFT

public XrDeserializeSceneFragmentMSFT(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a XrDeserializeSceneFragmentMSFT record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static XrDeserializeSceneFragmentMSFT allocate(Arena arena)

allocate

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

clone

public static XrDeserializeSceneFragmentMSFT clone(Arena arena,
 XrDeserializeSceneFragmentMSFT src)

bufferSize

@Unsigned
public int bufferSize()

bufferSize

public XrDeserializeSceneFragmentMSFT bufferSize(@Unsigned
 int value)

buffer

@Nullable
@Unsigned
public @Nullable BytePtr buffer()

Note: the returned BytePtr does not have correct BytePtr.size() property. It's up to user to track the size of the buffer, and use BytePtr.reinterpret(long) to set the size before actually reading from or writing to the buffer.

buffer

public XrDeserializeSceneFragmentMSFT buffer(@Nullable @Unsigned
 @Nullable BytePtr value)

bufferRaw

@Pointer(comment="uint8_t*")
@NotNull
public @NotNull MemorySegment bufferRaw()

bufferRaw

public void bufferRaw(@Pointer(comment="uint8_t*") @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