Enum XrResult

Represents OpenXR's XrResult, which is the return type of all OpenXR function calls.

Namespace: UnityEngine.XR.OpenXR.NativeTypes
Assembly: Unity.XR.OpenXR.dll
Syntax
public enum XrResult
Remarks

Results can fall into three categories:

  • Unqualified Success: The function executed without issue. Success is the only XrResult in this category.
  • Qualified success: The function didn't report an error, but the result might not be what you expected. For example, sending a haptic impulse to a controller requires an active session and gives the XrResult, SessionNotFocused, if your app doesn't have focus. While the result isn't considered an error, the haptic signal isn't sent to the controller, either. Qualified success results typically occur because of the state of the device or runtime. The same function call could execute successfully in other conditions.
  • Error: The function encountered a runtime failure. Error results typically occur because a device doesn't support a feature, a required permission hasn't been obtained, or you invoked the function incorrectly.
Use the XrResultExtensions methods, IsUnqualifiedSuccess(XrResult), IsSuccess(XrResult), and IsError(XrResult) to determine the category of a result. Note that both IsUnqualifiedSuccess() and IsSuccess() return true for the Success result.

Fields

Name Description
ActionTypeMismatch

The API used to retrieve an action’s state does not match the action’s type.
ActionsetNotAttached

A referenced action set is not attached to the session.
ActionsetsAlreadyAttached

The session already has attached action sets.
AnchorAlreadyPersistedAndroid

XrUuidExt passed to the function was already marked to be persisted. (Added by the XR_ANDROID_device_anchor_persistence extension)
AnchorIdNotFoundAndroid

XrUuidExt passed to the function was not found to be a persisted anchor. (Added by the XR_ANDROID_device_anchor_persistence extension)
AnchorNotOwnedByCallerAndroid

Operation not allowed because anchor is not owned by the XrSession in which the function is being called. (Added by the XR_ANDROID_anchor_sharing_export extension)
AnchorNotSupportedForEntityBD

The spatial entity does not support anchor. (Added by the XR_BD_spatial_sensing extension)
AnchorNotTrackingAndroid

Anchor cannot be persisted because it is not tracking. (Added by the XR_ANDROID_device_anchor_persistence extension)
AndroidThreadSettingsFailureKHR

xrSetAndroidApplicationThreadKHR failed setting the thread attributes/priority. (Added by the XR_KHR_android_thread_settings extension)
AndroidThreadSettingsIdInvalidKHR

xrSetAndroidApplicationThreadKHR failed as thread id is invalid. (Added by the XR_KHR_android_thread_settings extension)
AndroidThreadSettingsdFailureKHR

Obsolete. Use AndroidThreadSettingsFailureKHR instead.
ApiLayerNotPresent

A requested API layer is not present or could not be loaded.
ApiVersionUnsupported

The runtime does not support the requested API version.
CallOrderInvalid

The call was made without having made a previously required call.
ColocationDiscoveryAlreadyAdvertisingMETA

Colocation advertisement has already been enabled. (Added by the XR_META_colocation_discovery extension)
ColocationDiscoveryAlreadyDiscoveringMETA

Colocation discovery has already been enabled. (Added by the XR_META_colocation_discovery extension)
ColocationDiscoveryNetworkFailedMETA

The network request failed. (Added by the XR_META_colocation_discovery extension)
ColocationDiscoveryNoDiscoveryMethodMETA

The runtime does not have any methods available to perform discovery. (Added by the XR_META_colocation_discovery extension)
ColorSpaceUnsupportedFB

The color space is not supported by the runtime. (Added by the XR_FB_color_space extension)
ComputeNewSceneNotCompletedMSFT

Compute new scene not completed. (Added by the XR_MSFT_scene_understanding extension)
ControllerModelKeyInvalidMSFT

The controller model key is invalid. (Added by the XR_MSFT_controller_model extension)
CreateSpatialAnchorFailedMSFT

Spatial anchor could not be created at that location. (Added by the XR_MSFT_spatial_anchor extension)
DisplayRefreshRateUnsupportedFB

The display refresh rate is not supported by the platform. (Added by the XR_FB_display_refresh_rate extension)
EnvironmentBlendModeUnsupported

The specified environment blend mode is not supported by the runtime or platform.
EnvironmentDepthNotAvailableMETA

Warning: The requested depth image is not yet available. (Added by the XR_META_environment_depth extension)
EventUnavailable

No event was available.
ExtensionDependencyNotEnabled

One or more of the extensions being enabled has dependency on extensions that are not enabled.
ExtensionDependencyNotEnabledKHR

Provided by XR_KHR_maintenance1
ExtensionNotPresent

A requested extension is not supported.
FacialExpressionPermissionDeniedML

Permission to track facial expressions was not granted (Added by the XR_ML_facial_expression extension)
FeatureAlreadyCreatedPassthroughFB

Trying to create an MR feature when one was already created and only one instance is allowed. (Added by the XR_FB_passthrough extension)
FeatureRequiredPassthroughFB

Requested functionality requires a feature to be created first. (Added by the XR_FB_passthrough extension)
FeatureUnsupported

The requested feature is not supported.
FileAccessError

The file could not be accessed.
FileContentsInvalid

The file’s contents were invalid.
FormFactorUnavailable

The specified form factor is supported, but the device is currently not available, e.g. not plugged in or powered off.
FormFactorUnsupported

The specified form factor is not supported by the current runtime or platform.
FrameDiscarded

A frame has been discarded from composition.
FunctionUnsupported

The requested function was not found or is otherwise unsupported.
FutureInvalidEXT

Returned by completion function to indicate future is not valid. (Added by the XR_EXT_future extension)
FuturePendingEXT

Returned by completion function to indicate future is not ready. (Added by the XR_EXT_future extension)
GraphicsDeviceInvalid

The given graphics device is not in a valid state. The graphics device could be lost or initialized without meeting graphics requirements.
GraphicsRequirementsCallMissing

The xrGetGraphicsRequirements* call was not made before calling xrCreateSession.
HandleInvalid

A supplied object handle was invalid.
HintAlreadySetQCOM

Tracking optimization hint is already set for the domain. (Added by the XR_QCOM_tracking_optimization_settings extension)
IndexOutOfRange

The supplied index was outside the range of valid indices.
InitializationFailed

Initialization of object could not be completed.
InstanceLost

The XrInstance was lost or could not be found. It will need to be destroyed and optionally recreated.
InsufficientResourcesPassthroughFB

There were insufficient resources available to perform an operation. (Added by the XR_FB_passthrough extension)
LayerInvalid

The layer was NULL or otherwise invalid.
LayerLimitExceeded

The number of specified layers is greater than the supported number.
LimitReached

The runtime supports no more of the requested resource.
LocalizationMapAlreadyExistsML

The map being imported already exists in the system. (Added by the XR_ML_localization_map extension)
LocalizationMapCannotExportCloudMapML

The map localization service cannot export cloud based maps. (Added by the XR_ML_localization_map extension)
LocalizationMapFailML

The map localization service failed to fulfill the request, retry later. (Added by the XR_ML_localization_map extension)
LocalizationMapImportExportPermissionDeniedML

The com.magicleap.permission.SPACE_IMPORT_EXPORT permission was denied. (Added by the XR_ML_localization_map extension)
LocalizationMapIncompatibleML

The localization map being imported is not compatible with current OS or mode. (Added by the XR_ML_localization_map extension)
LocalizationMapPermissionDeniedML

The com.magicleap.permission.SPACE_MANAGER permission was denied. (Added by the XR_ML_localization_map extension)
LocalizationMapUnavailableML

The localization map requested is not available. (Added by the XR_ML_localization_map extension)
LocalizedNameDuplicated

The localized name provided was a duplicate of an already-existing resource.
LocalizedNameInvalid

The localized name provided was invalid.
LossPending

The session will be lost soon.
MarkerDetectorInvalidCreateInfoML

createInfo contains mutually exclusive parameters, such as setting XR_MARKER_DETECTOR_CORNER_REFINE_METHOD_APRIL_TAG_ML with XR_MARKER_TYPE_ARUCO_ML. (Added by the XR_ML_marker_understanding extension)
MarkerDetectorInvalidDataQueryML

The marker queried does not contain data of the requested type. (Added by the XR_ML_marker_understanding extension)
MarkerDetectorLocateFailedML

The specified marker could not be located spatially. (Added by the XR_ML_marker_understanding extension)
MarkerDetectorPermissionDeniedML

The com.magicleap.permission.MARKER_TRACKING permission was denied. (Added by the XR_ML_marker_understanding extension)
MarkerIdInvalidVARJO

The specified marker ID is not valid. (Added by the XR_VARJO_marker_tracking extension)
MarkerInvalidML

The marker id passed to the function was invalid. (Added by the XR_ML_marker_understanding extension)
MarkerNotTrackedVARJO

Marker tracking is disabled or the specified marker is not currently tracked. (Added by the XR_VARJO_marker_tracking extension)
MaxResult

Max XR Result Value
MisMatchingTrackableTypeAndroid

Indicates that the parameters contains multiple trackable types. (Added by the XR_ANDROID_trackables extension)
NameDuplicated

The name provided was a duplicate of an already-existing resource.
NameInvalid

The name provided was invalid.
NotAnAnchorHTC

The provided space is valid but not an anchor. (Added by the XR_HTC_anchor extension)
NotInteractionRenderModelEXT

The provided XrRenderModelEXT was not created from a XrRenderModelIdEXT from XR_EXT_interaction_render_model (Added by the XR_EXT_interaction_render_model extension)
NotPermittedPassthroughFB

Requested functionality is not permitted - application is not allowed to perform the requested operation. (Added by the XR_FB_passthrough extension)
OutOfMemory

A memory allocation has failed.
PassthroughColorLutBufferSizeMismatchMETA

The provided data buffer did not match the required size. (Added by the XR_META_passthrough_color_lut extension)
PathCountExceeded

The maximum number of supported semantic paths has been reached.
PathFormatInvalid

The semantic path character format is invalid.
PathInvalid

The provided XrPath was not valid.
PathUnsupported

The semantic path is unsupported.
PermissionInsufficient

Insufficient permissions. This error is included for use by vendor extensions. The precise definition of PermissionInsufficient and actions possible by the developer or user to resolve it can vary by platform, extension or function. The developer should refer to the documentation of the function that returned the error code and extension in which it was defined.
PermissionInsufficientKHR

Provided by XR_KHR_maintenance1
PersistedDataNotReadyAndroid

Persisted data stored by this app has not been loaded yet. (Added by the XR_ANDROID_device_anchor_persistence extension)
PlaneDetectionPermissionDeniedEXT

The permission for this resource was not granted. (Added by the XR_EXT_plane_detection extension)
PoseInvalid

The supplied pose was invalid with respect to the requirements.
ReferenceSpaceUnsupported

The specified reference space is not supported by the runtime or system.
RenderModelAssetUnavailableEXT

The render model asset is unavailable. (Added by the XR_EXT_render_model extension)
RenderModelGltfExtensionRequiredEXT

A glTF extension is required. (Added by the XR_EXT_render_model extension)
RenderModelIdInvalidEXT

The render model ID is invalid. (Added by the XR_EXT_render_model extension)
RenderModelKeyInvalidFB

The model key is invalid. (Added by the XR_FB_render_model extension)
RenderModelUnavailableFB

The model is unavailable. (Added by the XR_FB_render_model extension)
ReprojectionModeUnsupportedMSFT

The reprojection mode is not supported. (Added by the XR_MSFT_composition_layer_reprojection extension)
RuntimeFailure

The runtime failed to handle the function in an unexpected way that is not covered by another error result.
RuntimeUnavailable

The loader was unable to find or load a runtime.
SceneCaptureFailureBD

The scene capture is failed, for example exiting abnormally. (Added by the XR_BD_spatial_scene extension)
SceneComponentIdInvalidMSFT

Scene component id invalid. (Added by the XR_MSFT_scene_understanding extension)
SceneComponentTypeMismatchMSFT

Scene component type mismatch. (Added by the XR_MSFT_scene_understanding extension)
SceneComputeConsistencyMismatchMSFT

Scene compute consistency mismatch. (Added by the XR_MSFT_scene_understanding extension)
SceneComputeFeatureIncompatibleMSFT

Scene compute feature incompatible. (Added by the XR_MSFT_scene_understanding extension)
SceneMarkerDataNotStringMSFT

Marker does not encode a string. (Added by the XR_MSFT_scene_marker extension)
SceneMeshBufferIdInvalidMSFT

Scene mesh buffer id invalid. (Added by the XR_MSFT_scene_understanding extension)
SecondaryViewConfigurationTypeNotEnabledMSFT

The secondary view configuration was not enabled when creating the session. (Added by the XR_MSFT_secondary_view_configuration extension)
ServiceNotReadyAndroid

The underlying tracking service is not yet ready. (Added by the XR_ANDROID_face_tracking extension)
SessionLost

The XrSession was lost. It will need to be destroyed and optionally recreated.
SessionNotFocused

The session is not in the focused state.
SessionNotReady

The session is not in the ready state.
SessionNotRunning

The session is not yet running.
SessionNotStopping

The session is not in the stopping state.
SessionRunning

The session is already running.
SizeInsufficient

The supplied size was smaller than required.
SpaceBoundsUnavailable

The space’s bounds are not known at the moment.
SpaceCloudStorageDisabledFB

Cloud storage is required for this operation but is currently disabled. (Added by the XR_FB_spatial_entity_sharing extension)
SpaceComponentNotEnabledFB

The required component is not enabled for this space. (Added by the XR_FB_spatial_entity extension)
SpaceComponentNotSupportedFB

The component type is not supported for this space. (Added by the XR_FB_spatial_entity extension)
SpaceComponentStatusAlreadySetFB

The component is already set to the requested value. (Added by the XR_FB_spatial_entity extension)
SpaceComponentStatusPendingFB

A request to set the component’s status is currently pending. (Added by the XR_FB_spatial_entity extension)
SpaceGroupNotFoundMETA

The group UUID was not be found within the runtime. (Added by the XR_META_spatial_entity_group_sharing extension)
SpaceInsufficientResourcesMeta

Resource limitation prevented this operation from executing. Recommend retrying, perhaps after a short delay and/or reducing memory consumption. (Added by the XR_META_spatial_entity_persistence extension)
SpaceInsufficientViewMeta

Look around the environment more for space tracking to function. (Added by the XR_META_spatial_entity_persistence extension)
SpaceLocalizationFailedFB

Anchors were downloaded from the cloud but failed to be imported/aligned on the device. (Added by the XR_FB_spatial_entity_sharing extension)
SpaceMappingInsufficientFB

Anchor import from cloud or export from device failed. (Added by the XR_FB_spatial_entity_sharing extension)
SpaceNetworkRequestFailedFB

The network request failed. (Added by the XR_FB_spatial_entity_sharing extension)
SpaceNetworkTimeoutFB

Timeout occurred while waiting for network request to complete. (Added by the XR_FB_spatial_entity_sharing extension)
SpaceNotLocatableEXT

The space passed to the function was not locatable. (Added by the XR_EXT_plane_detection extension)
SpacePermissionInsufficientMeta

Space operation permission insufficient. Recommend confirming the status of the required permissions needed for using Space APIs. (Added by the XR_META_spatial_entity_persistence extension)
SpaceRateLimitedMeta

Operation cancelled due to rate limiting. Recommend retrying after a short delay. (Added by the XR_META_spatial_entity_persistence extension)
SpaceStorageAtCapacityMeta

Operation could not be completed until resources used are reduced or storage expanded. (Added by the XR_META_spatial_entity_persistence extension)
SpaceTooBrightMeta

Environment too bright for tracking to complete operation. (Added by the XR_META_spatial_entity_persistence extension)
SpaceTooDarkMeta

Environment too dark for tracking to complete operation. (Added by the XR_META_spatial_entity_persistence extension)
SpatialAnchorNameInvalidMSFT

The spatial anchor name provided was not valid (Added by the XR_MSFT_spatial_anchor_persistence extension)
SpatialAnchorNameNotFoundMSFT

A spatial anchor was not found associated with the spatial anchor name provided (Added by the XR_MSFT_spatial_anchor_persistence extension)
SpatialAnchorNotFoundBD

The spatial anchor was not found. (Added by the XR_BD_spatial_sensing extension)
SpatialAnchorSharingAuthenticationFailureBD

The spatial anchor sharing experienced an authentication failure. (Added by the XR_BD_spatial_sensing extension)
SpatialAnchorSharingLocaliztionFailBD

The spatial anchor sharing localization failed. (Added by the XR_BD_spatial_sensing extension)
SpatialAnchorSharingMapInsufficientBD

The spatial anchor sharing map is insufficient. (Added by the XR_BD_spatial_sensing extension)
SpatialAnchorSharingNetworkFailureBD

The spatial anchor sharing experienced a network failure. (Added by the XR_BD_spatial_sensing extension)
SpatialAnchorSharingNetworkTimeoutBD

The spatial anchor sharing network experienced a timeout. (Added by the XR_BD_spatial_sensing extension)
SpatialAnchorsAnchorNotFoundML

The anchor references was not found. (Added by the XR_ML_spatial_anchors_storage extension)
SpatialAnchorsNotLocalizedML

Operation failed because the system is not localized into a localization map. (Added by the XR_ML_spatial_anchors extension)
SpatialAnchorsOutOfMapBoundsML

Operation failed because it is performed outside of the localization map. (Added by the XR_ML_spatial_anchors extension)
SpatialAnchorsPermissionDeniedML

The com.magicleap.permission.SPATIAL_ANCHOR permission was not granted. (Added by the XR_ML_spatial_anchors extension)
SpatialAnchorsSpaceNotLocatableML

Operation failed because the space referenced cannot be located. (Added by the XR_ML_spatial_anchors extension)
SpatialBufferIdInvalidEXT

The specified spatial buffer id is invalid or does not exist in the spatial snapshot being used to query for the buffer data. (Added by the XR_EXT_spatial_entity extension)
SpatialCapabilityConfigurationInvalidEXT

The specified spatial capability configuration is invalid. (Added by the XR_EXT_spatial_entity extension)
SpatialCapabilityUnsupportedEXT

The specified spatial capability is not supported by the runtime or the system. (Added by the XR_EXT_spatial_entity extension)
SpatialComponentNotEnabledEXT

The specified spatial component is not enabled for the spatial context. (Added by the XR_EXT_spatial_entity extension)
SpatialComponentUnsupportedForCapabilityEXT

The specified spatial component is not supported by the runtime or the system for the given capability. (Added by the XR_EXT_spatial_entity extension)
SpatialEntityIdInvalidBD

The spatial entity id is invalid. (Added by the XR_BD_spatial_sensing extension)
SpatialEntityIdInvalidEXT

The specified spatial entity id is invalid or an entity with that id does not exist in the environment. (Added by the XR_EXT_spatial_entity extension)
SpatialPersistenceScopeIncompatibleEXT

The scope configured for the persistence context is incompatible for the current spatial entity. (Added by the XR_EXT_spatial_persistence_operations extension)
SpatialPersistenceScopeUnsupportedEXT

The specified spatial persistence scope is not supported by the runtime or the system. (Added by the XR_EXT_spatial_persistence extension)
SpatialSensingServiceUnavailableBD

The spatial sensing service is unavailable. (Added by the XR_BD_spatial_sensing extension)
Success

Function successfully completed.
SwapchainFormatUnsupported

The image format is not supported by the runtime or platform.
SwapchainRectInvalid

The image rect was negatively sized or otherwise invalid.
SystemInvalid

The provided XrSystemId was invalid.
SystemNotificationIncompatibleSkuML

Incompatible SKU detected. (Added by the XR_ML_system_notifications extension)
SystemNotificationPermissionDeniedML

The com.magicleap.permission.SYSTEM_NOTIFICATION permission was not granted. (Added by the XR_ML_system_notifications extension)
TimeInvalid

The provided XrTime was zero, negative, or out of range.
TimeoutExpired

The specified timeout time occurred before the operation could complete.
TimeoutExpored

Obsolete. Use TimeoutExpired instead.
TrackableTypeNotSupportedAndroid

Indicates that the function is not supported by the given trackable type. (Added by the XR_ANDROID_trackables extension)
UnexpectedStatePassthroughFB

The object state is unexpected for the issued command. (Added by the XR_FB_passthrough extension)
UnknownPassthroughFB

Unknown Passthrough error (no further details provided). (Added by the XR_FB_passthrough extension)
ValidationFailure

The function usage was invalid in some way.
ViewConfigurationTypeUnsupported

The specified view configuration type is not supported by the runtime or platform.
WorldMeshDetectorPermissionDeniedML

The world mesh detector permission was not granted. (Added by the XR_ML_world_mesh_detection extension)
WorldMeshDetectorSpaceNotLocatableML

At the time of the call the runtime was unable to locate the space and cannot fulfill your request. (Added by the XR_ML_world_mesh_detection extension)
See Also

Extension Methods