Record Class XrRenderModelBufferFB

java.lang.Object

java.lang.Record

club.doki7.openxr.datatype.XrRenderModelBufferFB

All Implemented Interfaces:

IPointer, IXrRenderModelBufferFB

@ValueBasedCandidate
@UnsafeConstructor
public record XrRenderModelBufferFB(@NotNull MemorySegment segment)
extends Record
implements IXrRenderModelBufferFB

Represents a pointer to a XrRenderModelBufferFB structure in native memory.

Structure

typedef struct XrRenderModelBufferFB {
    XrStructureType type;
    void* next;
    uint32_t bufferCapacityInput; // optional
    uint32_t bufferCountOutput; // optional
    uint8_t* buffer; // optional
} XrRenderModelBufferFB;

Auto initialization

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

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

• XrRenderModelBufferFB

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

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

public static final MemoryLayout.PathElement PATH$bufferCapacityInput

PATH$bufferCountOutput

public static final MemoryLayout.PathElement PATH$bufferCountOutput

PATH$buffer

public static final MemoryLayout.PathElement PATH$buffer

LAYOUT$type

public static final ValueLayout.OfInt LAYOUT$type

LAYOUT$next

public static final AddressLayout LAYOUT$next

LAYOUT$bufferCapacityInput

public static final ValueLayout.OfInt LAYOUT$bufferCapacityInput

LAYOUT$bufferCountOutput

public static final ValueLayout.OfInt LAYOUT$bufferCountOutput

LAYOUT$buffer

public static final AddressLayout LAYOUT$buffer

SIZE$type

public static final long SIZE$type

SIZE$next

public static final long SIZE$next

SIZE$bufferCapacityInput

public static final long SIZE$bufferCapacityInput

SIZE$bufferCountOutput

public static final long SIZE$bufferCountOutput

SIZE$buffer

public static final long SIZE$buffer

OFFSET$type

public static final long OFFSET$type

OFFSET$next

public static final long OFFSET$next

OFFSET$bufferCapacityInput

public static final long OFFSET$bufferCapacityInput

OFFSET$bufferCountOutput

public static final long OFFSET$bufferCountOutput

OFFSET$buffer

public static final long OFFSET$buffer

Constructor Details

XrRenderModelBufferFB

public XrRenderModelBufferFB(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a XrRenderModelBufferFB record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static XrRenderModelBufferFB allocate(Arena arena)

allocate

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

clone

public static XrRenderModelBufferFB clone(Arena arena,
 XrRenderModelBufferFB src)

autoInit

public void autoInit()

type

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

type

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

next

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

next

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

next

public XrRenderModelBufferFB next(@Nullable
 @Nullable IPointer pointer)

bufferCapacityInput

@Unsigned
public int bufferCapacityInput()

bufferCapacityInput

public XrRenderModelBufferFB bufferCapacityInput(@Unsigned
 int value)

bufferCountOutput

@Unsigned
public int bufferCountOutput()

bufferCountOutput

public XrRenderModelBufferFB bufferCountOutput(@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 XrRenderModelBufferFB 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