Package org.lwjgl.openxr

Class MLCompat

java.lang.Object

org.lwjgl.openxr.MLCompat

public class MLCompat
extends Object

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

Fields

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

Method Summary

Modifier and Type	Method	Description
static int	nxrCreateSpaceFromCoordinateFrameUIDML(XrSession session, long createInfo, long space)	Unsafe version of: CreateSpaceFromCoordinateFrameUIDML
static int	xrCreateSpaceFromCoordinateFrameUIDML(XrSession session, XrCoordinateSpaceCreateInfoML createInfo, org.lwjgl.PointerBuffer space)	Creates a space based on a cfuid.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

XR_ML_compat_SPEC_VERSION

public static final int XR_ML_compat_SPEC_VERSION

The extension specification version.

See Also:

• Constant Field Values

XR_ML_COMPAT_EXTENSION_NAME

public static final String XR_ML_COMPAT_EXTENSION_NAME

The extension name.

See Also:

• Constant Field Values

XR_TYPE_COORDINATE_SPACE_CREATE_INFO_ML

public static final int XR_TYPE_COORDINATE_SPACE_CREATE_INFO_ML

Extends XrStructureType.

See Also:

• Constant Field Values

Method Details

nxrCreateSpaceFromCoordinateFrameUIDML

public static int nxrCreateSpaceFromCoordinateFrameUIDML(XrSession session,
 long createInfo,
 long space)

Unsafe version of: CreateSpaceFromCoordinateFrameUIDML

xrCreateSpaceFromCoordinateFrameUIDML

public static int xrCreateSpaceFromCoordinateFrameUIDML(XrSession session,
 XrCoordinateSpaceCreateInfoML createInfo,
 org.lwjgl.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 an XrCoordinateSpaceCreateInfoML::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 - a handle to an XrSession previously created with CreateSession.

createInfo - the XrCoordinateSpaceCreateInfoML used to specify the space.

space - the returned space handle.