Record Class XrSpatialCapabilityConfigurationBaseHeaderEXT

java.lang.Object

java.lang.Record

club.doki7.openxr.datatype.XrSpatialCapabilityConfigurationBaseHeaderEXT

All Implemented Interfaces:

IPointer, IXrSpatialCapabilityConfigurationBaseHeaderEXT

@ValueBasedCandidate
@UnsafeConstructor
public record XrSpatialCapabilityConfigurationBaseHeaderEXT(@NotNull MemorySegment segment)
extends Record
implements IXrSpatialCapabilityConfigurationBaseHeaderEXT

Represents a pointer to a XrSpatialCapabilityConfigurationBaseHeaderEXT structure in native memory.

Structure

typedef struct XrSpatialCapabilityConfigurationBaseHeaderEXT {
    XrStructureType type;
    void const* next;
    XrSpatialCapabilityEXT capability;
    uint32_t enabledComponentCount;
    XrSpatialComponentTypeEXT const* enabledComponents;
} XrSpatialCapabilityConfigurationBaseHeaderEXT;

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:

• XrSpatialCapabilityConfigurationBaseHeaderEXT

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static XrSpatialCapabilityConfigurationBaseHeaderEXT	allocate(Arena arena)
static XrSpatialCapabilityConfigurationBaseHeaderEXT.Ptr	allocate(Arena arena, long count)
int	capability()
XrSpatialCapabilityConfigurationBaseHeaderEXT	capability(int value)
static XrSpatialCapabilityConfigurationBaseHeaderEXT	clone(Arena arena, XrSpatialCapabilityConfigurationBaseHeaderEXT src)
int	enabledComponentCount()
XrSpatialCapabilityConfigurationBaseHeaderEXT	enabledComponentCount(int value)
@Nullable IntPtr	enabledComponents()	Note: the returned IntPtr does not have correct IntPtr.size() property.
XrSpatialCapabilityConfigurationBaseHeaderEXT	enabledComponents(@Nullable IntPtr value)
@NotNull MemorySegment	enabledComponentsRaw()
void	enabledComponentsRaw(@NotNull MemorySegment value)
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()
XrSpatialCapabilityConfigurationBaseHeaderEXT	next(@Nullable IPointer pointer)
XrSpatialCapabilityConfigurationBaseHeaderEXT	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()
XrSpatialCapabilityConfigurationBaseHeaderEXT	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$capability

public static final MemoryLayout.PathElement PATH$capability

PATH$enabledComponentCount

public static final MemoryLayout.PathElement PATH$enabledComponentCount

PATH$enabledComponents

public static final MemoryLayout.PathElement PATH$enabledComponents

LAYOUT$type

public static final ValueLayout.OfInt LAYOUT$type

LAYOUT$next

public static final AddressLayout LAYOUT$next

LAYOUT$capability

public static final ValueLayout.OfInt LAYOUT$capability

LAYOUT$enabledComponentCount

public static final ValueLayout.OfInt LAYOUT$enabledComponentCount

LAYOUT$enabledComponents

public static final AddressLayout LAYOUT$enabledComponents

SIZE$type

public static final long SIZE$type

SIZE$next

public static final long SIZE$next

SIZE$capability

public static final long SIZE$capability

SIZE$enabledComponentCount

public static final long SIZE$enabledComponentCount

SIZE$enabledComponents

public static final long SIZE$enabledComponents

OFFSET$type

public static final long OFFSET$type

OFFSET$next

public static final long OFFSET$next

OFFSET$capability

public static final long OFFSET$capability

OFFSET$enabledComponentCount

public static final long OFFSET$enabledComponentCount

OFFSET$enabledComponents

public static final long OFFSET$enabledComponents

Constructor Details

XrSpatialCapabilityConfigurationBaseHeaderEXT

public XrSpatialCapabilityConfigurationBaseHeaderEXT(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a XrSpatialCapabilityConfigurationBaseHeaderEXT record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static XrSpatialCapabilityConfigurationBaseHeaderEXT allocate(Arena arena)

allocate

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

clone

public static XrSpatialCapabilityConfigurationBaseHeaderEXT clone(Arena arena,
 XrSpatialCapabilityConfigurationBaseHeaderEXT src)

type

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

type

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

next

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

next

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

next

public XrSpatialCapabilityConfigurationBaseHeaderEXT next(@Nullable
 @Nullable IPointer pointer)

capability

@EnumType(XrSpatialCapabilityEXT.class)
public int capability()

capability

public XrSpatialCapabilityConfigurationBaseHeaderEXT capability(@EnumType(XrSpatialCapabilityEXT.class)
 int value)

enabledComponentCount

@Unsigned
public int enabledComponentCount()

enabledComponentCount

public XrSpatialCapabilityConfigurationBaseHeaderEXT enabledComponentCount(@Unsigned
 int value)

enabledComponents

@Nullable
@EnumType(XrSpatialComponentTypeEXT.class)
public @Nullable IntPtr enabledComponents()

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

enabledComponents

public XrSpatialCapabilityConfigurationBaseHeaderEXT enabledComponents(@Nullable @EnumType(XrSpatialComponentTypeEXT.class)
 @Nullable IntPtr value)

enabledComponentsRaw

@Pointer(target=XrSpatialComponentTypeEXT.class)
@NotNull
public @NotNull MemorySegment enabledComponentsRaw()

enabledComponentsRaw

public void enabledComponentsRaw(@Pointer(target=XrSpatialComponentTypeEXT.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