Record Class XrInstanceProperties

java.lang.Object

java.lang.Record

club.doki7.openxr.datatype.XrInstanceProperties

All Implemented Interfaces:

IPointer, IXrInstanceProperties

@ValueBasedCandidate
@UnsafeConstructor
public record XrInstanceProperties(@NotNull MemorySegment segment)
extends Record
implements IXrInstanceProperties

Represents a pointer to a XrInstanceProperties structure in native memory.

Structure

typedef struct XrInstanceProperties {
    XrStructureType type;
    void* next;
    XrVersion runtimeVersion;
    char[XR_MAX_RUNTIME_NAME_SIZE] runtimeName;
} XrInstanceProperties;

Auto initialization

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

• type = XR_TYPE_INSTANCE_PROPERTIES

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:

• XrInstanceProperties

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static XrInstanceProperties	allocate(Arena arena)
static XrInstanceProperties.Ptr	allocate(Arena arena, long count)
void	autoInit()
static XrInstanceProperties	clone(Arena arena, XrInstanceProperties 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()
XrInstanceProperties	next(@Nullable IPointer pointer)
XrInstanceProperties	next(@NotNull MemorySegment value)
BytePtr	runtimeName()
XrInstanceProperties	runtimeName(BytePtr value)
XrInstanceProperties	runtimeName(@NotNull Consumer<BytePtr> consumer)
@NotNull MemorySegment	runtimeNameRaw()
long	runtimeVersion()
XrInstanceProperties	runtimeVersion(long 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()
XrInstanceProperties	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$runtimeVersion

public static final MemoryLayout.PathElement PATH$runtimeVersion

PATH$runtimeName

public static final MemoryLayout.PathElement PATH$runtimeName

LAYOUT$type

public static final ValueLayout.OfInt LAYOUT$type

LAYOUT$next

public static final AddressLayout LAYOUT$next

LAYOUT$runtimeVersion

public static final ValueLayout.OfLong LAYOUT$runtimeVersion

LAYOUT$runtimeName

public static final SequenceLayout LAYOUT$runtimeName

SIZE$type

public static final long SIZE$type

SIZE$next

public static final long SIZE$next

SIZE$runtimeVersion

public static final long SIZE$runtimeVersion

SIZE$runtimeName

public static final long SIZE$runtimeName

OFFSET$type

public static final long OFFSET$type

OFFSET$next

public static final long OFFSET$next

OFFSET$runtimeVersion

public static final long OFFSET$runtimeVersion

OFFSET$runtimeName

public static final long OFFSET$runtimeName

Constructor Details

XrInstanceProperties

public XrInstanceProperties(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a XrInstanceProperties record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static XrInstanceProperties allocate(Arena arena)

allocate

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

clone

public static XrInstanceProperties clone(Arena arena,
 XrInstanceProperties src)

autoInit

public void autoInit()

type

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

type

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

next

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

next

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

next

public XrInstanceProperties next(@Nullable
 @Nullable IPointer pointer)

runtimeVersion

@NativeType("XrVersion")
@Unsigned
public long runtimeVersion()

runtimeVersion

public XrInstanceProperties runtimeVersion(@NativeType("XrVersion") @Unsigned
 long value)

runtimeName

public BytePtr runtimeName()

runtimeName

public XrInstanceProperties runtimeName(@NotNull
 @NotNull Consumer<BytePtr> consumer)

runtimeName

public XrInstanceProperties runtimeName(BytePtr value)

runtimeNameRaw

@NotNull
public @NotNull MemorySegment runtimeNameRaw()

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