Record Class XrSceneCaptureRequestInfoFB

java.lang.Object

java.lang.Record

club.doki7.openxr.datatype.XrSceneCaptureRequestInfoFB

All Implemented Interfaces:

IPointer, IXrSceneCaptureRequestInfoFB

@ValueBasedCandidate
@UnsafeConstructor
public record XrSceneCaptureRequestInfoFB(@NotNull MemorySegment segment)
extends Record
implements IXrSceneCaptureRequestInfoFB

Represents a pointer to a XrSceneCaptureRequestInfoFB structure in native memory.

Structure

typedef struct XrSceneCaptureRequestInfoFB {
    XrStructureType type;
    void const* next;
    uint32_t requestByteCount; // optional
    char const* request; // optional
} XrSceneCaptureRequestInfoFB;

Auto initialization

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

• type = XR_TYPE_SCENE_CAPTURE_REQUEST_INFO_FB

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:

• XrSceneCaptureRequestInfoFB

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static XrSceneCaptureRequestInfoFB	allocate(Arena arena)
static XrSceneCaptureRequestInfoFB.Ptr	allocate(Arena arena, long count)
void	autoInit()
static XrSceneCaptureRequestInfoFB	clone(Arena arena, XrSceneCaptureRequestInfoFB 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()
XrSceneCaptureRequestInfoFB	next(@Nullable IPointer pointer)
XrSceneCaptureRequestInfoFB	next(@NotNull MemorySegment value)
@Nullable BytePtr	request()	Note: the returned BytePtr does not have correct BytePtr.size() property.
XrSceneCaptureRequestInfoFB	request(@Nullable BytePtr value)
int	requestByteCount()
XrSceneCaptureRequestInfoFB	requestByteCount(int value)
@NotNull MemorySegment	requestRaw()
void	requestRaw(@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()
XrSceneCaptureRequestInfoFB	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$requestByteCount

public static final MemoryLayout.PathElement PATH$requestByteCount

PATH$request

public static final MemoryLayout.PathElement PATH$request

LAYOUT$type

public static final ValueLayout.OfInt LAYOUT$type

LAYOUT$next

public static final AddressLayout LAYOUT$next

LAYOUT$requestByteCount

public static final ValueLayout.OfInt LAYOUT$requestByteCount

LAYOUT$request

public static final AddressLayout LAYOUT$request

SIZE$type

public static final long SIZE$type

SIZE$next

public static final long SIZE$next

SIZE$requestByteCount

public static final long SIZE$requestByteCount

SIZE$request

public static final long SIZE$request

OFFSET$type

public static final long OFFSET$type

OFFSET$next

public static final long OFFSET$next

OFFSET$requestByteCount

public static final long OFFSET$requestByteCount

OFFSET$request

public static final long OFFSET$request

Constructor Details

XrSceneCaptureRequestInfoFB

public XrSceneCaptureRequestInfoFB(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a XrSceneCaptureRequestInfoFB record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static XrSceneCaptureRequestInfoFB allocate(Arena arena)

allocate

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

clone

public static XrSceneCaptureRequestInfoFB clone(Arena arena,
 XrSceneCaptureRequestInfoFB src)

autoInit

public void autoInit()

type

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

type

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

next

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

next

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

next

public XrSceneCaptureRequestInfoFB next(@Nullable
 @Nullable IPointer pointer)

requestByteCount

@Unsigned
public int requestByteCount()

requestByteCount

public XrSceneCaptureRequestInfoFB requestByteCount(@Unsigned
 int value)

request

@Nullable
public @Nullable BytePtr request()

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.

request

public XrSceneCaptureRequestInfoFB request(@Nullable
 @Nullable BytePtr value)

requestRaw

@Pointer(comment="int8_t*")
@NotNull
public @NotNull MemorySegment requestRaw()

requestRaw

public void requestRaw(@Pointer(comment="int8_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