Package org.lwjgl.openxr

Class MLLocalizationMap

java.lang.Object

org.lwjgl.openxr.MLLocalizationMap

public class MLLocalizationMap
extends Object

The XR_ML_localization_map extension.

A Magic Leap localization map is a container that holds metadata about the scanned environment. It is a digital copy of a physical place. A localization map holds spatial anchors, dense mesh, planes, feature points, and positional data.

• Spatial anchors - Used for persistent placement of content.
• Dense mesh - 3D triangulated geometry representing Magic Leap device understanding of the real-world geometry of an area.
• Planes - Large, flat surfaces derived from dense mesh data.

Localization maps can be created on device or in the Magic Leap AR Cloud. There are two types - "On Device" and "Cloud".

• "On Device" for OpenXR (local space for MagicLeap) - are for a single device and can be shared via the export/import mechanism.
• "Cloud" for OpenXR (shared space for MagicLeap) - can be shared across multiple MagicLeap devices in the AR Cloud.

Note

Localization Maps are called Spaces in the Magic Leap C-API.

Permissions

Android applications must have the com.magicleap.permission.SPACE_MANAGER permission listed in their manifest to use these functions:

• QueryLocalizationMapsML
• RequestMapLocalizationML

(protection level: normal)

Android applications must have the com.magicleap.permission.SPACE_IMPORT_EXPORT permission listed in their manifest and granted to use these functions:

• ImportLocalizationMapML
• CreateExportedLocalizationMapML

(protection level: dangerous)

Field Summary

Fields

Modifier and Type	Field	Description
static final int	XR_ERROR_LOCALIZATION_MAP_ALREADY_EXISTS_ML	Extends XrResult.
static final int	XR_ERROR_LOCALIZATION_MAP_CANNOT_EXPORT_CLOUD_MAP_ML	Extends XrResult.
static final int	XR_ERROR_LOCALIZATION_MAP_FAIL_ML	Extends XrResult.
static final int	XR_ERROR_LOCALIZATION_MAP_IMPORT_EXPORT_PERMISSION_DENIED_ML	Extends XrResult.
static final int	XR_ERROR_LOCALIZATION_MAP_INCOMPATIBLE_ML	Extends XrResult.
static final int	XR_ERROR_LOCALIZATION_MAP_PERMISSION_DENIED_ML	Extends XrResult.
static final int	XR_ERROR_LOCALIZATION_MAP_UNAVAILABLE_ML	Extends XrResult.
static final int	XR_LOCALIZATION_MAP_CONFIDENCE_EXCELLENT_ML	XrLocalizationMapConfidenceML - Localization Confidence
static final int	XR_LOCALIZATION_MAP_CONFIDENCE_FAIR_ML	XrLocalizationMapConfidenceML - Localization Confidence
static final int	XR_LOCALIZATION_MAP_CONFIDENCE_GOOD_ML	XrLocalizationMapConfidenceML - Localization Confidence
static final int	XR_LOCALIZATION_MAP_CONFIDENCE_POOR_ML	XrLocalizationMapConfidenceML - Localization Confidence
static final int	XR_LOCALIZATION_MAP_ERROR_EXCESSIVE_MOTION_BIT_ML	XrLocalizationMapErrorFlagBitsML - The world meshing detector flags.
static final int	XR_LOCALIZATION_MAP_ERROR_HEADPOSE_BIT_ML	XrLocalizationMapErrorFlagBitsML - The world meshing detector flags.
static final int	XR_LOCALIZATION_MAP_ERROR_LOW_FEATURE_COUNT_BIT_ML	XrLocalizationMapErrorFlagBitsML - The world meshing detector flags.
static final int	XR_LOCALIZATION_MAP_ERROR_LOW_LIGHT_BIT_ML	XrLocalizationMapErrorFlagBitsML - The world meshing detector flags.
static final int	XR_LOCALIZATION_MAP_ERROR_OUT_OF_MAPPED_AREA_BIT_ML	XrLocalizationMapErrorFlagBitsML - The world meshing detector flags.
static final int	XR_LOCALIZATION_MAP_ERROR_UNKNOWN_BIT_ML	XrLocalizationMapErrorFlagBitsML - The world meshing detector flags.
static final int	XR_LOCALIZATION_MAP_STATE_LOCALIZATION_PENDING_ML	XrLocalizationMapStateML - Localization Map State
static final int	XR_LOCALIZATION_MAP_STATE_LOCALIZATION_SLEEPING_BEFORE_RETRY_ML	XrLocalizationMapStateML - Localization Map State
static final int	XR_LOCALIZATION_MAP_STATE_LOCALIZED_ML	XrLocalizationMapStateML - Localization Map State
static final int	XR_LOCALIZATION_MAP_STATE_NOT_LOCALIZED_ML	XrLocalizationMapStateML - Localization Map State
static final int	XR_LOCALIZATION_MAP_TYPE_CLOUD_ML	XrLocalizationMapTypeML - Localization Map Type
static final int	XR_LOCALIZATION_MAP_TYPE_ON_DEVICE_ML	XrLocalizationMapTypeML - Localization Map Type
static final int	XR_MAX_LOCALIZATION_MAP_NAME_LENGTH_ML	XR_MAX_LOCALIZATION_MAP_NAME_LENGTH_ML
static final String	XR_ML_LOCALIZATION_MAP_EXTENSION_NAME	The extension name.
static final int	XR_ML_localization_map_SPEC_VERSION	The extension specification version.
static final int	XR_OBJECT_TYPE_EXPORTED_LOCALIZATION_MAP_ML	Extends XrObjectType.
static final int	XR_REFERENCE_SPACE_TYPE_LOCALIZATION_MAP_ML	Extends XrReferenceSpaceType.
static final int	XR_TYPE_EVENT_DATA_LOCALIZATION_CHANGED_ML	Extends XrStructureType.
static final int	XR_TYPE_LOCALIZATION_ENABLE_EVENTS_INFO_ML	Extends XrStructureType.
static final int	XR_TYPE_LOCALIZATION_MAP_IMPORT_INFO_ML	Extends XrStructureType.
static final int	XR_TYPE_LOCALIZATION_MAP_ML	Extends XrStructureType.
static final int	XR_TYPE_MAP_LOCALIZATION_REQUEST_INFO_ML	Extends XrStructureType.

Method Summary

Modifier and Type	Method	Description
static int	nxrCreateExportedLocalizationMapML(XrSession session, long mapUuid, long map)	Unsafe version of: CreateExportedLocalizationMapML
static int	nxrEnableLocalizationEventsML(XrSession session, long info)	Unsafe version of: EnableLocalizationEventsML
static int	nxrGetExportedLocalizationMapDataML(XrExportedLocalizationMapML map, int bufferCapacityInput, long bufferCountOutput, long buffer)	Unsafe version of: GetExportedLocalizationMapDataML
static int	nxrImportLocalizationMapML(XrSession session, long importInfo, long mapUuid)	Unsafe version of: ImportLocalizationMapML
static int	nxrQueryLocalizationMapsML(XrSession session, long queryInfo, int mapCapacityInput, long mapCountOutput, long maps)	Unsafe version of: QueryLocalizationMapsML
static int	nxrRequestMapLocalizationML(XrSession session, long requestInfo)	Unsafe version of: RequestMapLocalizationML
static int	xrCreateExportedLocalizationMapML(XrSession session, XrUuidEXT mapUuid, org.lwjgl.PointerBuffer map)	Creates an exported localization map handle.
static int	xrDestroyExportedLocalizationMapML(XrExportedLocalizationMapML map)	Destroys an exported localization map.
static int	xrEnableLocalizationEventsML(XrSession session, XrLocalizationEnableEventsInfoML info)	Retrieve the current localization status.
static int	xrGetExportedLocalizationMapDataML(XrExportedLocalizationMapML map, IntBuffer bufferCountOutput, @Nullable ByteBuffer buffer)	Returns the exported localization map data.
static int	xrImportLocalizationMapML(XrSession session, XrLocalizationMapImportInfoML importInfo, @Nullable XrUuidEXT mapUuid)	Imports a localization map.
static int	xrQueryLocalizationMapsML(XrSession session, @Nullable XrLocalizationMapQueryInfoBaseHeaderML queryInfo, IntBuffer mapCountOutput, @Nullable XrLocalizationMapML.Buffer maps)	Query the available localization maps.
static int	xrRequestMapLocalizationML(XrSession session, XrMapLocalizationRequestInfoML requestInfo)	Requests a localization map.

Methods inherited from class java.lang.Object

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

Field Details

XR_ML_localization_map_SPEC_VERSION

public static final int XR_ML_localization_map_SPEC_VERSION

The extension specification version.

See Also:

• Constant Field Values

XR_ML_LOCALIZATION_MAP_EXTENSION_NAME

public static final String XR_ML_LOCALIZATION_MAP_EXTENSION_NAME

The extension name.

See Also:

• Constant Field Values

XR_OBJECT_TYPE_EXPORTED_LOCALIZATION_MAP_ML

public static final int XR_OBJECT_TYPE_EXPORTED_LOCALIZATION_MAP_ML

Extends XrObjectType.

See Also:

• Constant Field Values

XR_TYPE_LOCALIZATION_MAP_ML

public static final int XR_TYPE_LOCALIZATION_MAP_ML

Extends XrStructureType.

Enum values:

• TYPE_LOCALIZATION_MAP_ML
• TYPE_EVENT_DATA_LOCALIZATION_CHANGED_ML
• TYPE_MAP_LOCALIZATION_REQUEST_INFO_ML
• TYPE_LOCALIZATION_MAP_IMPORT_INFO_ML
• TYPE_LOCALIZATION_ENABLE_EVENTS_INFO_ML

See Also:

• Constant Field Values

XR_TYPE_EVENT_DATA_LOCALIZATION_CHANGED_ML

public static final int XR_TYPE_EVENT_DATA_LOCALIZATION_CHANGED_ML

Extends XrStructureType.

Enum values:

• TYPE_LOCALIZATION_MAP_ML
• TYPE_EVENT_DATA_LOCALIZATION_CHANGED_ML
• TYPE_MAP_LOCALIZATION_REQUEST_INFO_ML
• TYPE_LOCALIZATION_MAP_IMPORT_INFO_ML
• TYPE_LOCALIZATION_ENABLE_EVENTS_INFO_ML

See Also:

• Constant Field Values

XR_TYPE_MAP_LOCALIZATION_REQUEST_INFO_ML

public static final int XR_TYPE_MAP_LOCALIZATION_REQUEST_INFO_ML

Extends XrStructureType.

Enum values:

• TYPE_LOCALIZATION_MAP_ML
• TYPE_EVENT_DATA_LOCALIZATION_CHANGED_ML
• TYPE_MAP_LOCALIZATION_REQUEST_INFO_ML
• TYPE_LOCALIZATION_MAP_IMPORT_INFO_ML
• TYPE_LOCALIZATION_ENABLE_EVENTS_INFO_ML

See Also:

• Constant Field Values

XR_TYPE_LOCALIZATION_MAP_IMPORT_INFO_ML

public static final int XR_TYPE_LOCALIZATION_MAP_IMPORT_INFO_ML

Extends XrStructureType.

Enum values:

• TYPE_LOCALIZATION_MAP_ML
• TYPE_EVENT_DATA_LOCALIZATION_CHANGED_ML
• TYPE_MAP_LOCALIZATION_REQUEST_INFO_ML
• TYPE_LOCALIZATION_MAP_IMPORT_INFO_ML
• TYPE_LOCALIZATION_ENABLE_EVENTS_INFO_ML

See Also:

• Constant Field Values

XR_TYPE_LOCALIZATION_ENABLE_EVENTS_INFO_ML

public static final int XR_TYPE_LOCALIZATION_ENABLE_EVENTS_INFO_ML

Extends XrStructureType.

Enum values:

• TYPE_LOCALIZATION_MAP_ML
• TYPE_EVENT_DATA_LOCALIZATION_CHANGED_ML
• TYPE_MAP_LOCALIZATION_REQUEST_INFO_ML
• TYPE_LOCALIZATION_MAP_IMPORT_INFO_ML
• TYPE_LOCALIZATION_ENABLE_EVENTS_INFO_ML

See Also:

• Constant Field Values

XR_ERROR_LOCALIZATION_MAP_INCOMPATIBLE_ML

public static final int XR_ERROR_LOCALIZATION_MAP_INCOMPATIBLE_ML

Extends XrResult.

Enum values:

• ERROR_LOCALIZATION_MAP_INCOMPATIBLE_ML
• ERROR_LOCALIZATION_MAP_UNAVAILABLE_ML
• ERROR_LOCALIZATION_MAP_FAIL_ML
• ERROR_LOCALIZATION_MAP_IMPORT_EXPORT_PERMISSION_DENIED_ML
• ERROR_LOCALIZATION_MAP_PERMISSION_DENIED_ML
• ERROR_LOCALIZATION_MAP_ALREADY_EXISTS_ML
• ERROR_LOCALIZATION_MAP_CANNOT_EXPORT_CLOUD_MAP_ML

See Also:

• Constant Field Values

XR_ERROR_LOCALIZATION_MAP_UNAVAILABLE_ML

public static final int XR_ERROR_LOCALIZATION_MAP_UNAVAILABLE_ML

Extends XrResult.

Enum values:

• ERROR_LOCALIZATION_MAP_INCOMPATIBLE_ML
• ERROR_LOCALIZATION_MAP_UNAVAILABLE_ML
• ERROR_LOCALIZATION_MAP_FAIL_ML
• ERROR_LOCALIZATION_MAP_IMPORT_EXPORT_PERMISSION_DENIED_ML
• ERROR_LOCALIZATION_MAP_PERMISSION_DENIED_ML
• ERROR_LOCALIZATION_MAP_ALREADY_EXISTS_ML
• ERROR_LOCALIZATION_MAP_CANNOT_EXPORT_CLOUD_MAP_ML

See Also:

• Constant Field Values

XR_ERROR_LOCALIZATION_MAP_FAIL_ML

public static final int XR_ERROR_LOCALIZATION_MAP_FAIL_ML

Extends XrResult.

Enum values:

• ERROR_LOCALIZATION_MAP_INCOMPATIBLE_ML
• ERROR_LOCALIZATION_MAP_UNAVAILABLE_ML
• ERROR_LOCALIZATION_MAP_FAIL_ML
• ERROR_LOCALIZATION_MAP_IMPORT_EXPORT_PERMISSION_DENIED_ML
• ERROR_LOCALIZATION_MAP_PERMISSION_DENIED_ML
• ERROR_LOCALIZATION_MAP_ALREADY_EXISTS_ML
• ERROR_LOCALIZATION_MAP_CANNOT_EXPORT_CLOUD_MAP_ML

See Also:

• Constant Field Values

XR_ERROR_LOCALIZATION_MAP_IMPORT_EXPORT_PERMISSION_DENIED_ML

public static final int XR_ERROR_LOCALIZATION_MAP_IMPORT_EXPORT_PERMISSION_DENIED_ML

Extends XrResult.

Enum values:

• ERROR_LOCALIZATION_MAP_INCOMPATIBLE_ML
• ERROR_LOCALIZATION_MAP_UNAVAILABLE_ML
• ERROR_LOCALIZATION_MAP_FAIL_ML
• ERROR_LOCALIZATION_MAP_IMPORT_EXPORT_PERMISSION_DENIED_ML
• ERROR_LOCALIZATION_MAP_PERMISSION_DENIED_ML
• ERROR_LOCALIZATION_MAP_ALREADY_EXISTS_ML
• ERROR_LOCALIZATION_MAP_CANNOT_EXPORT_CLOUD_MAP_ML

See Also:

• Constant Field Values

XR_ERROR_LOCALIZATION_MAP_PERMISSION_DENIED_ML

public static final int XR_ERROR_LOCALIZATION_MAP_PERMISSION_DENIED_ML

Extends XrResult.

Enum values:

• ERROR_LOCALIZATION_MAP_INCOMPATIBLE_ML
• ERROR_LOCALIZATION_MAP_UNAVAILABLE_ML
• ERROR_LOCALIZATION_MAP_FAIL_ML
• ERROR_LOCALIZATION_MAP_IMPORT_EXPORT_PERMISSION_DENIED_ML
• ERROR_LOCALIZATION_MAP_PERMISSION_DENIED_ML
• ERROR_LOCALIZATION_MAP_ALREADY_EXISTS_ML
• ERROR_LOCALIZATION_MAP_CANNOT_EXPORT_CLOUD_MAP_ML

See Also:

• Constant Field Values

XR_ERROR_LOCALIZATION_MAP_ALREADY_EXISTS_ML

public static final int XR_ERROR_LOCALIZATION_MAP_ALREADY_EXISTS_ML

Extends XrResult.

Enum values:

• ERROR_LOCALIZATION_MAP_INCOMPATIBLE_ML
• ERROR_LOCALIZATION_MAP_UNAVAILABLE_ML
• ERROR_LOCALIZATION_MAP_FAIL_ML
• ERROR_LOCALIZATION_MAP_IMPORT_EXPORT_PERMISSION_DENIED_ML
• ERROR_LOCALIZATION_MAP_PERMISSION_DENIED_ML
• ERROR_LOCALIZATION_MAP_ALREADY_EXISTS_ML
• ERROR_LOCALIZATION_MAP_CANNOT_EXPORT_CLOUD_MAP_ML

See Also:

• Constant Field Values

XR_ERROR_LOCALIZATION_MAP_CANNOT_EXPORT_CLOUD_MAP_ML

public static final int XR_ERROR_LOCALIZATION_MAP_CANNOT_EXPORT_CLOUD_MAP_ML

Extends XrResult.

Enum values:

• ERROR_LOCALIZATION_MAP_INCOMPATIBLE_ML
• ERROR_LOCALIZATION_MAP_UNAVAILABLE_ML
• ERROR_LOCALIZATION_MAP_FAIL_ML
• ERROR_LOCALIZATION_MAP_IMPORT_EXPORT_PERMISSION_DENIED_ML
• ERROR_LOCALIZATION_MAP_PERMISSION_DENIED_ML
• ERROR_LOCALIZATION_MAP_ALREADY_EXISTS_ML
• ERROR_LOCALIZATION_MAP_CANNOT_EXPORT_CLOUD_MAP_ML

See Also:

• Constant Field Values

XR_REFERENCE_SPACE_TYPE_LOCALIZATION_MAP_ML

public static final int XR_REFERENCE_SPACE_TYPE_LOCALIZATION_MAP_ML

Extends XrReferenceSpaceType.

See Also:

• Constant Field Values

XR_MAX_LOCALIZATION_MAP_NAME_LENGTH_ML

public static final int XR_MAX_LOCALIZATION_MAP_NAME_LENGTH_ML

XR_MAX_LOCALIZATION_MAP_NAME_LENGTH_ML

See Also:

• Constant Field Values

XR_LOCALIZATION_MAP_STATE_NOT_LOCALIZED_ML

public static final int XR_LOCALIZATION_MAP_STATE_NOT_LOCALIZED_ML

XrLocalizationMapStateML - Localization Map State

Description

Enum	Description
LOCALIZATION_MAP_STATE_NOT_LOCALIZED_ML	The system is not localized into a map. Features like Spatial Anchors relying on localization will not work.
LOCALIZATION_MAP_STATE_LOCALIZED_ML	The system is localized into a map.
LOCALIZATION_MAP_STATE_LOCALIZATION_PENDING_ML	The system is localizing into a map.
LOCALIZATION_MAP_STATE_LOCALIZATION_SLEEPING_BEFORE_RETRY_ML	Initial localization failed, the system will retry localization.

See Also

XrEventDataLocalizationChangedML

See Also:

• Constant Field Values

XR_LOCALIZATION_MAP_STATE_LOCALIZED_ML

public static final int XR_LOCALIZATION_MAP_STATE_LOCALIZED_ML

XrLocalizationMapStateML - Localization Map State

Description

Enum	Description
LOCALIZATION_MAP_STATE_NOT_LOCALIZED_ML	The system is not localized into a map. Features like Spatial Anchors relying on localization will not work.
LOCALIZATION_MAP_STATE_LOCALIZED_ML	The system is localized into a map.
LOCALIZATION_MAP_STATE_LOCALIZATION_PENDING_ML	The system is localizing into a map.
LOCALIZATION_MAP_STATE_LOCALIZATION_SLEEPING_BEFORE_RETRY_ML	Initial localization failed, the system will retry localization.

See Also

XrEventDataLocalizationChangedML

See Also:

• Constant Field Values

XR_LOCALIZATION_MAP_STATE_LOCALIZATION_PENDING_ML

public static final int XR_LOCALIZATION_MAP_STATE_LOCALIZATION_PENDING_ML

XrLocalizationMapStateML - Localization Map State

Description

Enum	Description
LOCALIZATION_MAP_STATE_NOT_LOCALIZED_ML	The system is not localized into a map. Features like Spatial Anchors relying on localization will not work.
LOCALIZATION_MAP_STATE_LOCALIZED_ML	The system is localized into a map.
LOCALIZATION_MAP_STATE_LOCALIZATION_PENDING_ML	The system is localizing into a map.
LOCALIZATION_MAP_STATE_LOCALIZATION_SLEEPING_BEFORE_RETRY_ML	Initial localization failed, the system will retry localization.

See Also

XrEventDataLocalizationChangedML

See Also:

• Constant Field Values

XR_LOCALIZATION_MAP_STATE_LOCALIZATION_SLEEPING_BEFORE_RETRY_ML

public static final int XR_LOCALIZATION_MAP_STATE_LOCALIZATION_SLEEPING_BEFORE_RETRY_ML

XrLocalizationMapStateML - Localization Map State

Description

Enum	Description
LOCALIZATION_MAP_STATE_NOT_LOCALIZED_ML	The system is not localized into a map. Features like Spatial Anchors relying on localization will not work.
LOCALIZATION_MAP_STATE_LOCALIZED_ML	The system is localized into a map.
LOCALIZATION_MAP_STATE_LOCALIZATION_PENDING_ML	The system is localizing into a map.
LOCALIZATION_MAP_STATE_LOCALIZATION_SLEEPING_BEFORE_RETRY_ML	Initial localization failed, the system will retry localization.

See Also

XrEventDataLocalizationChangedML

See Also:

• Constant Field Values

XR_LOCALIZATION_MAP_TYPE_ON_DEVICE_ML

public static final int XR_LOCALIZATION_MAP_TYPE_ON_DEVICE_ML

XrLocalizationMapTypeML - Localization Map Type

Description

Enum	Description
LOCALIZATION_MAP_TYPE_ON_DEVICE_ML	The system is localized into an On-Device map, published anchors are not shared between different devices.
LOCALIZATION_MAP_TYPE_CLOUD_ML	The system is localized into a Cloud Map, anchors are shared per cloud account settings.

See Also

XrLocalizationMapML

See Also:

• Constant Field Values

XR_LOCALIZATION_MAP_TYPE_CLOUD_ML

public static final int XR_LOCALIZATION_MAP_TYPE_CLOUD_ML

XrLocalizationMapTypeML - Localization Map Type

Description

Enum	Description
LOCALIZATION_MAP_TYPE_ON_DEVICE_ML	The system is localized into an On-Device map, published anchors are not shared between different devices.
LOCALIZATION_MAP_TYPE_CLOUD_ML	The system is localized into a Cloud Map, anchors are shared per cloud account settings.

See Also

XrLocalizationMapML

See Also:

• Constant Field Values

XR_LOCALIZATION_MAP_CONFIDENCE_POOR_ML

public static final int XR_LOCALIZATION_MAP_CONFIDENCE_POOR_ML

XrLocalizationMapConfidenceML - Localization Confidence

Description

Enum	Description
LOCALIZATION_MAP_CONFIDENCE_POOR_ML	The localization map has poor confidence, systems relying on the localization map are likely to have poor performance.
LOCALIZATION_MAP_CONFIDENCE_FAIR_ML	The confidence is fair, current environmental conditions may adversely affect localization.
LOCALIZATION_MAP_CONFIDENCE_GOOD_ML	The confidence is high, persistent content should be stable.
LOCALIZATION_MAP_CONFIDENCE_EXCELLENT_ML	This is a very high-confidence localization, persistent content will be very stable.

See Also

XrEventDataLocalizationChangedML

See Also:

• Constant Field Values

XR_LOCALIZATION_MAP_CONFIDENCE_FAIR_ML

public static final int XR_LOCALIZATION_MAP_CONFIDENCE_FAIR_ML

XrLocalizationMapConfidenceML - Localization Confidence

Description

Enum	Description
LOCALIZATION_MAP_CONFIDENCE_POOR_ML	The localization map has poor confidence, systems relying on the localization map are likely to have poor performance.
LOCALIZATION_MAP_CONFIDENCE_FAIR_ML	The confidence is fair, current environmental conditions may adversely affect localization.
LOCALIZATION_MAP_CONFIDENCE_GOOD_ML	The confidence is high, persistent content should be stable.
LOCALIZATION_MAP_CONFIDENCE_EXCELLENT_ML	This is a very high-confidence localization, persistent content will be very stable.

See Also

XrEventDataLocalizationChangedML

See Also:

• Constant Field Values

XR_LOCALIZATION_MAP_CONFIDENCE_GOOD_ML

public static final int XR_LOCALIZATION_MAP_CONFIDENCE_GOOD_ML

XrLocalizationMapConfidenceML - Localization Confidence

Description

Enum	Description
LOCALIZATION_MAP_CONFIDENCE_POOR_ML	The localization map has poor confidence, systems relying on the localization map are likely to have poor performance.
LOCALIZATION_MAP_CONFIDENCE_FAIR_ML	The confidence is fair, current environmental conditions may adversely affect localization.
LOCALIZATION_MAP_CONFIDENCE_GOOD_ML	The confidence is high, persistent content should be stable.
LOCALIZATION_MAP_CONFIDENCE_EXCELLENT_ML	This is a very high-confidence localization, persistent content will be very stable.

See Also

XrEventDataLocalizationChangedML

See Also:

• Constant Field Values

XR_LOCALIZATION_MAP_CONFIDENCE_EXCELLENT_ML

public static final int XR_LOCALIZATION_MAP_CONFIDENCE_EXCELLENT_ML

XrLocalizationMapConfidenceML - Localization Confidence

Description

Enum	Description
LOCALIZATION_MAP_CONFIDENCE_POOR_ML	The localization map has poor confidence, systems relying on the localization map are likely to have poor performance.
LOCALIZATION_MAP_CONFIDENCE_FAIR_ML	The confidence is fair, current environmental conditions may adversely affect localization.
LOCALIZATION_MAP_CONFIDENCE_GOOD_ML	The confidence is high, persistent content should be stable.
LOCALIZATION_MAP_CONFIDENCE_EXCELLENT_ML	This is a very high-confidence localization, persistent content will be very stable.

See Also

XrEventDataLocalizationChangedML

See Also:

• Constant Field Values

XR_LOCALIZATION_MAP_ERROR_UNKNOWN_BIT_ML

public static final int XR_LOCALIZATION_MAP_ERROR_UNKNOWN_BIT_ML

XrLocalizationMapErrorFlagBitsML - The world meshing detector flags.

Description

The flag bits have the following meanings:

Flag Descriptions

• LOCALIZATION_MAP_ERROR_UNKNOWN_BIT_ML — Localization failed for an unknown reason.
• LOCALIZATION_MAP_ERROR_OUT_OF_MAPPED_AREA_BIT_ML — Localization failed because the user is outside of the mapped area.
• LOCALIZATION_MAP_ERROR_LOW_FEATURE_COUNT_BIT_ML — There are not enough features in the environment to successfully localize.
• LOCALIZATION_MAP_ERROR_EXCESSIVE_MOTION_BIT_ML — Localization failed due to excessive motion.
• LOCALIZATION_MAP_ERROR_LOW_LIGHT_BIT_ML — Localization failed because the lighting levels are too low in the environment.
• LOCALIZATION_MAP_ERROR_HEADPOSE_BIT_ML — A headpose failure caused localization to be unsuccessful.

See Also:

• Constant Field Values

XR_LOCALIZATION_MAP_ERROR_OUT_OF_MAPPED_AREA_BIT_ML

public static final int XR_LOCALIZATION_MAP_ERROR_OUT_OF_MAPPED_AREA_BIT_ML

XrLocalizationMapErrorFlagBitsML - The world meshing detector flags.

Description

The flag bits have the following meanings:

Flag Descriptions

• LOCALIZATION_MAP_ERROR_UNKNOWN_BIT_ML — Localization failed for an unknown reason.
• LOCALIZATION_MAP_ERROR_OUT_OF_MAPPED_AREA_BIT_ML — Localization failed because the user is outside of the mapped area.
• LOCALIZATION_MAP_ERROR_LOW_FEATURE_COUNT_BIT_ML — There are not enough features in the environment to successfully localize.
• LOCALIZATION_MAP_ERROR_EXCESSIVE_MOTION_BIT_ML — Localization failed due to excessive motion.
• LOCALIZATION_MAP_ERROR_LOW_LIGHT_BIT_ML — Localization failed because the lighting levels are too low in the environment.
• LOCALIZATION_MAP_ERROR_HEADPOSE_BIT_ML — A headpose failure caused localization to be unsuccessful.

See Also:

• Constant Field Values

XR_LOCALIZATION_MAP_ERROR_LOW_FEATURE_COUNT_BIT_ML

public static final int XR_LOCALIZATION_MAP_ERROR_LOW_FEATURE_COUNT_BIT_ML

XrLocalizationMapErrorFlagBitsML - The world meshing detector flags.

Description

The flag bits have the following meanings:

Flag Descriptions

• LOCALIZATION_MAP_ERROR_UNKNOWN_BIT_ML — Localization failed for an unknown reason.
• LOCALIZATION_MAP_ERROR_OUT_OF_MAPPED_AREA_BIT_ML — Localization failed because the user is outside of the mapped area.
• LOCALIZATION_MAP_ERROR_LOW_FEATURE_COUNT_BIT_ML — There are not enough features in the environment to successfully localize.
• LOCALIZATION_MAP_ERROR_EXCESSIVE_MOTION_BIT_ML — Localization failed due to excessive motion.
• LOCALIZATION_MAP_ERROR_LOW_LIGHT_BIT_ML — Localization failed because the lighting levels are too low in the environment.
• LOCALIZATION_MAP_ERROR_HEADPOSE_BIT_ML — A headpose failure caused localization to be unsuccessful.

See Also:

• Constant Field Values

XR_LOCALIZATION_MAP_ERROR_EXCESSIVE_MOTION_BIT_ML

public static final int XR_LOCALIZATION_MAP_ERROR_EXCESSIVE_MOTION_BIT_ML

XrLocalizationMapErrorFlagBitsML - The world meshing detector flags.

Description

The flag bits have the following meanings:

Flag Descriptions

• LOCALIZATION_MAP_ERROR_UNKNOWN_BIT_ML — Localization failed for an unknown reason.
• LOCALIZATION_MAP_ERROR_OUT_OF_MAPPED_AREA_BIT_ML — Localization failed because the user is outside of the mapped area.
• LOCALIZATION_MAP_ERROR_LOW_FEATURE_COUNT_BIT_ML — There are not enough features in the environment to successfully localize.
• LOCALIZATION_MAP_ERROR_EXCESSIVE_MOTION_BIT_ML — Localization failed due to excessive motion.
• LOCALIZATION_MAP_ERROR_LOW_LIGHT_BIT_ML — Localization failed because the lighting levels are too low in the environment.
• LOCALIZATION_MAP_ERROR_HEADPOSE_BIT_ML — A headpose failure caused localization to be unsuccessful.

See Also:

• Constant Field Values

XR_LOCALIZATION_MAP_ERROR_LOW_LIGHT_BIT_ML

public static final int XR_LOCALIZATION_MAP_ERROR_LOW_LIGHT_BIT_ML

XrLocalizationMapErrorFlagBitsML - The world meshing detector flags.

Description

The flag bits have the following meanings:

Flag Descriptions

• LOCALIZATION_MAP_ERROR_UNKNOWN_BIT_ML — Localization failed for an unknown reason.
• LOCALIZATION_MAP_ERROR_OUT_OF_MAPPED_AREA_BIT_ML — Localization failed because the user is outside of the mapped area.
• LOCALIZATION_MAP_ERROR_LOW_FEATURE_COUNT_BIT_ML — There are not enough features in the environment to successfully localize.
• LOCALIZATION_MAP_ERROR_EXCESSIVE_MOTION_BIT_ML — Localization failed due to excessive motion.
• LOCALIZATION_MAP_ERROR_LOW_LIGHT_BIT_ML — Localization failed because the lighting levels are too low in the environment.
• LOCALIZATION_MAP_ERROR_HEADPOSE_BIT_ML — A headpose failure caused localization to be unsuccessful.

See Also:

• Constant Field Values

XR_LOCALIZATION_MAP_ERROR_HEADPOSE_BIT_ML

public static final int XR_LOCALIZATION_MAP_ERROR_HEADPOSE_BIT_ML

XrLocalizationMapErrorFlagBitsML - The world meshing detector flags.

Description

The flag bits have the following meanings:

Flag Descriptions

• LOCALIZATION_MAP_ERROR_UNKNOWN_BIT_ML — Localization failed for an unknown reason.
• LOCALIZATION_MAP_ERROR_OUT_OF_MAPPED_AREA_BIT_ML — Localization failed because the user is outside of the mapped area.
• LOCALIZATION_MAP_ERROR_LOW_FEATURE_COUNT_BIT_ML — There are not enough features in the environment to successfully localize.
• LOCALIZATION_MAP_ERROR_EXCESSIVE_MOTION_BIT_ML — Localization failed due to excessive motion.
• LOCALIZATION_MAP_ERROR_LOW_LIGHT_BIT_ML — Localization failed because the lighting levels are too low in the environment.
• LOCALIZATION_MAP_ERROR_HEADPOSE_BIT_ML — A headpose failure caused localization to be unsuccessful.

See Also:

• Constant Field Values

Method Details

nxrEnableLocalizationEventsML

public static int nxrEnableLocalizationEventsML(XrSession session,
 long info)

Unsafe version of: EnableLocalizationEventsML

xrEnableLocalizationEventsML

public static int xrEnableLocalizationEventsML(XrSession session,
 XrLocalizationEnableEventsInfoML info)

Retrieve the current localization status.

C Specification

The EnableLocalizationEventsML function is defined as:

 XrResult xrEnableLocalizationEventsML(
     XrSession                                   session,
     const XrLocalizationEnableEventsInfoML *    info);

Valid Usage (Implicit)

• The XR_ML_localization_map extension must be enabled prior to calling EnableLocalizationEventsML
• session must be a valid XrSession handle
• info must be a pointer to a valid XrLocalizationEnableEventsInfoML structure

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_LOCALIZATION_MAP_PERMISSION_DENIED_ML

See Also

XrEventDataLocalizationChangedML, XrLocalizationEnableEventsInfoML

Parameters:

session - a handle to an XrSession previously created with CreateSession.

info - a pointer to an XrLocalizationEnableEventsInfoML structure.

nxrQueryLocalizationMapsML

public static int nxrQueryLocalizationMapsML(XrSession session,
 long queryInfo,
 int mapCapacityInput,
 long mapCountOutput,
 long maps)

Unsafe version of: QueryLocalizationMapsML

Parameters:

mapCapacityInput - the capacity of the maps array, or 0 to indicate a request to retrieve the required capacity.

xrQueryLocalizationMapsML

public static int xrQueryLocalizationMapsML(XrSession session,
 @Nullable XrLocalizationMapQueryInfoBaseHeaderML queryInfo,
 IntBuffer mapCountOutput,
 @Nullable XrLocalizationMapML.Buffer maps)

Query the available localization maps.

C Specification

The QueryLocalizationMapsML function is defined as:

 XrResult xrQueryLocalizationMapsML(
     XrSession                                   session,
     const XrLocalizationMapQueryInfoBaseHeaderML* queryInfo,
     uint32_t                                    mapCapacityInput,
     uint32_t *                                  mapCountOutput,
     XrLocalizationMapML*                        maps);

Description

The list of localization maps returned will depend on the current device mapping mode. Only the localization maps associated with the current mapping mode will be returned by this call. Device mapping mode (e.g. LOCALIZATION_MAP_TYPE_ON_DEVICE_ML or LOCALIZATION_MAP_TYPE_CLOUD_ML) can only be changed via the system application(s).

The list of maps known to the runtime may change between the two calls to QueryLocalizationMapsML. This is however a rare occurrence and the application may retry the call again if it receives ERROR_SIZE_INSUFFICIENT.

Valid Usage (Implicit)

• The XR_ML_localization_map extension must be enabled prior to calling QueryLocalizationMapsML
• session must be a valid XrSession handle
• If queryInfo is not NULL, queryInfo must be a pointer to a valid XrLocalizationMapQueryInfoBaseHeaderML-based structure
• mapCountOutput must be a pointer to a uint32_t value
• If mapCapacityInput is not 0, maps must be a pointer to an array of mapCapacityInput XrLocalizationMapML structures

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_LOCALIZATION_MAP_PERMISSION_DENIED_ML

See Also

XrLocalizationMapML, XrLocalizationMapQueryInfoBaseHeaderML

Parameters:

session - a handle to an XrSession previously created with CreateSession.

queryInfo - an optional enumeration filter based on XrLocalizationMapQueryInfoBaseHeaderML to use.

mapCountOutput - filled in by the runtime with the count of maps written or the required capacity in the case that mapCapacityInput is insufficient.

maps - an array of XrLocalizationMapML filled in by the runtime, but can be NULL if mapCapacityInput is 0.

nxrRequestMapLocalizationML

public static int nxrRequestMapLocalizationML(XrSession session,
 long requestInfo)

Unsafe version of: RequestMapLocalizationML

xrRequestMapLocalizationML

public static int xrRequestMapLocalizationML(XrSession session,
 XrMapLocalizationRequestInfoML requestInfo)

Requests a localization map.

C Specification

The RequestMapLocalizationML function is defined as:

 XrResult xrRequestMapLocalizationML(
     XrSession                                   session,
     const XrMapLocalizationRequestInfoML*       requestInfo);

Description

This is an asynchronous request. Listen for XrEventDataLocalizationChangedML events to get the results of the localization. A new request for localization will override all the past requests for localization that are yet to be completed.

The runtime must return ERROR_LOCALIZATION_MAP_UNAVAILABLE_ML if the requested is not a map known to the runtime.

Valid Usage (Implicit)

• The XR_ML_localization_map extension must be enabled prior to calling RequestMapLocalizationML
• session must be a valid XrSession handle
• requestInfo must be a pointer to a valid XrMapLocalizationRequestInfoML structure

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_LOCALIZATION_MAP_UNAVAILABLE_ML
• ERROR_LOCALIZATION_MAP_PERMISSION_DENIED_ML
• ERROR_LOCALIZATION_MAP_FAIL_ML

See Also

XrMapLocalizationRequestInfoML

Parameters:

session - a handle to an XrSession previously created with CreateSession.

requestInfo - contains XrMapLocalizationRequestInfoML on the localization map to request.

nxrImportLocalizationMapML

public static int nxrImportLocalizationMapML(XrSession session,
 long importInfo,
 long mapUuid)

Unsafe version of: ImportLocalizationMapML

xrImportLocalizationMapML

public static int xrImportLocalizationMapML(XrSession session,
 XrLocalizationMapImportInfoML importInfo,
 @Nullable XrUuidEXT mapUuid)

Imports a localization map.

C Specification

The ImportLocalizationMapML function is defined as:

 XrResult xrImportLocalizationMapML(
     XrSession                                   session,
     const XrLocalizationMapImportInfoML*        importInfo,
     XrUuidEXT*                                  mapUuid);

Description

The runtime must return ERROR_LOCALIZATION_MAP_ALREADY_EXISTS_ML if the map that is being imported already exists. The runtime must return ERROR_LOCALIZATION_MAP_INCOMPATIBLE_ML if the map being imported is not compatible.

ImportLocalizationMapML may take a long time to complete; as such applications should not call this from the frame loop.

Valid Usage (Implicit)

• The XR_ML_localization_map extension must be enabled prior to calling ImportLocalizationMapML
• session must be a valid XrSession handle
• importInfo must be a pointer to a valid XrLocalizationMapImportInfoML structure
• If mapUuid is not NULL, mapUuid must be a pointer to an XrUuidEXT structure

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_LOCALIZATION_MAP_INCOMPATIBLE_ML
• ERROR_LOCALIZATION_MAP_IMPORT_EXPORT_PERMISSION_DENIED_ML
• ERROR_LOCALIZATION_MAP_ALREADY_EXISTS_ML

See Also

XrLocalizationMapImportInfoML, XrUuidEXT

Parameters:

session - a handle to an XrSession previously created with CreateSession.

importInfo - contains XrLocalizationMapImportInfoML on the localization map to import.

mapUuid - the XrUuidEXT of the newly imported localization map filled in by the runtime.

nxrCreateExportedLocalizationMapML

public static int nxrCreateExportedLocalizationMapML(XrSession session,
 long mapUuid,
 long map)

Unsafe version of: CreateExportedLocalizationMapML

xrCreateExportedLocalizationMapML

public static int xrCreateExportedLocalizationMapML(XrSession session,
 XrUuidEXT mapUuid,
 org.lwjgl.PointerBuffer map)

Creates an exported localization map handle.

C Specification

The CreateExportedLocalizationMapML function is defined as:

 XrResult xrCreateExportedLocalizationMapML(
     XrSession                                   session,
     const XrUuidEXT*                            mapUuid,
     XrExportedLocalizationMapML*                map);

Description

CreateExportedLocalizationMapML creates a frozen copy of the mapUuid localization map that can be exported using GetExportedLocalizationMapDataML. Applications should call DestroyExportedLocalizationMapML once they are done with the data.

Valid Usage (Implicit)

• The XR_ML_localization_map extension must be enabled prior to calling CreateExportedLocalizationMapML
• session must be a valid XrSession handle
• mapUuid must be a pointer to a valid XrUuidEXT structure
• map must be a pointer to an XrExportedLocalizationMapML 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_LOCALIZATION_MAP_UNAVAILABLE_ML
• ERROR_LOCALIZATION_MAP_IMPORT_EXPORT_PERMISSION_DENIED_ML
• ERROR_LOCALIZATION_MAP_CANNOT_EXPORT_CLOUD_MAP_ML

See Also

XrUuidEXT, GetExportedLocalizationMapDataML

Parameters:

session - a handle to an XrSession previously created with CreateSession.

mapUuid - a pointer to the uuid of the map to export.

map - a pointer to a map handle filled in by the runtime.

xrDestroyExportedLocalizationMapML

public static int xrDestroyExportedLocalizationMapML(XrExportedLocalizationMapML map)

Destroys an exported localization map.

C Specification

The DestroyExportedLocalizationMapML function is defined as:

 XrResult xrDestroyExportedLocalizationMapML(
     XrExportedLocalizationMapML                 map);

Valid Usage (Implicit)

• The XR_ML_localization_map extension must be enabled prior to calling DestroyExportedLocalizationMapML
• map must be a valid XrExportedLocalizationMapML handle

Thread Safety

• Access to map, and any child handles, must be externally synchronized

Return Codes

On success, this command returns

• SUCCESS

On failure, this command returns

• ERROR_FUNCTION_UNSUPPORTED
• ERROR_RUNTIME_FAILURE
• ERROR_HANDLE_INVALID

See Also

CreateExportedLocalizationMapML

Parameters:

map - the map to destroy.

nxrGetExportedLocalizationMapDataML

public static int nxrGetExportedLocalizationMapDataML(XrExportedLocalizationMapML map,
 int bufferCapacityInput,
 long bufferCountOutput,
 long buffer)

Unsafe version of: GetExportedLocalizationMapDataML

Parameters:

bufferCapacityInput - the capacity of the buffer array, or 0 to indicate a request to retrieve the required capacity.

xrGetExportedLocalizationMapDataML

public static int xrGetExportedLocalizationMapDataML(XrExportedLocalizationMapML map,
 IntBuffer bufferCountOutput,
 @Nullable ByteBuffer buffer)

Returns the exported localization map data.

C Specification

The GetExportedLocalizationMapDataML function is defined as:

 XrResult xrGetExportedLocalizationMapDataML(
     XrExportedLocalizationMapML                 map,
     uint32_t                                    bufferCapacityInput,
     uint32_t*                                   bufferCountOutput,
     char*                                       buffer);

Description

GetExportedLocalizationMapDataML may take a long time to complete; as such applications should not call this from the frame loop.

Valid Usage (Implicit)

• The XR_ML_localization_map extension must be enabled prior to calling GetExportedLocalizationMapDataML
• map must be a valid XrExportedLocalizationMapML handle
• bufferCountOutput must be a pointer to a uint32_t value
• If bufferCapacityInput is not 0, buffer must be a pointer to an array of bufferCapacityInput char values

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

See Also

CreateExportedLocalizationMapML

Parameters:

map - the map to export.

bufferCountOutput - filled in by the runtime with the count of bytes written or the required capacity in the case that bufferCapacityInput is insufficient.

buffer - an array of bytes filled in by the runtime.