C Specification

The xrQueryLocalizationMapsML function is defined as:

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

Parameters

Parameter Descriptions

  • session is a handle to an XrSession previously created with xrCreateSession.

  • queryInfo is an optional enumeration filter based on XrLocalizationMapQueryInfoBaseHeaderML to use.

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

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

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

  • See Buffer Size Parameters chapter for a detailed description of retrieving the required maps size.

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. XR_LOCALIZATION_MAP_TYPE_ON_DEVICE_ML or XR_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 xrQueryLocalizationMapsML. This is however a rare occurrence and the application may retry the call again if it receives XR_ERROR_SIZE_INSUFFICIENT.

Valid Usage (Implicit)
Return Codes
On success, this command returns

  • XR_SUCCESS

  • XR_SESSION_LOSS_PENDING

On failure, this command returns

  • XR_ERROR_FUNCTION_UNSUPPORTED

  • XR_ERROR_VALIDATION_FAILURE

  • XR_ERROR_RUNTIME_FAILURE

  • XR_ERROR_HANDLE_INVALID

  • XR_ERROR_INSTANCE_LOST

  • XR_ERROR_SESSION_LOST

  • XR_ERROR_LOCALIZATION_MAP_PERMISSION_DENIED_ML

See Also

XR_ML_localization_map, XrLocalizationMapML, XrLocalizationMapQueryInfoBaseHeaderML, XrSession

Document Notes

For more information, see the OpenXR Specification

This page is extracted from the OpenXR Specification. Fixes and changes should be made to the Specification, not directly.

Copyright

Copyright 2014-2024, The Khronos Group Inc.

This work is licensed under a Creative Commons Attribution 4.0 International License.