Merge pull request #49 from nowsprinting/fix/arg_error_to_warn

Mod LogType `Warning` instead of `Error` when invalid argument
nowsprinting · Nov 19, 2023 · 103e027 · 103e027
2 parents 4527c2a + d2ef992
commit 103e027
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 5 deletions.
diff --git a/RuntimeInternals/ScreenshotHelper.cs b/RuntimeInternals/ScreenshotHelper.cs
@@ -66,13 +66,13 @@ private static string DefaultFilename(string callerMemberName)
         {
             if (superSize != 1 && stereoCaptureMode != ScreenCapture.StereoScreenCaptureMode.LeftEye)
             {
-                Debug.LogError("superSize and stereoCaptureMode cannot be specified at the same time.");
+                Debug.LogWarning("superSize and stereoCaptureMode cannot be specified at the same time.");
                 yield break;
             }
 
             if (Thread.CurrentThread.ManagedThreadId != 1)
             {
-                Debug.LogError("Must be called from the main thread.");
+                Debug.LogWarning("Must be called from the main thread.");
                 yield break;
                 // Note: This is not the case since it is a coroutine.
             }

diff --git a/Tests/Runtime/Attributes/TakeScreenshotAttributeTest.cs b/Tests/Runtime/Attributes/TakeScreenshotAttributeTest.cs
@@ -229,13 +229,16 @@ public void AttachWithSuperSize_SaveSuperSizeScreenshot()
         }
 
         [Test, Order(1)]
+        [Description("This test fails with stereo rendering settings.")]
         public void AttachWithSuperSize_SaveSuperSizeScreenshot_ExistFile()
         {
             var path = Path.Combine(
                 _defaultOutputDirectory,
                 $"{nameof(AttachWithSuperSize_SaveSuperSizeScreenshot)}.png");
             Assert.That(path, Does.Exist);
             Assert.That(File.ReadAllBytes(path), Has.Length.GreaterThan(FileSizeThreshold2X));
+            // Note: This test fails with stereo rendering settings.
+            //  See: https://docs.unity3d.com/Manual/SinglePassStereoRendering.html
         }
 
         [Test, Order(0)]
@@ -265,7 +268,7 @@ public void AttachWithStereoCaptureMode_SaveStereoScreenshot_ExistFile()
             Assert.That(path, Does.Exist);
             // Is it a stereo screenshot? See for yourself! Be a witness!!
             // Note: Require stereo rendering settings.
-            // See: https://docs.unity3d.com/Manual/SinglePassStereoRendering.html
+            //  See: https://docs.unity3d.com/Manual/SinglePassStereoRendering.html
         }
 
         private class GizmoDemo : MonoBehaviour

diff --git a/Tests/RuntimeInternals/ScreenshotHelperTest.cs b/Tests/RuntimeInternals/ScreenshotHelperTest.cs
@@ -93,7 +93,7 @@ public IEnumerator TakeScreenshot_SpecifySuperSizeAndStereoCaptureMode_NotWork()
             yield return ScreenshotHelper.TakeScreenshot(
                 superSize: 2,
                 stereoCaptureMode: ScreenCapture.StereoScreenCaptureMode.BothEyes);
-            LogAssert.Expect(LogType.Error, "superSize and stereoCaptureMode cannot be specified at the same time.");
+            LogAssert.Expect(LogType.Warning, "superSize and stereoCaptureMode cannot be specified at the same time.");
         }
 
         [Test]
@@ -110,7 +110,7 @@ public async Task TakeScreenshot_FromAsyncTest()
             var coroutineRunner = new GameObject().AddComponent<CoroutineRunner>();
             await ScreenshotHelper.TakeScreenshot().ToUniTask(coroutineRunner);
             // Note: UniTask is required to be used from the async test.
-            //   And also needs coroutineRunner (any MonoBehaviour) because TakeScreenshot method uses WaitForEndOfFrame inside.
+            //   And also needs CoroutineRunner (any MonoBehaviour) because TakeScreenshot method uses WaitForEndOfFrame inside.
             //   See more information: https://github.com/Cysharp/UniTask#ienumeratortounitask-limitation
 
             Assert.That(path, Does.Exist);