Merge pull request #8 from Uralstech/unstable

UXR.QuestCamera v3.1.0

Author: Uralstech

Documentation/DocSource/QuickStart.md

@@ -1,7 +1,6 @@
 # Migrating to UXR.QuestCamera V3
 
-UXR.QuestCamera v3 introduces a soft rewrite of the package with several breaking changes. It's highly recommended to update to v3, as it includes fixes for many crashes and stutters.  
-This page documents all changes to the **public API** in v3.0.0 compared to v2.6.1.
+UXR.QuestCamera v3 introduces a soft rewrite of the package with several breaking changes. It's highly recommended to update to v3, as it includes fixes for many crashes and stutters. This page documents all changes to the **public API** in v3.0.0 and v3.1.0 compared to v2.6.1.
 
 ## Basic Sample
 
@@ -84,6 +83,9 @@ _rawImage.texture = sessionObject.TextureConverter.FrameRenderTexture;
     - `CreateSurfaceTextureCaptureSession()` and `CreateOnDemandSurfaceTextureCaptureSession()` now have nullable return types and throw `ObjectDisposedException` if the `CameraDevice` was disposed at the time of calling.
     - `CameraId` is no longer a property and is now a cached value.
 
+- **v3.1.0 Specific Changes**
+    - `WaitForInitializationAsync()` now returns `Task<bool>` representing the open state of the device.
+
 ---
 
 ## CaptureSessionObject<T>
@@ -111,6 +113,9 @@ _rawImage.texture = sessionObject.TextureConverter.FrameRenderTexture;
     - `WaitForInitialization()` now returns a `WaitUntil` object and throws `ObjectDisposedException` if the `ContinuousCaptureSession` was disposed at the time of calling.
     - `WaitForInitializationAsync()` now accepts an optional `CancellationToken` and throws `ObjectDisposedException` if the `ContinuousCaptureSession` was disposed at the time of calling.
 
+- **v3.1.0 Specific Changes**
+    - `WaitForInitializationAsync()` now returns `Task<bool>` representing the open state of the session.
+
 ---
 
 ## OnDemandCaptureSession
@@ -154,6 +159,9 @@ _rawImage.texture = sessionObject.TextureConverter.FrameRenderTexture;
     - `WaitForInitialization()` now returns a `WaitUntil` object and throws `ObjectDisposedException` if the `SurfaceTextureCaptureSession` was disposed at the time of calling.
     - `WaitForInitializationAsync()` now accepts an optional `CancellationToken` and throws `ObjectDisposedException` if the `SurfaceTextureCaptureSession` was disposed at the time of calling.
 
+- **v3.1.0 Specific Changes**
+    - `WaitForInitializationAsync()` now returns `Task<bool>` representing the open state of the session.
+
 ---
 
 ## OnDemandSurfaceTextureCaptureSession
@@ -165,6 +173,9 @@ _rawImage.texture = sessionObject.TextureConverter.FrameRenderTexture;
     - `RequestCapture()` now returns a `WaitUntil?` object (`null` when the capture fails) and throws `ObjectDisposedException` if the `OnDemandSurfaceTextureCaptureSession` was disposed at the time of calling.
     - `RequestCaptureAsync()` is now `Awaitable<(Texture2D?, long)> RequestCaptureAsync()` (`Texture2D` is `null` when the capture fails), accepts an optional `CancellationToken`, and throws `ObjectDisposedException` if the `OnDemandSurfaceTextureCaptureSession` was disposed at the time of calling.
 
+- **v3.1.0 Specific Changes**
+    - `RequestCaptureAsync()` now returns `Task<(Texture2D?, long)>`.
+
 ---
 
 ## CameraInfo
@@ -198,13 +209,13 @@ _rawImage.texture = sessionObject.TextureConverter.FrameRenderTexture;
 
 ---
 
-## UCameraManager
+## CaptureTemplate
 
-All methods and properties in [`UCameraManager`](~/api/Uralstech.UXR.QuestCamera.UCameraManager.yml) are now nullable-aware with no breaking changes.
+- **Removed**
+    - `ZeroShutterLag` — not compatible with capture sessions created by the plugin.
 
 ---
 
-## CaptureTemplate
+## UCameraManager
 
-- **Removed**
-    - `ZeroShutterLag` — not compatible with capture sessions created by the plugin.
+All methods and properties in [`UCameraManager`](~/api/Uralstech.UXR.QuestCamera.UCameraManager.yml) are now nullable-aware with no breaking changes.

Documentation/DocSource/V3Migration.md

@@ -143,21 +143,46 @@ public WaitUntil WaitForInitialization()
             return new(() => CurrentState != NativeWrapperState.Initializing);
         }
 
-#if UNITY_6000_0_OR_NEWER
         /// <summary>
         /// Waits until the CameraDevice opens or errs out.
         /// </summary>
-        /// <returns>The current state of the CameraDevice.</returns>
-        public async Awaitable<NativeWrapperState> WaitForInitializationAsync(CancellationToken token = default)
+        /// <param name="timeout">Maximum time to wait.</param>
+        /// <param name="onTimeout">The action to perform when the <paramref name="timeout"/> is reached.</param>
+        /// <param name="timeoutMode">Mode in which to measure time to determine <paramref name="timeout"/>.</param>
+        public WaitUntil WaitForInitialization(TimeSpan timeout, Action onTimeout, WaitTimeoutMode timeoutMode = WaitTimeoutMode.Realtime)
         {
             ThrowIfDisposed();
-            await Awaitable.MainThreadAsync();
-            while (CurrentState == NativeWrapperState.Initializing && !token.IsCancellationRequested)
-                await Awaitable.NextFrameAsync(token);
+            return new(() => CurrentState != NativeWrapperState.Initializing, timeout, onTimeout, timeoutMode);
+        }
+
+        /// <summary>
+        /// Waits until the CameraDevice opens or errs out.
+        /// </summary>
+        /// <returns><see langword="true"/> if the device was opened successfully, <see langword="false"/> otherwise.</returns>
+        public async Task<bool> WaitForInitializationAsync(CancellationToken token = default)
+        {
+            ThrowIfDisposed();
+            if (CurrentState != NativeWrapperState.Initializing)
+                return CurrentState == NativeWrapperState.Opened;
 
-            return CurrentState;
+            TaskCompletionSource<bool> wrapperState = new();
+            void OnOpened(string _) => wrapperState.SetResult(true);
+            void OnClosed(string? _) => wrapperState.SetResult(false);
+
+            OnDeviceOpened += OnOpened;
+            OnDeviceClosed += OnClosed;
+
+            try
+            {
+                using CancellationTokenRegistration _ = token.Register(wrapperState.SetCanceled);
+                return await wrapperState.Task;
+            }
+            finally
+            {
+                OnDeviceOpened -= OnOpened;
+                OnDeviceClosed -= OnClosed;
+            }
         }
-#endif
 
         private bool _disposed = false;
 
@@ -174,13 +199,13 @@ public async ValueTask DisposeAsync()
             if (_cameraDevice != null)
             {
                 TaskCompletionSource<bool> tcs = new();
-                void OnDisposed(string? _) => tcs.SetResult(true);
+                void OnDisposed(string? _) => tcs.TrySetResult(true);
 
                 OnDeviceClosed += OnDisposed;
-                bool isClosing = _cameraDevice.Call<bool>("close");
+                if (!_cameraDevice.Call<bool>("close"))
+                    tcs.TrySetResult(true);
 
-                if (isClosing)
-                    await tcs.Task;
+                await tcs.Task;
 
                 OnDeviceClosed -= OnDisposed;
                 _cameraDevice.Dispose();