Android XR Unity Extensions v1.1.0

Author: salarkhan-google

CHANGELOG.md

@@ -8,6 +8,37 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this package adheres to
 [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## [1.1.0] - 2025-06-27
+
+### Editor version and package compatibility
+
+  * This version of the package requires minimal Unity Editor version `6000.1.0b12`. You can install the official **Unity 6.1** (e.g. `6000.1.0f1` or newer) from the Unity Hub.
+  * Verified compatible packages:
+    * Unity OpenXR Android XR (`com.unity.xr.androidxr-openxr`) 1.0.0-pre.3
+
+### Known issues
+  * None
+
+### Added
+  * None
+
+### Changed
+  * **Subsampling (Vulkan)** is now enabled by default in **Android XR (Extensions): Session Management**. To use it at runtime:
+    * Foveation feature is required for **Subsampling (Vulkan)**. Otherwise, the application may result in rendering faulty.
+    * For projects with Universal Render Pipeline (URP), select **Foveated Rendering** featurem. Check [Foveated rendering in OpenXR](https://docs.unity3d.com/Packages/[email protected]/manual/features/foveatedrendering.html) for more details.
+    * For projects with Built-in Render Pipeline (BiRP), select **Foveation (Legacy)** feature for legacy support.
+  * **Scene Meshing** is promoted from experimental feature to release feature.
+
+### Deprecated
+  * None
+
+### Removed
+  * None
+
+### Fixed
+  * Fixed [issue#7](https://github.com/android/android-xr-unity-package/issues/7): Compile Errors with Google.XR.Extensions on Non-Android Platforms.
+  * Fixed enum value and comments in `XRFaceParameterIndices`.
+
 ## [1.0.0] - 2025-05-07
 
 ### Editor version and package compatibility

Editor/Internal/XRSessionFeatureBuildHooks.cs

@@ -350,15 +350,11 @@ private bool CheckExperimentalPermission()
             XRBodyTrackingFeature bodyTracking =
                 AndroidXRBuildUtils.GetActiveFeature<XRBodyTrackingFeature>();
             bodyTrackingInUse = bodyTracking != null && bodyTracking.enabled;
-            bool sceneMeshingInUse = false;
-            XRSceneMeshingFeature sceneMeshing =
-                AndroidXRBuildUtils.GetActiveFeature<XRSceneMeshingFeature>();
-            sceneMeshingInUse = sceneMeshing != null && sceneMeshing.enabled;
             bool systemStateInUse = false;
             XRSystemStateFeature systemState =
                 AndroidXRBuildUtils.GetActiveFeature<XRSystemStateFeature>();
             systemStateInUse = systemState != null && systemState.enabled;
-            return bodyTrackingInUse || sceneMeshingInUse || systemStateInUse;
+            return bodyTrackingInUse || systemStateInUse;
         }
     }
 }

Editor/Internal/XRSessionFeatureEditor.cs

@@ -36,7 +36,9 @@ internal class XRSessionFeatureEditor : Editor
         private const string _subsamplingFieldName = "_vulkanSubsampling";
         private const string _subsamplingTooltip =
             "Enable Subsampling (Vulkan) to reduce memory bandwidth on foveated framebuffers. " +
-            "It only takes effect when Foveated Rendering feature is in use.";
+            "This requires the <b>Foveated Rendering</b> feature to be enabled or " +
+            "<b>Foveation (Legacy)</b> for legacy support. " +
+            "Otherwise, the application will result in rendering faulty.";
 
         private const string _spacewarpFieldName = "_spacewarp";
         private const string _spacewarpTooltip =

README.md

@@ -2,16 +2,19 @@
 
 The Android XR Extensions for Unity provide APIs for the following:
 
-1.  Anchor.
-2.  Object Tracking.
-3.  Passthrough Composition Layer.
-4.  Plane.
-5.  Session Management.
-6.  Face Tracking.
-7.  Unbounded Reference Space.
-8.  Environment Blend Mode.
-9.  Foveation (Legacy).
-10. Mouse Interaction Profile.
+1.  Session Management: required for all Android XR Extensions' features.
+2.  Environment Blend Mode.
+3.  Object Tracking.
+4.  Face Tracking.
+5.  Marker Tracking.
+6.  QR Code Tracking.
+7.  Hand Mesh.
+8.  Scene Meshing.
+9.  Unbounded Reference Space.
+10. Passthrough Composition Layer.
+11. Mouse Interaction Profile.
+12. Body Tracking *(Experimental)*.
+13. System State *(Experimental)*.
 
 ## How to use
 
@@ -22,8 +25,11 @@ The Android XR Extensions for Unity provide APIs for the following:
     then check **OpenXR** as the plug-in provider at OpenXR runtime.
 3.  Under **XR Plug-in Management > OpenXR**, switch to **Android** tab, select
     **Android XR (Extensions)** feature group, or select individual features
-    that your want to use at OpenXR runtime. Some of them might be incompatible
-    with another, refer to the *README.md* from each sample for more details.
+    that your want to use at OpenXR runtime.
+
+    NOTE: Some of them might have additional requirements or configuration,
+    refer to the *README.md* from each sample for more details.
+
 4.  Under **XR Plug-in Management > Project Validation**, fix all **OpenXR**
     related issues. This will help to configure your **Player Settings**.
 5.  In **Player > Android > Identification > Minimal API Level**, select 24 or

Runtime/AndroidXRRuntimeImageLibrary.cs

@@ -27,7 +27,7 @@ namespace Google.XR.Extensions
 
     /// <summary>
     /// Constructs a <see cref="RuntimeReferenceImageLibrary"/> which stores reference images
-    /// for QR Code trackng at Android XR devices.
+    /// for Marker Tracking and QR Code trackng at Android XR devices.
     /// </summary>
     [SuppressMessage(
         "UnityRules.UnityStyleRules", "US1109:PublicPropertiesMustBeUpperCamelCase",
@@ -235,9 +235,9 @@ public static void ValidateMarker(IReferenceImageLibrary imageLibrary)
 #endif // UNITY_EDITOR
 
         /// <summary>
-        /// Determine if the given refernce image is a QR code reference.
+        /// Determine if the given reference image is a QR code reference.
         /// </summary>
-        /// <param name="image">The refernce image with QR code name.</param>
+        /// <param name="image">The reference image with QR code name.</param>
         /// <returns>
         /// <c>true</c>, if it's a valid QR code reference.
         /// </returns>
@@ -247,9 +247,9 @@ public static bool IsQrCodeReference(XRReferenceImage image)
         }
 
         /// <summary>
-        /// Determine if the given refernce image is a marker reference.
+        /// Determine if the given reference image is a marker reference.
         /// </summary>
-        /// <param name="image">The refernce image with marker name or generated from
+        /// <param name="image">The reference image with marker name or generated from
         /// <see cref="XRMarkerDatabase"/>.</param>
         /// <returns>
         /// <c>true</c>, if it's a valid marker reference.

Runtime/Features/XRBodyTrackingFeature.cs

@@ -73,7 +73,7 @@ public class XRBodyTrackingFeature : OpenXRFeature
         public const string ExtensionString = "XR_ANDROIDX_body_tracking";
 
         /// <summary>
-        /// Runtime permission requried to enable body tracking.
+        /// Runtime permission required to enable body tracking.
         /// </summary>
         public static readonly AndroidXRPermission RequiredPermission =
             AndroidXRPermission.BodyTracking;

Runtime/Features/XRSceneMeshingFeature.cs

@@ -31,7 +31,7 @@ namespace Google.XR.Extensions
 #endif  // UNITY_EDITOR
 
     /// <summary>
-    /// This feature provides access to the <c>XR_ANDROIDX_scene_meshing</c> extension.
+    /// This feature provides access to the <c>XR_ANDROID_scene_meshing</c> extension.
     /// </summary>
 #if UNITY_EDITOR
     [OpenXRFeature(
@@ -50,7 +50,7 @@ public class XRSceneMeshingFeature : OpenXRFeature
         /// The UI name shows on the XR Plug-in Management panel, help users to understand
         /// validation errors and expected fixes.
         /// </summary>
-        public const string UiName = "Android XR (Extensions): Scene Meshing (Experimental*)";
+        public const string UiName = "Android XR (Extensions): Scene Meshing";
 
         /// <summary>
         /// The feature ID string.
@@ -60,7 +60,7 @@ public class XRSceneMeshingFeature : OpenXRFeature
         /// <summary>
         /// The required OpenXR extension.
         /// </summary>
-        public const string ExtensionString = "XR_ANDROIDX_scene_meshing";
+        public const string ExtensionString = "XR_ANDROID_scene_meshing";
 
         /// <summary>
         /// Runtime permission required to enable scene understanding fine.
@@ -73,7 +73,7 @@ public class XRSceneMeshingFeature : OpenXRFeature
         /// <summary>
         /// Gets if the required OpenXR extension is enabled.
         /// When OpenXR runtime is waiting, it returns <c>null</c>. Otherwise, it indicates
-        /// whether the <c>XR_ANDROIDX_scene_meshing</c> extensions is
+        /// whether the <c>XR_ANDROID_scene_meshing</c> extensions is
         /// available on current device.
         /// </summary>
         public static bool? IsExtensionEnabled => _extensionEnabled;
@@ -108,7 +108,7 @@ protected override void OnSubsystemCreate()
         /// <inheritdoc/>
         protected override void OnSubsystemStart()
         {
-            XRSceneMeshingApi.Enable();
+            XRSceneMeshingApi.SetEnabled(true);
             //// Currently, this feature is not compatible with ARMeshManager due to ARMeshManager
             //// creating and destroying meshes very fast. Expect to use XRMeshSubsystem directly
             //// and rely on OpenXRFeature's subsystem callbacks to manage XRMeshSubsystem's
@@ -119,7 +119,7 @@ protected override void OnSubsystemStart()
         /// <inheritdoc/>
         protected override void OnSubsystemStop()
         {
-            XRSceneMeshingApi.Disable();
+            XRSceneMeshingApi.SetEnabled(false);
             //// Currently, this feature is not compatible with ARMeshManager due to ARMeshManager
             //// creating and destroying meshes very fast. Expect to use XRMeshSubsystem directly
             //// and rely on OpenXRFeature's subsystem callbacks to manage XRMeshSubsystem's
@@ -132,20 +132,5 @@ protected override void OnSubsystemDestroy()
         {
             DestroySubsystem<XRMeshSubsystem>();
         }
-
-#if UNITY_EDITOR
-        /// <inheritdoc/>
-        protected override void GetValidationChecks(
-            List<ValidationRule> results, BuildTargetGroup targetGroup)
-        {
-            if (targetGroup != BuildTargetGroup.Android)
-            {
-                return;
-            }
-
-            results.Add(AndroidXRFeatureUtils.GetExperimentalFeatureValidationCheck(
-                this, UiName, targetGroup));
-        }
-#endif // UNITY_EDITOR
     }
 }

Runtime/Features/XRSessionFeature.cs

@@ -95,7 +95,7 @@ public class XRSessionFeature : OpenXRFeature
         private static bool _arSessionFeatureInUse = false;
 
         [SerializeField]
-        private bool _vulkanSubsampling = false;
+        private bool _vulkanSubsampling = true;
 
         [SerializeField]
         private bool _spacewarp = false;
@@ -312,5 +312,66 @@ protected override void OnSubsystemDestroy()
                 _sessionSubsystem = null;
             }
         }
+
+#if UNITY_EDITOR
+        /// <inheritdoc/>
+        protected override void GetValidationChecks(
+            List<ValidationRule> results, BuildTargetGroup targetGroup)
+        {
+            if (targetGroup != BuildTargetGroup.Android)
+            {
+                return;
+            }
+
+            results.Add(new ValidationRule(this)
+            {
+                message = "Foveation feature is required for <b>Subsampling (Vulkan)</b>.",
+                checkPredicate = () =>
+                {
+                    if (!VulkanSubsampling)
+                    {
+                        return true;
+                    }
+
+                    var settings = OpenXRSettings.GetSettingsForBuildTargetGroup(targetGroup);
+                    if (settings == null)
+                    {
+                        return false;
+                    }
+
+                    var foveation = GraphicsSettings.defaultRenderPipeline == null ?
+                      settings.GetFeature<XRFoveationFeature>() as OpenXRFeature:
+                      settings.GetFeature<FoveatedRenderingFeature>();
+                    return foveation != null && foveation.enabled;
+                },
+                fixItMessage = "Enable Foveation feature for <b>Subsampling (Vulkan)</b>.",
+                fixIt = () =>
+                {
+                    var settings = OpenXRSettings.GetSettingsForBuildTargetGroup(targetGroup);
+                    if (settings == null)
+                    {
+                        Debug.LogWarningFormat(
+                            "Autofix failed with missing OpenXRSettings on {0} platform.",
+                            targetGroup);
+                        return;
+                    }
+
+                    var foveation = GraphicsSettings.defaultRenderPipeline == null ?
+                      settings.GetFeature<XRFoveationFeature>() as OpenXRFeature :
+                      settings.GetFeature<FoveatedRenderingFeature>();
+                    if (foveation == null)
+                    {
+                        Debug.LogWarningFormat(
+                            "Autofix failed with missing Foveation feature on {0} platform.",
+                            targetGroup);
+                        return;
+                    }
+
+                    foveation.enabled = true;
+                },
+                error = true
+            });
+        }
+#endif // UNITY_EDITOR
     }
 }

Runtime/Google.XR.Extensions.asmdef

@@ -12,7 +12,13 @@
         "GUID:e7613e527d035461da6942ba7283ee2d",
         "Unity.XR.CompositionLayers"
     ],
-    "includePlatforms": [],
+    "includePlatforms": [
+        "Android",
+        "Editor",
+        "macOSStandalone",
+        "WindowsStandalone32",
+        "WindowsStandalone64"
+    ],
     "excludePlatforms": [],
     "allowUnsafeCode": true,
     "overrideReferences": false,

Runtime/Internal/XRSceneMeshingApi.cs

@@ -25,14 +25,9 @@ namespace Google.XR.Extensions.Internal
 
     internal class XRSceneMeshingApi
     {
-        public static bool Enable()
+        public static void SetEnabled(bool enabled)
         {
-            return ExternalApi.XrSceneMeshing_enableSceneMeshing(XRInstanceManagerApi.GetIntPtr());
-        }
-
-        public static bool Disable()
-        {
-            return ExternalApi.XrSceneMeshing_disableSceneMeshing(XRInstanceManagerApi.GetIntPtr());
+            ExternalApi.XrSceneMeshing_setEnabled(XRInstanceManagerApi.GetIntPtr(), enabled);
         }
 
         public static bool IsSceneMeshId(ref MeshId mesh_id)
@@ -47,19 +42,27 @@ public static IntPtr GetMeshSemantics(ref MeshId mesh_id, ref uint count)
                 XRInstanceManagerApi.GetIntPtr(), ref mesh_id, ref count);
         }
 
-        private struct ExternalApi
+        public static XRSceneMeshTrackingState GetSceneMeshTrackingState()
         {
-            [DllImport(ApiConstants.OpenXRAndroidApi)]
-            public static extern bool XrSceneMeshing_enableSceneMeshing(IntPtr manager);
+            XRSceneMeshTrackingState state = XRSceneMeshTrackingState.ERROR;
+            ExternalApi.XrSceneMeshing_getSceneMeshTrackingState(
+                XRInstanceManagerApi.GetIntPtr(), ref state);
+            return state;
+        }
 
+        private struct ExternalApi
+        {
             [DllImport(ApiConstants.OpenXRAndroidApi)]
-            public static extern bool XrSceneMeshing_disableSceneMeshing(IntPtr manager);
+            public static extern bool XrSceneMeshing_setEnabled(IntPtr manager, bool enabled);
             [DllImport(ApiConstants.OpenXRAndroidApi)]
             public static extern bool XrSceneMeshing_isSceneMeshId(
                 IntPtr manager, ref MeshId mesh_id);
             [DllImport(ApiConstants.OpenXRAndroidApi)]
             public static extern IntPtr XrSceneMeshing_getMeshSemantics(
                 IntPtr manager, ref MeshId mesh_id, ref uint count);
+            [DllImport(ApiConstants.OpenXRAndroidApi)]
+            public static extern void XrSceneMeshing_getSceneMeshTrackingState(
+                IntPtr manager, ref XRSceneMeshTrackingState out_state);
         }
     }
 }