Record Class XrNegotiateApiLayerRequest

java.lang.Object

java.lang.Record

club.doki7.openxr.datatype.XrNegotiateApiLayerRequest

All Implemented Interfaces:

IPointer, IXrNegotiateApiLayerRequest

@ValueBasedCandidate
@UnsafeConstructor
public record XrNegotiateApiLayerRequest(@NotNull MemorySegment segment)
extends Record
implements IXrNegotiateApiLayerRequest

Represents a pointer to a XrNegotiateApiLayerRequest structure in native memory.

Structure

typedef struct XrNegotiateApiLayerRequest {
    XrLoaderInterfaceStructs structType;
    uint32_t structVersion;
    size_t structSize;
    uint32_t layerInterfaceVersion;
    XrVersion layerApiVersion;
    PFN_xrGetInstanceProcAddr getInstanceProcAddr;
    PFN_xrCreateApiLayerInstance createApiLayerInstance;
} XrNegotiateApiLayerRequest;

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:

• XrNegotiateApiLayerRequest

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	XrNegotiateApiLayerRequest.Ptr	Represents a pointer to / an array of XrNegotiateApiLayerRequest 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$createApiLayerInstance
static final AddressLayout	LAYOUT$getInstanceProcAddr
static final ValueLayout.OfLong	LAYOUT$layerApiVersion
static final ValueLayout.OfInt	LAYOUT$layerInterfaceVersion
static final ValueLayout.OfInt	LAYOUT$structType
static final ValueLayout.OfInt	LAYOUT$structVersion
static final long	OFFSET$createApiLayerInstance
static final long	OFFSET$getInstanceProcAddr
static final long	OFFSET$layerApiVersion
static final long	OFFSET$layerInterfaceVersion
static final long	OFFSET$structSize
static final long	OFFSET$structType
static final long	OFFSET$structVersion
static final MemoryLayout.PathElement	PATH$createApiLayerInstance
static final MemoryLayout.PathElement	PATH$getInstanceProcAddr
static final MemoryLayout.PathElement	PATH$layerApiVersion
static final MemoryLayout.PathElement	PATH$layerInterfaceVersion
static final MemoryLayout.PathElement	PATH$structSize
static final MemoryLayout.PathElement	PATH$structType
static final MemoryLayout.PathElement	PATH$structVersion
static final long	SIZE$createApiLayerInstance
static final long	SIZE$getInstanceProcAddr
static final long	SIZE$layerApiVersion
static final long	SIZE$layerInterfaceVersion
static final long	SIZE$structSize
static final long	SIZE$structType
static final long	SIZE$structVersion

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static XrNegotiateApiLayerRequest	allocate(Arena arena)
static XrNegotiateApiLayerRequest.Ptr	allocate(Arena arena, long count)
static XrNegotiateApiLayerRequest	clone(Arena arena, XrNegotiateApiLayerRequest src)
@NotNull MemorySegment	createApiLayerInstance()
XrNegotiateApiLayerRequest	createApiLayerInstance(@Nullable IPointer pointer)
XrNegotiateApiLayerRequest	createApiLayerInstance(@NotNull XRFunctionTypes.IPFN_xrCreateApiLayerInstance value)
XrNegotiateApiLayerRequest	createApiLayerInstance(@NotNull Arena arena, @NotNull XRFunctionTypes.IPFN_xrCreateApiLayerInstance value)
XrNegotiateApiLayerRequest	createApiLayerInstance(@NotNull MemorySegment value)
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
@NotNull MemorySegment	getInstanceProcAddr()
XrNegotiateApiLayerRequest	getInstanceProcAddr(@Nullable IPointer pointer)
XrNegotiateApiLayerRequest	getInstanceProcAddr(@NotNull XRFunctionTypes.IPFN_xrGetInstanceProcAddr value)
XrNegotiateApiLayerRequest	getInstanceProcAddr(@NotNull Arena arena, @NotNull XRFunctionTypes.IPFN_xrGetInstanceProcAddr value)
XrNegotiateApiLayerRequest	getInstanceProcAddr(@NotNull MemorySegment value)
final int	hashCode()	Returns a hash code value for this object.
long	layerApiVersion()
XrNegotiateApiLayerRequest	layerApiVersion(long value)
int	layerInterfaceVersion()
XrNegotiateApiLayerRequest	layerInterfaceVersion(int value)
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
long	structSize()
XrNegotiateApiLayerRequest	structSize(long value)
int	structType()
XrNegotiateApiLayerRequest	structType(int value)
int	structVersion()
XrNegotiateApiLayerRequest	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$layerInterfaceVersion

public static final MemoryLayout.PathElement PATH$layerInterfaceVersion

PATH$layerApiVersion

public static final MemoryLayout.PathElement PATH$layerApiVersion

PATH$getInstanceProcAddr

public static final MemoryLayout.PathElement PATH$getInstanceProcAddr

PATH$createApiLayerInstance

public static final MemoryLayout.PathElement PATH$createApiLayerInstance

LAYOUT$structType

public static final ValueLayout.OfInt LAYOUT$structType

LAYOUT$structVersion

public static final ValueLayout.OfInt LAYOUT$structVersion

LAYOUT$layerInterfaceVersion

public static final ValueLayout.OfInt LAYOUT$layerInterfaceVersion

LAYOUT$layerApiVersion

public static final ValueLayout.OfLong LAYOUT$layerApiVersion

LAYOUT$getInstanceProcAddr

public static final AddressLayout LAYOUT$getInstanceProcAddr

LAYOUT$createApiLayerInstance

public static final AddressLayout LAYOUT$createApiLayerInstance

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

public static final long SIZE$layerInterfaceVersion

SIZE$layerApiVersion

public static final long SIZE$layerApiVersion

SIZE$getInstanceProcAddr

public static final long SIZE$getInstanceProcAddr

SIZE$createApiLayerInstance

public static final long SIZE$createApiLayerInstance

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

public static final long OFFSET$layerInterfaceVersion

OFFSET$layerApiVersion

public static final long OFFSET$layerApiVersion

OFFSET$getInstanceProcAddr

public static final long OFFSET$getInstanceProcAddr

OFFSET$createApiLayerInstance

public static final long OFFSET$createApiLayerInstance

Constructor Details

XrNegotiateApiLayerRequest

public XrNegotiateApiLayerRequest(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a XrNegotiateApiLayerRequest record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static XrNegotiateApiLayerRequest allocate(Arena arena)

allocate

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

clone

public static XrNegotiateApiLayerRequest clone(Arena arena,
 XrNegotiateApiLayerRequest src)

structType

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

structType

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

structVersion

@Unsigned
public int structVersion()

structVersion

public XrNegotiateApiLayerRequest structVersion(@Unsigned
 int value)

structSize

@Unsigned
public long structSize()

structSize

public XrNegotiateApiLayerRequest structSize(@Unsigned
 long value)

layerInterfaceVersion

@Unsigned
public int layerInterfaceVersion()

layerInterfaceVersion

public XrNegotiateApiLayerRequest layerInterfaceVersion(@Unsigned
 int value)

layerApiVersion

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

layerApiVersion

public XrNegotiateApiLayerRequest layerApiVersion(@NativeType("XrVersion") @Unsigned
 long value)

getInstanceProcAddr

@Pointer(comment="PFN_xrGetInstanceProcAddr")
@NotNull
public @NotNull MemorySegment getInstanceProcAddr()

getInstanceProcAddr

public XrNegotiateApiLayerRequest getInstanceProcAddr(@Pointer(comment="PFN_xrGetInstanceProcAddr") @NotNull
 @NotNull MemorySegment value)

getInstanceProcAddr

public XrNegotiateApiLayerRequest getInstanceProcAddr(@NotNull
 @NotNull XRFunctionTypes.IPFN_xrGetInstanceProcAddr value)

getInstanceProcAddr

public XrNegotiateApiLayerRequest getInstanceProcAddr(@NotNull
 @NotNull Arena arena,
 @NotNull
 @NotNull XRFunctionTypes.IPFN_xrGetInstanceProcAddr value)

getInstanceProcAddr

public XrNegotiateApiLayerRequest getInstanceProcAddr(@Nullable
 @Nullable IPointer pointer)

createApiLayerInstance

@Pointer(comment="PFN_xrCreateApiLayerInstance")
@NotNull
public @NotNull MemorySegment createApiLayerInstance()

createApiLayerInstance

public XrNegotiateApiLayerRequest createApiLayerInstance(@Pointer(comment="PFN_xrCreateApiLayerInstance") @NotNull
 @NotNull MemorySegment value)

createApiLayerInstance

public XrNegotiateApiLayerRequest createApiLayerInstance(@NotNull
 @NotNull XRFunctionTypes.IPFN_xrCreateApiLayerInstance value)

createApiLayerInstance

public XrNegotiateApiLayerRequest createApiLayerInstance(@NotNull
 @NotNull Arena arena,
 @NotNull
 @NotNull XRFunctionTypes.IPFN_xrCreateApiLayerInstance value)

createApiLayerInstance

public XrNegotiateApiLayerRequest createApiLayerInstance(@Nullable
 @Nullable IPointer pointer)

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