Merge pull request #88 from kirurobo/dev_win

Added settings verification when using URP

Author: kirurobo

README-ja.md

@@ -51,7 +51,16 @@ B. UnityPackage を利用する手順
 5. ビルドしたものを起動
 
 
+### URP 利用時の設定
+背景を透明にするためには、アルファチャンネルを維持する必要があります。  
+そのためにいくつかの条件があります。  
+- HDR は無効にする [参考](https://github.com/kirurobo/UniWindowController/issues/42#issuecomment-2507577260)
+    - Main Camera (GameObject) > Camera (Component) > Output > HDR: Off
+- AlphaProcessing は有効にする [図](https://github.com/kirurobo/UniWindowController/issues/42#issuecomment-250757726)
+
+
 ## 制限事項
+- Direct3D12 では背景透過が有効となりません。Direct3D11 では `Use DXGI flip model swapchain for D3D11` を無効にすることで透過が可能です。
 - Unityエディタ上では透過はできません。ビルドをしてお試しください。
   - 常に最前面やウィンドウ移動等は動作しますが、実行中にゲームビューを閉じたりドッキングの配置を変えることはお勧めしません。一応、ゲームビューにフォーカスを移すとウィンドウを再取得はします。
 - マウスでは良いのですが、タッチ操作には適切な対応がまだ定まっていません。

README.md

@@ -50,7 +50,16 @@ B. Using an UnityPackage
 5. Launch the build
 
 
+### Settings when using URP 
+To make the background transparent, the alpha channel must be maintained.  
+There are some conditions for this.  
+- HDR must be disabled [Reference](https://github.com/kirurobo/UniWindowController/issues/42#issuecomment-2507577260)
+    - Main Camera (GameObject) > Camera (Component) > Output > HDR: Off
+- AlphaProcessing must be enabled [Figure](https://github.com/kirurobo/UniWindowController/issues/42#issuecomment-250757726)
+
+
 ## Limitations
+- Background transparency is not enabled in Direct3D12; in Direct3D11, transparency can be enabled by disabling `Use DXGI flip model swapchain for D3D11`.
 - Transparency is not available on the Unity Editor. Please build and try it.
   - It works for topmost, moving windows, etc., but I do not recommend closing the game view or changing the docking arrangement while it is running. In the meantime, the window will reacquire when the focus is shifted to the game view.
 - The proper support for touch operations has not yet been determined.

UniWinC/Assets/Kirurobo/UniWindowController/Editor/Scripts/UniWindowControllerEditor.cs

@@ -1,7 +1,7 @@
 /*
  * UniWindowControllerEditor.cs
- * 
- * Author: Kirurobo http://twitter.com/kirurobo
+ *
+ * Author: Kirurobo http://x.com/kirurobo
  * License: MIT
  */
 
@@ -13,6 +13,7 @@
 using UnityEngine;
 using UnityEditor;
 using System.Reflection;
+using UnityEngine.Rendering;
 
 namespace Kirurobo
 {
@@ -22,24 +23,60 @@ namespace Kirurobo
     [CustomEditor(typeof(UniWindowController))]
     public class UniWindowControllerEditor : Editor
     {
+        /// <summary>
+        /// カーソル下の色を表示するためのプロパティ
+        /// </summary>
         SerializedProperty pickedColor;
 
+        /// <summary>
+        /// ゲームビューのウィンドウ
+        /// </summary>
         private EditorWindow gameViewWindow;
 
+        /// <summary>
+        /// プロジェクト設定に関する警告を閉じておくか
         private bool isWarningDismissed = false;
 
+        /// <summary>
+        /// URP に関する警告を閉じておくか
+        /// </summary>
+        private bool isUrpWarningDismissed = true;
+
+        /// <summary>
+        /// URP が有効かどうか
+        /// </summary>
+        private bool hasUrp = false;
+
         void OnEnable()
         {
             LoadSettings();
 
             pickedColor = serializedObject.FindProperty("pickedColor");
+
+            // URP が有効か否かを判定
+            hasUrp = GetUrpSettings();
         }
 
         void OnDisable()
         {
             SaveSettings();
         }
 
+        /// <summary>
+        /// URPが有効か否かを検出
+        /// </summary>
+        /// <returns></returns>
+        private bool GetUrpSettings()
+        {
+            var renderPipelineAsset = GraphicsSettings.defaultRenderPipeline;
+            if (renderPipelineAsset == null || renderPipelineAsset.GetType().Name != "UniversalRenderPipelineAsset")
+            {
+                // URP が設定されていない
+                return false;
+            }
+            return true;
+        }
+
         private void LoadSettings()
         {
             isWarningDismissed = EditorUserSettings.GetConfigValue("WindowController_IS_WARNING DISMISSED") == "1";
@@ -50,6 +87,12 @@ private void SaveSettings()
             EditorUserSettings.SetConfigValue("WindowController_IS_WARNING DISMISSED", isWarningDismissed ? "1" : "0");
         }
 
+        /// <summary>
+        /// インスペクタでの表示をカスタマイズ
+        /// </summary>
+        /// <description>
+        /// 参考情報および、推奨設定の変更欄を表示します。
+        /// </description>
         public override void OnInspectorGUI()
         {
             base.OnInspectorGUI();
@@ -62,15 +105,26 @@ public override void OnInspectorGUI()
                 EditorGUI.EndDisabledGroup();
             }
 
+            // Project Settings の推奨設定を表示
+            isWarningDismissed = ShowPlayerSettingsValidation(isWarningDismissed);
+
+            // URP 関連の推奨設定を表示
+            isUrpWarningDismissed = ShowUrpSettingsValidation(isUrpWarningDismissed);
+        }
+
+        /// <summary>
+        /// Project Settings に関する推奨設定の自動設定欄を表示
+        /// </summary>
+        private bool ShowPlayerSettingsValidation(bool dismissed) {
             // 以下は Project Settings 関連
             EditorGUILayout.Space();
 
-            bool enableValidation = EditorGUILayout.Foldout(!isWarningDismissed, "Player Settings validation");
+            bool enableValidation = EditorGUILayout.Foldout(!dismissed, "Player Settings validation");
 
             // チェックするかどうかを記憶
-            if (enableValidation == isWarningDismissed)
+            if (enableValidation == dismissed)
             {
-                isWarningDismissed = !enableValidation;
+                dismissed = !enableValidation;
             }
 
             // 推奨設定のチェック
@@ -92,11 +146,11 @@ public override void OnInspectorGUI()
                     // Dismiss the validation
                     GUI.backgroundColor = Color.yellow;
                     if (GUILayout.Button(
-                        "✘ Mute this validation",
+                        "✘ Dismiss this validation",
                         GUILayout.MinHeight(25f)
                         ))
                     {
-                        isWarningDismissed = true;
+                        dismissed = true;
 
                         //SaveSettings();        // Uncomment this if save you want to save immediately
                     }
@@ -126,8 +180,63 @@ public override void OnInspectorGUI()
 
                 EditorGUILayout.Space();
             }
+            return dismissed;
         }
 
+        /// <summary>
+        /// URP に関する推奨設定の自動設定欄を表示
+        /// </summary>
+        private bool ShowUrpSettingsValidation(bool dismissed) {
+            // URP が無効ならば何もしない
+            if (!hasUrp) return dismissed;
+
+            // 以下は URP 関連の自動設定
+            EditorGUILayout.Space();
+
+            bool enableValidation = EditorGUILayout.Foldout(!dismissed, "URP Settings validation");
+            // チェックするかどうかを記憶
+            if (enableValidation == dismissed)
+            {
+                dismissed = !enableValidation;
+            }
+            // 推奨設定のチェック
+            //if (!isWarningDismissed)
+            if (enableValidation)
+            {
+                if (ValidateUrpSettings(false))
+                {
+                    // Apply all recommendation
+                    GUI.backgroundColor = Color.green;
+                    if (GUILayout.Button(
+                        "✔ Fix all settings to recommended values",
+                        GUILayout.MinHeight(25f)
+                        ))
+                    {
+                        ValidateUrpSettings(true);
+                    }
+
+                    // Dismiss the validation
+                    GUI.backgroundColor = Color.yellow;
+                    if (GUILayout.Button(
+                        "✘ Dismiss this validation",
+                        GUILayout.MinHeight(25f)
+                        ))
+                    {
+                        dismissed = true;
+                    }
+                    
+                    EditorGUILayout.Space();
+                }
+                else
+                {
+                    GUI.color = Color.green;
+                    GUILayout.Label("OK!");
+                }
+                
+                EditorGUILayout.Space();
+            }
+            return dismissed;
+        }
 
         private delegate void FixMethod();
 
@@ -161,6 +270,31 @@ private void FixSetting(string message, FixMethod fixAction, bool silentFix = fa
                 EditorGUILayout.EndHorizontal();
             }
         }
+
+        /// <summary>
+        /// Show the recommendation only
+        /// </summary>
+        /// <param name="message">Warning message</param>
+        private void ShowInfo(string message, Object target = null)
+
+        {
+            // Show the message and a fix button
+            EditorGUILayout.BeginHorizontal();
+            EditorGUILayout.HelpBox(message, MessageType.Info, true);
+            GUILayout.FlexibleSpace();
+
+            // 自動設定できない対象は、プロジェクトウィンドウで示すのみ
+            if (target != null)
+            {
+                EditorGUILayout.BeginVertical();
+                EditorGUILayout.Space();
+                if (GUILayout.Button("Ping", GUILayout.Width(60f))) { EditorGUIUtility.PingObject(target); }
+                //GUILayout.FlexibleSpace();
+                EditorGUILayout.EndVertical();
+            }
+            
+            EditorGUILayout.EndHorizontal();
+        }
 
         /// <summary>
         /// Validate player settings
@@ -250,12 +384,87 @@ private bool ValidateSettings(bool silentFix = false)
                     silentFix
                 );
             }
+
+            // Direct3D12 は透過ウィンドウに対応していないので、Graphics APIs for Windows から除外することを推奨
+            if (PlayerSettings.GetUseDefaultGraphicsAPIs(BuildTarget.StandaloneWindows))
+            {
+                // 自動の場合も警告を出す
+                ShowInfo(
+                    "Direct3D12 is not supported for transparent window. " +
+                    "Please consider using Direct3D11 instead of the 'Auto Graphics API for Windows' setting in Player Settings.",
+                    null
+                );
+            }
+            else if (PlayerSettings.GetGraphicsAPIs(BuildTarget.StandaloneWindows).Contains(GraphicsDeviceType.Direct3D12))
+            {
+                // Graphhics APIs for Windows に Direct3D12 が含まれている場合は警告を出す
+                ShowInfo(
+                    "Direct3D12 is not supported for transparent window. " +
+                    "Please remove Direct3D12 from 'Graphics APIs for Windows' in Player Settings.",
+                    null
+                );
+            }
 #endif
 
             return invalid;
         }
+        
+        /// <summary>
+        /// Validate player settings
+        /// </summary>
+        /// <param name="silentFix">false: show warning and fix button, true: fix without showing</param>
+        /// <returns>true if there are any invalid items</returns>
+        private bool ValidateUrpSettings(bool silentFix = false)
+        {
+            bool invalid = false;
+
+            // Universal Render Pipelineが有効ならば、HDRの無効化を推奨
+            foreach (var cam in Camera.allCameras)
+            {
+                if (cam.allowHDR) {
+                    string name = cam.name;
+                    invalid = true;
+                    FixSetting(
+                        $"{name}: Disable 'HDR' in the camera to make the window transparent.",
+                        () => cam.allowHDR = false,
+                        silentFix
+                    );
+                }
+                if (cam.allowMSAA) {
+                    string name = cam.name;
+                    invalid = true;
+                    FixSetting(
+                        $"{name}: Disable 'MSAA' in the camera to make the window transparent.",
+                        () => cam.allowMSAA = false,
+                        silentFix
+                    );
+                }
+            }
+
+            var urpAsset = GraphicsSettings.defaultRenderPipeline;
+            if (hasUrp && urpAsset != null)
+            {
+                // hasUrp == true の時点で urpAsset は UniversalRenderPipelineAsset であるはず。そのため allowPostProcessAlphaOutput があるはず
+                var alphaProcessingProperty = urpAsset.GetType().GetProperty("allowPostProcessAlphaOutput", BindingFlags.Public | BindingFlags.Instance);
+                if (alphaProcessingProperty != null)
+                {
+                    var alphaProcessing = alphaProcessingProperty.GetValue(urpAsset);
+                    if (!(bool)alphaProcessing)
+                    {
+                        invalid = true;
+                        ShowInfo(
+                            "Turn on 'Alpha Processing' in the URP asset",
+                            urpAsset
+                        );
+                    }
+                }
+            }
+
+            return invalid;
+        }
     }
 
+
     [CustomPropertyDrawer(typeof(ReadOnlyAttribute))]
     public class UniWindowControllerReadOnlyDrawer : PropertyDrawer
     {

UniWinC/Assets/Kirurobo/UniWindowController/README-ja.md

@@ -21,7 +21,7 @@ https://twitter.com/i/status/1314440790945361920
 
 
 ## デモ
-[Release のページ](https://github.com/kirurobo/UniWindowController/releases)  にビルドしたサンプルを置いてあります。
+[UniWinC_VRM](https://github.com/kirurobo/UniWinC_VRM) にはビルドしたVRMファイルビューアーのサンプルを置いてあります。
 
 
 ## インストール

UniWinC/Assets/Kirurobo/UniWindowController/README.md

@@ -20,7 +20,7 @@ https://twitter.com/i/status/1314440790945361920
 
 
 ## Demo
-You can find some sample builts on the [Release page](https://github.com/kirurobo/UniWindowController/releases).
+You can find a sample VRM viewer via [UniWinC_VRM](https://github.com/kirurobo/UniWinC_VRM).
 
 
 ## Installation

UniWinC/Assets/Kirurobo/UniWindowController/Samples/00_Menu/SampleMenu.unity

@@ -38,7 +38,7 @@ RenderSettings:
   m_ReflectionIntensity: 1
   m_CustomReflection: {fileID: 0}
   m_Sun: {fileID: 0}
-  m_IndirectSpecularColor: {r: 0.44657844, g: 0.49641222, b: 0.57481676, a: 1}
+  m_IndirectSpecularColor: {r: 0.44657815, g: 0.49641186, b: 0.57481647, a: 1}
   m_UseRadianceAmbientProbe: 0
 --- !u!157 &3
 LightmapSettings:
@@ -854,7 +854,7 @@ Canvas:
   m_RenderMode: 0
   m_Camera: {fileID: 0}
   m_PlaneDistance: 100
-  m_PixelPerfect: 0
+  m_PixelPerfect: 1
   m_ReceivesEvents: 1
   m_OverrideSorting: 0
   m_OverridePixelPerfect: 0
@@ -1670,7 +1670,7 @@ Transform:
   m_GameObject: {fileID: 4973827625486595094}
   serializedVersion: 2
   m_LocalRotation: {x: 0, y: 0, z: 0, w: 1}
-  m_LocalPosition: {x: 409, y: 261.5, z: 0}
+  m_LocalPosition: {x: 0, y: 0, z: 0}
   m_LocalScale: {x: 1, y: 1, z: 1}
   m_ConstrainProportionsScale: 0
   m_Children: