LWJGL 3.3.3 · org.lwjgl.openxr.MLCompat

public Class MLCompat

The XR_ML_compat extension.

This extension provides functionality to facilitate transitioning from Magic Leap SDK to OpenXR SDK, most notably interoperability between Coordinate Frame UUIDs and XrSpace.

Field Summary

Modifier and Type	Field and Description
public static final String	XR_ML_COMPAT_EXTENSION_NAME The extension name.
public static final int	XR_ML_compat_SPEC_VERSION The extension specification version.
public static final int	XR_TYPE_COORDINATE_SPACE_CREATE_INFO_ML Extends `XrStructureType`.

Constructor Summary

Access	Constructor and Description
protected	MLCompat()

Modifier and Type	Method and Description
public static int	nxrCreateSpaceFromCoordinateFrameUIDML(XrSession session, long createInfo, long space) Unsafe version of: `CreateSpaceFromCoordinateFrameUIDML`
public static int	xrCreateSpaceFromCoordinateFrameUIDML(XrSession a handle to an `XrSession` previously created with `CreateSession`. session, XrCoordinateSpaceCreateInfoML the `XrCoordinateSpaceCreateInfoML` used to specify the space. createInfo, PointerBuffer the returned space handle. space) Creates a space based on a cfuid.

Modifier and Type

Method and Description

public static int

nxrCreateSpaceFromCoordinateFrameUIDML(XrSession session, long createInfo, long space)

Unsafe version of: CreateSpaceFromCoordinateFrameUIDML

public static int

xrCreateSpaceFromCoordinateFrameUIDML(XrSession

a handle to an XrSession previously created with CreateSession.

session, XrCoordinateSpaceCreateInfoML

the XrCoordinateSpaceCreateInfoML used to specify the space.

createInfo, PointerBuffer

the returned space handle.

space)

Creates a space based on a cfuid.

Field Detail

XR_ML_COMPAT_EXTENSION_NAME	back to summary
public static final String XR_ML_COMPAT_EXTENSION_NAME The extension name.

XR_ML_compat_SPEC_VERSION	back to summary
public static final int XR_ML_compat_SPEC_VERSION The extension specification version.

XR_TYPE_COORDINATE_SPACE_CREATE_INFO_ML	back to summary
public static final int XR_TYPE_COORDINATE_SPACE_CREATE_INFO_ML Extends `XrStructureType`.

Constructor Detail

MLCompat	back to summary
protected MLCompat()

Method Detail

nxrCreateSpaceFromCoordinateFrameUIDML	back to summary
public static int nxrCreateSpaceFromCoordinateFrameUIDML(XrSession session, long createInfo, long space) Unsafe version of: `CreateSpaceFromCoordinateFrameUIDML`

xrCreateSpaceFromCoordinateFrameUIDML back to summary

xrCreateSpaceFromCoordinateFrameUIDML	back to summary
public static int xrCreateSpaceFromCoordinateFrameUIDML(XrSession session, XrCoordinateSpaceCreateInfoML createInfo, PointerBuffer space) Creates a space based on a cfuid. C Specification The `CreateSpaceFromCoordinateFrameUIDML` function is defined as: `XrResult xrCreateSpaceFromCoordinateFrameUIDML( XrSession session, const XrCoordinateSpaceCreateInfoML * createInfo, XrSpace* space);` Description The service that created the underlying `XrCoordinateSpaceCreateInfoML::cfuid` must remain active for the lifetime of the `XrSpace`. If `LocateSpace` is called on a space created from a `cfuid` from a no-longer-active service, the runtime may set `XrSpaceLocation::locationFlags` to 0. `XrSpace` handles are destroyed using `DestroySpace`. Valid Usage (Implicit) The `XR_ML_compat` extension must be enabled prior to calling `CreateSpaceFromCoordinateFrameUIDML` `session` must be a valid `XrSession` handle `createInfo` must be a pointer to a valid `XrCoordinateSpaceCreateInfoML` structure `space` must be a pointer to an `XrSpace` handle Return Codes On success, this command returns `SUCCESS` `SESSION_LOSS_PENDING` On failure, this command returns `ERROR_FUNCTION_UNSUPPORTED` `ERROR_VALIDATION_FAILURE` `ERROR_RUNTIME_FAILURE` `ERROR_HANDLE_INVALID` `ERROR_INSTANCE_LOST` `ERROR_SESSION_LOST` `ERROR_OUT_OF_MEMORY` `ERROR_LIMIT_REACHED` `ERROR_POSE_INVALID` See Also `XrCoordinateSpaceCreateInfoML` Parameters session:XrSession a handle to an `XrSession` previously created with `CreateSession`. createInfo:XrCoordinateSpaceCreateInfoML the `XrCoordinateSpaceCreateInfoML` used to specify the space. space:PointerBuffer the returned space handle. Annotations @NativeType:XrResult

public static int xrCreateSpaceFromCoordinateFrameUIDML(XrSession session, XrCoordinateSpaceCreateInfoML createInfo, PointerBuffer space)

Creates a space based on a cfuid.

C Specification

The CreateSpaceFromCoordinateFrameUIDML function is defined as:


XrResult xrCreateSpaceFromCoordinateFrameUIDML(
    XrSession                                   session,
    const XrCoordinateSpaceCreateInfoML *       createInfo,
    XrSpace*                                    space);

Description

The service that created the underlying XrCoordinateSpaceCreateInfoML::cfuid must remain active for the lifetime of the XrSpace. If LocateSpace is called on a space created from a cfuid from a no-longer-active service, the runtime may set XrSpaceLocation::locationFlags to 0.

XrSpace handles are destroyed using DestroySpace.

Valid Usage (Implicit)

The XR_ML_compat extension must be enabled prior to calling CreateSpaceFromCoordinateFrameUIDML
session must be a valid XrSession handle
createInfo must be a pointer to a valid XrCoordinateSpaceCreateInfoML structure
space must be a pointer to an XrSpace handle

Return Codes

On success, this command returns

On failure, this command returns