Record Class XrBoundary2DFB

java.lang.Object

java.lang.Record

club.doki7.openxr.datatype.XrBoundary2DFB

All Implemented Interfaces:

IPointer, IXrBoundary2DFB

@ValueBasedCandidate
@UnsafeConstructor
public record XrBoundary2DFB(@NotNull MemorySegment segment)
extends Record
implements IXrBoundary2DFB

Represents a pointer to a XrBoundary2DFB structure in native memory.

Structure

typedef struct XrBoundary2DFB {
    XrStructureType type;
    void const* next;
    uint32_t vertexCapacityInput; // optional
    uint32_t vertexCountOutput; // optional
    XrVector2f* vertices; // optional
} XrBoundary2DFB;

Auto initialization

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

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

• XrBoundary2DFB

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static XrBoundary2DFB	allocate(Arena arena)
static XrBoundary2DFB.Ptr	allocate(Arena arena, long count)
void	autoInit()
static XrBoundary2DFB	clone(Arena arena, XrBoundary2DFB 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()
XrBoundary2DFB	next(@Nullable IPointer pointer)
XrBoundary2DFB	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()
XrBoundary2DFB	type(int value)
int	vertexCapacityInput()
XrBoundary2DFB	vertexCapacityInput(int value)
int	vertexCountOutput()
XrBoundary2DFB	vertexCountOutput(int value)
@Nullable XrVector2f	vertices()
XrVector2f.Ptr	vertices(int assumedCount)
XrBoundary2DFB	vertices(@Nullable IXrVector2f value)
@NotNull MemorySegment	verticesRaw()
void	verticesRaw(@NotNull MemorySegment 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$vertexCapacityInput

public static final MemoryLayout.PathElement PATH$vertexCapacityInput

PATH$vertexCountOutput

public static final MemoryLayout.PathElement PATH$vertexCountOutput

PATH$vertices

public static final MemoryLayout.PathElement PATH$vertices

LAYOUT$type

public static final ValueLayout.OfInt LAYOUT$type

LAYOUT$next

public static final AddressLayout LAYOUT$next

LAYOUT$vertexCapacityInput

public static final ValueLayout.OfInt LAYOUT$vertexCapacityInput

LAYOUT$vertexCountOutput

public static final ValueLayout.OfInt LAYOUT$vertexCountOutput

LAYOUT$vertices

public static final AddressLayout LAYOUT$vertices

SIZE$type

public static final long SIZE$type

SIZE$next

public static final long SIZE$next

SIZE$vertexCapacityInput

public static final long SIZE$vertexCapacityInput

SIZE$vertexCountOutput

public static final long SIZE$vertexCountOutput

SIZE$vertices

public static final long SIZE$vertices

OFFSET$type

public static final long OFFSET$type

OFFSET$next

public static final long OFFSET$next

OFFSET$vertexCapacityInput

public static final long OFFSET$vertexCapacityInput

OFFSET$vertexCountOutput

public static final long OFFSET$vertexCountOutput

OFFSET$vertices

public static final long OFFSET$vertices

Constructor Details

XrBoundary2DFB

public XrBoundary2DFB(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a XrBoundary2DFB record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static XrBoundary2DFB allocate(Arena arena)

allocate

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

clone

public static XrBoundary2DFB clone(Arena arena,
 XrBoundary2DFB src)

autoInit

public void autoInit()

type

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

type

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

next

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

next

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

next

public XrBoundary2DFB next(@Nullable
 @Nullable IPointer pointer)

vertexCapacityInput

@Unsigned
public int vertexCapacityInput()

vertexCapacityInput

public XrBoundary2DFB vertexCapacityInput(@Unsigned
 int value)

vertexCountOutput

@Unsigned
public int vertexCountOutput()

vertexCountOutput

public XrBoundary2DFB vertexCountOutput(@Unsigned
 int value)

vertices

public XrBoundary2DFB vertices(@Nullable
 @Nullable IXrVector2f value)

vertices

@Unsafe
@Nullable
public XrVector2f.Ptr vertices(int assumedCount)

vertices

@Nullable
public @Nullable XrVector2f vertices()

verticesRaw

@Pointer(target=XrVector2f.class)
@NotNull
public @NotNull MemorySegment verticesRaw()

verticesRaw

public void verticesRaw(@Pointer(target=XrVector2f.class) @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