feat: (editor) use stencil outside screen in scene view for development

mob-sakai · Feb 16, 2024 · ab946e3 · ab946e3
1 parent c2f1eee
commit ab946e3
Show file tree

Hide file tree

Showing 11 changed files with 80 additions and 7 deletions.
diff --git a/Packages/src/Runtime/Coffee.SoftMaskForUGUI.asmdef b/Packages/src/Runtime/Coffee.SoftMaskForUGUI.asmdef
@@ -1,13 +1,20 @@
 {
     "name": "Coffee.SoftMaskForUGUI",
-    "references": [],
+    "references": [
+        "Unity.TextMeshPro"
+    ],
     "includePlatforms": [],
     "excludePlatforms": [],
     "versionDefines": [
         {
             "name": "com.unity.modules.vr",
             "expression": "1.0.0",
             "define": "UNITY_MODULE_VR"
+        },
+        {
+            "name": "com.unity.textmeshpro",
+            "expression": "1.0.0",
+            "define": "TMP_ENABLE"
         }
     ]
 }
diff --git a/Packages/src/Runtime/MaskingShape/MaskingShape.cs b/Packages/src/Runtime/MaskingShape/MaskingShape.cs
@@ -6,6 +6,9 @@
 using UnityEngine.Profiling;
 using UnityEngine.Rendering;
 using UnityEngine.UI;
+#if TMP_ENABLE
+using TMPro;
+#endif
 
 namespace Coffee.UISoftMask
 {
@@ -375,6 +378,18 @@ internal void DrawSoftMaskBuffer(CommandBuffer cb, int depth)
         {
             var texture = graphic.mainTexture;
             var mesh = _mesh;
+#if TMP_ENABLE
+            if (graphic is TextMeshProUGUI textMeshPro)
+            {
+                mesh = textMeshPro.mesh;
+                texture = textMeshPro.fontMaterial.mainTexture;
+            }
+            else if (graphic is TMP_SubMeshUI subMeshUI)
+            {
+                mesh = subMeshUI.mesh;
+                texture = subMeshUI.material.mainTexture;
+            }
+#endif
             if (!mesh) return;
             if (!graphic.IsInScreen()) return;
 

diff --git a/Packages/src/Runtime/ProjectSettings/UISoftMaskProjectSettings.cs b/Packages/src/Runtime/ProjectSettings/UISoftMaskProjectSettings.cs
@@ -12,6 +12,12 @@ namespace Coffee.UISoftMask
 {
     public class UISoftMaskProjectSettings : PreloadedProjectSettings<UISoftMaskProjectSettings>
     {
+        public enum SceneViewBehavior
+        {
+            UseStencilOutsideScreen,
+            SameAsGameView
+        }
+
         public enum FallbackBehavior
         {
             DefaultSoftMaskable,
@@ -44,6 +50,9 @@ public enum TransformSensitivity
         [SerializeField]
         private bool m_EnabledInEditMode = true;
 
+        [SerializeField]
+        private SceneViewBehavior m_SceneViewBehavior = SceneViewBehavior.UseStencilOutsideScreen;
+
         [Header("Shader")]
         [SerializeField]
         private bool m_AutoIncludeShaders = true;
@@ -63,7 +72,12 @@ public static bool softMaskEnabled
         }
 
         public static bool useStencil =>
+#if UNITY_EDITOR
+            instance.m_SceneViewBehavior == SceneViewBehavior.UseStencilOutsideScreen;
+#else
             false;
+#endif
+
 #if UNITY_MODULE_VR
         public static bool stereoEnabled => softMaskEnabled && instance.m_StereoEnabled && XRSettings.enabled;
 #else

diff --git a/Packages/src/Runtime/SoftMask.cs b/Packages/src/Runtime/SoftMask.cs
@@ -7,6 +7,9 @@
 using UnityEngine.Profiling;
 using UnityEngine.Rendering;
 using UnityEngine.UI;
+#if TMP_ENABLE
+using TMPro;
+#endif
 
 namespace Coffee.UISoftMask
 {
@@ -738,6 +741,18 @@ private void RenderSoftMaskBuffer(CommandBuffer cb, Camera.MonoOrStereoscopicEye
                 Profiler.BeginSample("(SM4UI)[SoftMask] RenderSoftMaskBuffer > ApplyMaterialPropertyBlock");
                 var mat = graphic.canvasRenderer.GetMaterial(0);
                 var texture = graphic.mainTexture;
+#if TMP_ENABLE
+                {
+                    if (graphic is TextMeshProUGUI textMeshPro)
+                    {
+                        texture = textMeshPro.fontMaterial.mainTexture;
+                    }
+                    else if (graphic is TMP_SubMeshUI subMeshUI)
+                    {
+                        texture = subMeshUI.material.mainTexture;
+                    }
+                }
+#endif
                 SoftMaskUtils.ApplyMaterialPropertyBlock(_mpb, softMaskDepth, texture, softMaskingRange);
                 Profiler.EndSample();
             }
@@ -763,6 +778,19 @@ private void RenderSoftMaskBuffer(CommandBuffer cb, Camera.MonoOrStereoscopicEye
             }
 
             var mesh = _mesh;
+#if TMP_ENABLE
+            {
+                if (graphic is TextMeshProUGUI textMeshPro)
+                {
+                    mesh = textMeshPro.mesh;
+                    _mpb.SetFloat(ShaderPropertyIds.alphaAdd, -0.25f);
+                }
+                else if (graphic is TMP_SubMeshUI subMeshUI)
+                {
+                    mesh = subMeshUI.mesh;
+                }
+            }
+#endif
 
             if (mesh)
             {

diff --git a/Packages/src/Runtime/SoftMaskable.cs b/Packages/src/Runtime/SoftMaskable.cs
@@ -3,6 +3,9 @@
 using UnityEngine;
 using UnityEngine.Profiling;
 using UnityEngine.UI;
+#if TMP_ENABLE
+using TMPro;
+#endif
 
 namespace Coffee.UISoftMask
 {
@@ -158,6 +161,12 @@ Material IMaterialModifier.GetModifiedMaterial(Material baseMaterial)
                         ? 0
                         : (shape.softnessRange.max + shape.softnessRange.min) / 2;
                 }
+#if TMP_ENABLE
+                if (_graphic is TextMeshProUGUI)
+                {
+                    threshold -= 0.25f;
+                }
+#endif
 
                 _maskableMaterial.SetFloat(ShaderPropertyIds.alphaClipThreshold, threshold);
             }

diff --git a/.../src/Samples~/TextMeshPro Support v3.2 or v4.0~/Hidden-TMP_SDF-Mobile-SoftMaskable.shader b/.../src/Samples~/TextMeshPro Support v3.2 or v4.0~/Hidden-TMP_SDF-Mobile-SoftMaskable.shader
@@ -244,7 +244,7 @@ SubShader {
 			c *= SoftMask(input.vertex, mul(unity_ObjectToWorld, input.worldPosition));
 
 			#if UNITY_UI_ALPHACLIP
-			clip(c.a - 0.001);
+			SoftMaskClip(c.a - 0.001);
 			#endif
 
 			return c;

diff --git a/Packages/src/Samples~/TextMeshPro Support v3.2 or v4.0~/Hidden-TMP_SDF-SoftMaskable.shader b/Packages/src/Samples~/TextMeshPro Support v3.2 or v4.0~/Hidden-TMP_SDF-SoftMaskable.shader
@@ -320,7 +320,7 @@ SubShader {
             faceColor *= SoftMask(input.position, mul(unity_ObjectToWorld, input.worldPosition));
 
 		    #if UNITY_UI_ALPHACLIP
-			clip(faceColor.a - 0.001);
+			SoftMaskClip(faceColor.a - 0.001);
 		    #endif
 
   		    return faceColor * input.color.a;

diff --git a/...ages/src/Samples~/TextMeshPro Support v3.2 or v4.0~/Hidden-TMP_Sprite-SoftMaskable.shader b/...ages/src/Samples~/TextMeshPro Support v3.2 or v4.0~/Hidden-TMP_Sprite-SoftMaskable.shader
@@ -126,7 +126,7 @@ Shader "Hidden/TextMeshPro/Sprite (SoftMaskable)"
                 color.a *= SoftMask(IN.vertex, mul(unity_ObjectToWorld, IN.worldPosition));
 
 				#ifdef UNITY_UI_ALPHACLIP
-					clip (color.a - 0.001);
+					SoftMaskClip (color.a - 0.001);
 				#endif
 
 				return color;

diff --git a/Packages/src/Samples~/TextMeshPro Support~/Hidden-TMP_SDF-Mobile-SoftMaskable.shader b/Packages/src/Samples~/TextMeshPro Support~/Hidden-TMP_SDF-Mobile-SoftMaskable.shader
@@ -237,7 +237,7 @@ SubShader {
 			c *= SoftMask(input.vertex, mul(unity_ObjectToWorld, input.worldPosition));
 
 			#if UNITY_UI_ALPHACLIP
-			clip(c.a - 0.001);
+			SoftMaskClip(c.a - 0.001);
 			#endif
 
 			return c;

diff --git a/Packages/src/Samples~/TextMeshPro Support~/Hidden-TMP_SDF-SoftMaskable.shader b/Packages/src/Samples~/TextMeshPro Support~/Hidden-TMP_SDF-SoftMaskable.shader
@@ -315,7 +315,7 @@ SubShader {
             faceColor *= SoftMask(input.position, mul(unity_ObjectToWorld, input.worldPosition));
 
 		    #if UNITY_UI_ALPHACLIP
-			clip(faceColor.a - 0.001);
+			SoftMaskClip(faceColor.a - 0.001);
 		    #endif
 
   		    return faceColor * input.color.a;

diff --git a/Packages/src/Samples~/TextMeshPro Support~/Hidden-TMP_Sprite-SoftMaskable.shader b/Packages/src/Samples~/TextMeshPro Support~/Hidden-TMP_Sprite-SoftMaskable.shader
@@ -121,7 +121,7 @@ Shader "Hidden/TextMeshPro/Sprite (SoftMaskable)"
                 color.a *= SoftMask(IN.vertex, mul(unity_ObjectToWorld, IN.worldPosition));
 
 				#ifdef UNITY_UI_ALPHACLIP
-					clip (color.a - 0.001);
+					SoftMaskClip (color.a - 0.001);
 				#endif
 
 				return color;