[OpenXR] Makes device construction internal and improves exception me…

…ssages of new StartPassthrough method
stride3d · Feb 7, 2024 · ff27bf7 · ff27bf7
1 parent 5513952
commit ff27bf7
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 3 deletions.
diff --git a/sources/engine/Stride.VirtualReality/OpenXR/OpenXRHmd.cs b/sources/engine/Stride.VirtualReality/OpenXR/OpenXRHmd.cs
@@ -20,7 +20,11 @@ public class OpenXRHmd : VRDevice
         // Public static variable to add extensions to the initialization of the openXR session
         public static List<string> extensions = new List<string>();
 
-        public static OpenXRHmd? New(bool requestPassthrough)
+        /// <summary>
+        /// Creates a VR device using OpenXR.
+        /// </summary>
+        /// <param name="requestPassthrough">Whether or not the XR_FB_passthrough extension should be enabled (if available).</param>
+        internal static OpenXRHmd? New(bool requestPassthrough)
         {
             // Create our API object for OpenXR.
             var xr = XR.GetApi();
@@ -62,6 +66,7 @@ public class OpenXRHmd : VRDevice
 
         // Passthrough
         private OpenXRExt_FB_Passthrough? passthroughExt;
+        private bool passthroughRequested;
 
         private GraphicsDevice? baseDevice;
 
@@ -133,6 +138,7 @@ private OpenXRHmd(XR xr, bool requestPassthrough)
         {
             Xr = xr;
             VRApi = VRApi.OpenXR;
+            passthroughRequested = requestPassthrough;
 
             var requestedExtensions = new List<string>(extensions);
             if (requestPassthrough)
@@ -361,8 +367,11 @@ public override unsafe void Enable(GraphicsDevice device, GraphicsDeviceManager
 
         public override IDisposable StartPassthrough()
         {
+            if (!passthroughRequested)
+                throw new InvalidOperationException("The passthrough mode needs to be enabled at device creation");
+
             if (!SupportsPassthrough)
-                throw new NotSupportedException();
+                throw new NotSupportedException("The device does not support Passthrough mode");
 
             if (passthroughExt is null)
                 passthroughExt = new OpenXRExt_FB_Passthrough(Xr, globalSession, Instance);

diff --git a/sources/engine/Stride.VirtualReality/VRDevice.cs b/sources/engine/Stride.VirtualReality/VRDevice.cs
@@ -74,7 +74,8 @@ public virtual void ReleaseOverlay(VROverlay overlay)
         /// Starts a passthrough. When enabled the scene is rendered on top of the camera image of the device.
         /// </summary>
         /// <returns>A disposable which will stop the passthrough on dispose.</returns>
-        /// <exception cref="NotSupportedException">Thrown if passthrough is not supported by the device.</exception>
+        /// <exception cref="NotSupportedException">Thrown if the passthrough mode is not supported by the device.</exception>
+        /// <exception cref="InvalidOperationException">Thrown if the passthrough mode is already enabled.</exception>
         public virtual IDisposable StartPassthrough()
         {
             throw new NotSupportedException();