Record Class XrApiLayerCreateInfo

java.lang.Object

java.lang.Record

club.doki7.openxr.datatype.XrApiLayerCreateInfo

All Implemented Interfaces:

IPointer, IXrApiLayerCreateInfo

@ValueBasedCandidate
@UnsafeConstructor
public record XrApiLayerCreateInfo(@NotNull MemorySegment segment)
extends Record
implements IXrApiLayerCreateInfo

Represents a pointer to a XrApiLayerCreateInfo structure in native memory.

Structure

typedef struct XrApiLayerCreateInfo {
    XrLoaderInterfaceStructs structType;
    uint32_t structVersion;
    size_t structSize;
    void* loaderInstance;
    char[XR_API_LAYER_MAX_SETTINGS_PATH_SIZE] settings_file_location;
    XrApiLayerNextInfo* nextInfo;
} XrApiLayerCreateInfo;

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:

• XrApiLayerCreateInfo

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	XrApiLayerCreateInfo.Ptr	Represents a pointer to / an array of XrApiLayerCreateInfo 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$loaderInstance
static final AddressLayout	LAYOUT$nextInfo
static final SequenceLayout	LAYOUT$settings_file_location
static final ValueLayout.OfInt	LAYOUT$structType
static final ValueLayout.OfInt	LAYOUT$structVersion
static final long	OFFSET$loaderInstance
static final long	OFFSET$nextInfo
static final long	OFFSET$settings_file_location
static final long	OFFSET$structSize
static final long	OFFSET$structType
static final long	OFFSET$structVersion
static final MemoryLayout.PathElement	PATH$loaderInstance
static final MemoryLayout.PathElement	PATH$nextInfo
static final MemoryLayout.PathElement	PATH$settings_file_location
static final MemoryLayout.PathElement	PATH$structSize
static final MemoryLayout.PathElement	PATH$structType
static final MemoryLayout.PathElement	PATH$structVersion
static final long	SIZE$loaderInstance
static final long	SIZE$nextInfo
static final long	SIZE$settings_file_location
static final long	SIZE$structSize
static final long	SIZE$structType
static final long	SIZE$structVersion

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static XrApiLayerCreateInfo	allocate(Arena arena)
static XrApiLayerCreateInfo.Ptr	allocate(Arena arena, long count)
static XrApiLayerCreateInfo	clone(Arena arena, XrApiLayerCreateInfo 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	loaderInstance()
XrApiLayerCreateInfo	loaderInstance(@Nullable IPointer pointer)
XrApiLayerCreateInfo	loaderInstance(@NotNull MemorySegment value)
@Nullable XrApiLayerNextInfo	nextInfo()
XrApiLayerNextInfo.Ptr	nextInfo(int assumedCount)
XrApiLayerCreateInfo	nextInfo(@Nullable IXrApiLayerNextInfo value)
@NotNull MemorySegment	nextInfoRaw()
void	nextInfoRaw(@NotNull MemorySegment value)
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
BytePtr	settings_file_location()
XrApiLayerCreateInfo	settings_file_location(BytePtr value)
XrApiLayerCreateInfo	settings_file_location(@NotNull Consumer<BytePtr> consumer)
@NotNull MemorySegment	settings_file_locationRaw()
long	structSize()
XrApiLayerCreateInfo	structSize(long value)
int	structType()
XrApiLayerCreateInfo	structType(int value)
int	structVersion()
XrApiLayerCreateInfo	structVersion(int value)
final String	toString()	Returns a string representation of this record class.

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$structType

public static final MemoryLayout.PathElement PATH$structType

PATH$structVersion

public static final MemoryLayout.PathElement PATH$structVersion

PATH$structSize

public static final MemoryLayout.PathElement PATH$structSize

PATH$loaderInstance

public static final MemoryLayout.PathElement PATH$loaderInstance

PATH$settings_file_location

public static final MemoryLayout.PathElement PATH$settings_file_location

PATH$nextInfo

public static final MemoryLayout.PathElement PATH$nextInfo

LAYOUT$structType

public static final ValueLayout.OfInt LAYOUT$structType

LAYOUT$structVersion

public static final ValueLayout.OfInt LAYOUT$structVersion

LAYOUT$loaderInstance

public static final AddressLayout LAYOUT$loaderInstance

LAYOUT$settings_file_location

public static final SequenceLayout LAYOUT$settings_file_location

LAYOUT$nextInfo

public static final AddressLayout LAYOUT$nextInfo

SIZE$structType

public static final long SIZE$structType

SIZE$structVersion

public static final long SIZE$structVersion

SIZE$structSize

public static final long SIZE$structSize

SIZE$loaderInstance

public static final long SIZE$loaderInstance

SIZE$settings_file_location

public static final long SIZE$settings_file_location

SIZE$nextInfo

public static final long SIZE$nextInfo

OFFSET$structType

public static final long OFFSET$structType

OFFSET$structVersion

public static final long OFFSET$structVersion

OFFSET$structSize

public static final long OFFSET$structSize

OFFSET$loaderInstance

public static final long OFFSET$loaderInstance

OFFSET$settings_file_location

public static final long OFFSET$settings_file_location

OFFSET$nextInfo

public static final long OFFSET$nextInfo

Constructor Details

XrApiLayerCreateInfo

public XrApiLayerCreateInfo(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a XrApiLayerCreateInfo record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static XrApiLayerCreateInfo allocate(Arena arena)

allocate

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

clone

public static XrApiLayerCreateInfo clone(Arena arena,
 XrApiLayerCreateInfo src)

structType

@EnumType(XrLoaderInterfaceStructs.class)
public int structType()

structType

public XrApiLayerCreateInfo structType(@EnumType(XrLoaderInterfaceStructs.class)
 int value)

structVersion

@Unsigned
public int structVersion()

structVersion

public XrApiLayerCreateInfo structVersion(@Unsigned
 int value)

structSize

@Unsigned
public long structSize()

structSize

public XrApiLayerCreateInfo structSize(@Unsigned
 long value)

loaderInstance

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

loaderInstance

public XrApiLayerCreateInfo loaderInstance(@Pointer(comment="void*") @NotNull
 @NotNull MemorySegment value)

loaderInstance

public XrApiLayerCreateInfo loaderInstance(@Nullable
 @Nullable IPointer pointer)

settings_file_location

public BytePtr settings_file_location()

settings_file_location

public XrApiLayerCreateInfo settings_file_location(@NotNull
 @NotNull Consumer<BytePtr> consumer)

settings_file_location

public XrApiLayerCreateInfo settings_file_location(BytePtr value)

settings_file_locationRaw

@NotNull
public @NotNull MemorySegment settings_file_locationRaw()

nextInfo

public XrApiLayerCreateInfo nextInfo(@Nullable
 @Nullable IXrApiLayerNextInfo value)

nextInfo

@Unsafe
@Nullable
public XrApiLayerNextInfo.Ptr nextInfo(int assumedCount)

nextInfo

@Nullable
public @Nullable XrApiLayerNextInfo nextInfo()

nextInfoRaw

@Pointer(target=XrApiLayerNextInfo.class)
@NotNull
public @NotNull MemorySegment nextInfoRaw()

nextInfoRaw

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