Record Class XrApiLayerProperties

java.lang.Object

java.lang.Record

club.doki7.openxr.datatype.XrApiLayerProperties

All Implemented Interfaces:

IPointer, IXrApiLayerProperties

@ValueBasedCandidate
@UnsafeConstructor
public record XrApiLayerProperties(@NotNull MemorySegment segment)
extends Record
implements IXrApiLayerProperties

Represents a pointer to a XrApiLayerProperties structure in native memory.

Structure

typedef struct XrApiLayerProperties {
    XrStructureType type;
    void* next;
    char[XR_MAX_API_LAYER_NAME_SIZE] layerName;
    XrVersion specVersion;
    uint32_t layerVersion;
    char[XR_MAX_API_LAYER_DESCRIPTION_SIZE] description;
} XrApiLayerProperties;

Auto initialization

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

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

• XrApiLayerProperties

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static XrApiLayerProperties	allocate(Arena arena)
static XrApiLayerProperties.Ptr	allocate(Arena arena, long count)
void	autoInit()
static XrApiLayerProperties	clone(Arena arena, XrApiLayerProperties src)
BytePtr	description()
XrApiLayerProperties	description(BytePtr value)
XrApiLayerProperties	description(@NotNull Consumer<BytePtr> consumer)
@NotNull MemorySegment	descriptionRaw()
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.
BytePtr	layerName()
XrApiLayerProperties	layerName(BytePtr value)
XrApiLayerProperties	layerName(@NotNull Consumer<BytePtr> consumer)
@NotNull MemorySegment	layerNameRaw()
int	layerVersion()
XrApiLayerProperties	layerVersion(int value)
@NotNull MemorySegment	next()
XrApiLayerProperties	next(@Nullable IPointer pointer)
XrApiLayerProperties	next(@NotNull MemorySegment value)
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
long	specVersion()
XrApiLayerProperties	specVersion(long value)
final String	toString()	Returns a string representation of this record class.
int	type()
XrApiLayerProperties	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$layerName

public static final MemoryLayout.PathElement PATH$layerName

PATH$specVersion

public static final MemoryLayout.PathElement PATH$specVersion

PATH$layerVersion

public static final MemoryLayout.PathElement PATH$layerVersion

PATH$description

public static final MemoryLayout.PathElement PATH$description

LAYOUT$type

public static final ValueLayout.OfInt LAYOUT$type

LAYOUT$next

public static final AddressLayout LAYOUT$next

LAYOUT$layerName

public static final SequenceLayout LAYOUT$layerName

LAYOUT$specVersion

public static final ValueLayout.OfLong LAYOUT$specVersion

LAYOUT$layerVersion

public static final ValueLayout.OfInt LAYOUT$layerVersion

LAYOUT$description

public static final SequenceLayout LAYOUT$description

SIZE$type

public static final long SIZE$type

SIZE$next

public static final long SIZE$next

SIZE$layerName

public static final long SIZE$layerName

SIZE$specVersion

public static final long SIZE$specVersion

SIZE$layerVersion

public static final long SIZE$layerVersion

SIZE$description

public static final long SIZE$description

OFFSET$type

public static final long OFFSET$type

OFFSET$next

public static final long OFFSET$next

OFFSET$layerName

public static final long OFFSET$layerName

OFFSET$specVersion

public static final long OFFSET$specVersion

OFFSET$layerVersion

public static final long OFFSET$layerVersion

OFFSET$description

public static final long OFFSET$description

Constructor Details

XrApiLayerProperties

public XrApiLayerProperties(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a XrApiLayerProperties record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static XrApiLayerProperties allocate(Arena arena)

allocate

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

clone

public static XrApiLayerProperties clone(Arena arena,
 XrApiLayerProperties src)

autoInit

public void autoInit()

type

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

type

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

next

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

next

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

next

public XrApiLayerProperties next(@Nullable
 @Nullable IPointer pointer)

layerName

public BytePtr layerName()

layerName

public XrApiLayerProperties layerName(@NotNull
 @NotNull Consumer<BytePtr> consumer)

layerName

public XrApiLayerProperties layerName(BytePtr value)

layerNameRaw

@NotNull
public @NotNull MemorySegment layerNameRaw()

specVersion

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

specVersion

public XrApiLayerProperties specVersion(@NativeType("XrVersion") @Unsigned
 long value)

layerVersion

@Unsigned
public int layerVersion()

layerVersion

public XrApiLayerProperties layerVersion(@Unsigned
 int value)

description

public BytePtr description()

description

public XrApiLayerProperties description(@NotNull
 @NotNull Consumer<BytePtr> consumer)

description

public XrApiLayerProperties description(BytePtr value)

descriptionRaw

@NotNull
public @NotNull MemorySegment descriptionRaw()

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