Record Class XrSystemPassthroughProperties2FB

java.lang.Object

java.lang.Record

club.doki7.openxr.datatype.XrSystemPassthroughProperties2FB

All Implemented Interfaces:

IPointer, IXrSystemPassthroughProperties2FB

@ValueBasedCandidate
@UnsafeConstructor
public record XrSystemPassthroughProperties2FB(@NotNull MemorySegment segment)
extends Record
implements IXrSystemPassthroughProperties2FB

Represents a pointer to a XrSystemPassthroughProperties2FB structure in native memory.

Structure

typedef struct XrSystemPassthroughProperties2FB {
    XrStructureType type;
    void const* next;
    XrPassthroughCapabilityFlagsFB capabilities;
} XrSystemPassthroughProperties2FB;

Auto initialization

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

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

• XrSystemPassthroughProperties2FB

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	XrSystemPassthroughProperties2FB.Ptr	Represents a pointer to / an array of XrSystemPassthroughProperties2FB structure(s) in native memory.

Field Summary

Fields

Modifier and Type	Field	Description
static final long	BYTES
static final StructLayout	LAYOUT
static final ValueLayout.OfLong	LAYOUT$capabilities
static final AddressLayout	LAYOUT$next
static final ValueLayout.OfInt	LAYOUT$type
static final long	OFFSET$capabilities
static final long	OFFSET$next
static final long	OFFSET$type
static final MemoryLayout.PathElement	PATH$capabilities
static final MemoryLayout.PathElement	PATH$next
static final MemoryLayout.PathElement	PATH$type
static final long	SIZE$capabilities
static final long	SIZE$next
static final long	SIZE$type

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static XrSystemPassthroughProperties2FB	allocate(Arena arena)
static XrSystemPassthroughProperties2FB.Ptr	allocate(Arena arena, long count)
void	autoInit()
long	capabilities()
XrSystemPassthroughProperties2FB	capabilities(long value)
static XrSystemPassthroughProperties2FB	clone(Arena arena, XrSystemPassthroughProperties2FB 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()
XrSystemPassthroughProperties2FB	next(@Nullable IPointer pointer)
XrSystemPassthroughProperties2FB	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()
XrSystemPassthroughProperties2FB	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$capabilities

public static final MemoryLayout.PathElement PATH$capabilities

LAYOUT$type

public static final ValueLayout.OfInt LAYOUT$type

LAYOUT$next

public static final AddressLayout LAYOUT$next

LAYOUT$capabilities

public static final ValueLayout.OfLong LAYOUT$capabilities

SIZE$type

public static final long SIZE$type

SIZE$next

public static final long SIZE$next

SIZE$capabilities

public static final long SIZE$capabilities

OFFSET$type

public static final long OFFSET$type

OFFSET$next

public static final long OFFSET$next

OFFSET$capabilities

public static final long OFFSET$capabilities

Constructor Details

XrSystemPassthroughProperties2FB

public XrSystemPassthroughProperties2FB(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a XrSystemPassthroughProperties2FB record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static XrSystemPassthroughProperties2FB allocate(Arena arena)

allocate

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

clone

public static XrSystemPassthroughProperties2FB clone(Arena arena,
 XrSystemPassthroughProperties2FB src)

autoInit

public void autoInit()

type

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

type

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

next

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

next

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

next

public XrSystemPassthroughProperties2FB next(@Nullable
 @Nullable IPointer pointer)

capabilities

@Bitmask(XrPassthroughCapabilityFlagsFB.class)
public long capabilities()

capabilities

public XrSystemPassthroughProperties2FB capabilities(@Bitmask(XrPassthroughCapabilityFlagsFB.class)
 long 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