[UUM-116276][6000.4][2D] Fix Rendering Debug views for Rendergraph2D

kennytann · Evergreen · commit 67c40bcaa637 · 2025-09-08T14:51:36.000Z
diff --git a/Packages/com.unity.render-pipelines.universal/Editor/2D/ShaderGraph/Includes/SpriteLitPass.hlsl b/Packages/com.unity.render-pipelines.universal/Editor/2D/ShaderGraph/Includes/SpriteLitPass.hlsl
@@ -12,6 +12,9 @@ PackedVaryings vert(Attributes input)
     input.positionOS = UnityFlipSprite(input.positionOS, unity_SpriteProps.xy);
     output = BuildVaryings(input);
     output.color *= _RendererColor * unity_SpriteColor; // vertex color has to applied here
+#if defined(DEBUG_DISPLAY)
+    output.normalWS = TransformObjectToWorldNormal(input.normalOS);
+#endif
     PackedVaryings packedOutput = PackVaryings(output);
     return packedOutput;
 }
@@ -40,11 +43,12 @@ half4 frag(PackedVaryings packedInput) : SV_TARGET
 #endif
 
     SurfaceData2D surfaceData;
-    InitializeSurfaceData(color.rgb, color.a, surfaceDescription.SpriteMask, surfaceData);
+    InitializeSurfaceData(color.rgb, color.a, surfaceDescription.SpriteMask, surfaceDescription.NormalTS, surfaceData);
     InputData2D inputData;
     InitializeInputData(unpacked.texCoord0.xy, half2(unpacked.screenPosition.xy / unpacked.screenPosition.w), inputData);
 #if defined(DEBUG_DISPLAY)
     SETUP_DEBUG_DATA_2D(inputData, unpacked.positionWS, unpacked.positionCS);
+    surfaceData.normalWS = unpacked.normalWS;
 #endif
 
     return CombinedShapeLightShared(surfaceData, inputData);
diff --git a/Packages/com.unity.render-pipelines.universal/Editor/2D/ShaderGraph/Includes/SpriteUnlitPass.hlsl b/Packages/com.unity.render-pipelines.universal/Editor/2D/ShaderGraph/Includes/SpriteUnlitPass.hlsl
@@ -13,6 +13,9 @@ PackedVaryings vert(Attributes input)
     input.positionOS = UnityFlipSprite(input.positionOS, unity_SpriteProps.xy);
     output = BuildVaryings(input);
     output.color *= _RendererColor * unity_SpriteColor; // vertex color has to applied here
+#if defined(DEBUG_DISPLAY)
+    output.normalWS = TransformObjectToWorldNormal(input.normalOS);
+#endif
     PackedVaryings packedOutput = PackVaryings(output);
     return packedOutput;
 }
@@ -38,9 +41,13 @@ half4 frag(PackedVaryings packedInput) : SV_TARGET
     clip(color.a - surfaceDescription.AlphaClipThreshold);
 #endif
 
-    #if defined(DEBUG_DISPLAY)
+#if defined(DEBUG_DISPLAY)
     SurfaceData2D surfaceData;
     InitializeSurfaceData(color.rgb, color.a, surfaceData);
+    surfaceData.normalWS = unpacked.normalWS;
+#if (SHADERPASS == SHADERPASS_SPRITELIT)
+    surfaceData.normalTS = surfaceDescription.NormalTS;
+#endif 
     InputData2D inputData;
     InitializeInputData(unpacked.positionWS.xy, half2(unpacked.texCoord0.xy), inputData);
     half4 debugColor = 0;
@@ -51,7 +58,7 @@ half4 frag(PackedVaryings packedInput) : SV_TARGET
     {
         return debugColor;
     }
-    #endif
+#endif
 
     // Disable vertex color multiplication. Users can get the color from VertexColor node
 #if !defined(HAVE_VFX_MODIFICATION) && !defined(_DISABLE_COLOR_TINT)
diff --git a/Packages/com.unity.render-pipelines.universal/Editor/2D/ShaderGraph/Targets/UniversalSpriteCustomLitSubTarget.cs b/Packages/com.unity.render-pipelines.universal/Editor/2D/ShaderGraph/Targets/UniversalSpriteCustomLitSubTarget.cs
@@ -224,15 +224,16 @@ static class SpriteLitBlockMasks
             {
                 BlockFields.SurfaceDescription.BaseColor,
                 BlockFields.SurfaceDescriptionLegacy.SpriteColor,
-                BlockFields.SurfaceDescription.Alpha,
                 UniversalBlockFields.SurfaceDescription.SpriteMask,
+                BlockFields.SurfaceDescription.NormalTS,
+                BlockFields.SurfaceDescription.Alpha,
                 BlockFields.SurfaceDescription.AlphaClipThreshold,
             };
 
             public static BlockFieldDescriptor[] FragmentNormal = new BlockFieldDescriptor[]
             {
-                BlockFields.SurfaceDescription.Alpha,
                 BlockFields.SurfaceDescription.NormalTS,
+                BlockFields.SurfaceDescription.Alpha,
                 BlockFields.SurfaceDescription.AlphaClipThreshold,
             };
 
@@ -255,6 +256,7 @@ static class SpriteLitRequiredFields
                 StructFields.Varyings.positionWS,
                 StructFields.Varyings.texCoord0,
                 StructFields.Varyings.screenPosition,
+                StructFields.Varyings.normalWS,
             };
 
             public static FieldCollection Normal = new FieldCollection()
diff --git a/Packages/com.unity.render-pipelines.universal/Editor/2D/ShaderGraph/Targets/UniversalSpriteLitSubTarget.cs b/Packages/com.unity.render-pipelines.universal/Editor/2D/ShaderGraph/Targets/UniversalSpriteLitSubTarget.cs
@@ -245,17 +245,18 @@ static class SpriteLitBlockMasks
             {
                 BlockFields.SurfaceDescription.BaseColor,
                 BlockFields.SurfaceDescriptionLegacy.SpriteColor,
-                BlockFields.SurfaceDescription.Alpha,
                 UniversalBlockFields.SurfaceDescription.SpriteMask,
+                BlockFields.SurfaceDescription.NormalTS,
+                BlockFields.SurfaceDescription.Alpha,
                 BlockFields.SurfaceDescription.AlphaClipThreshold,
             };
 
             public static BlockFieldDescriptor[] FragmentForwardNormal = new BlockFieldDescriptor[]
             {
                 BlockFields.SurfaceDescription.BaseColor,
                 BlockFields.SurfaceDescriptionLegacy.SpriteColor,
-                BlockFields.SurfaceDescription.Alpha,
                 BlockFields.SurfaceDescription.NormalTS,
+                BlockFields.SurfaceDescription.Alpha,
                 BlockFields.SurfaceDescription.AlphaClipThreshold,
             };
         }
@@ -270,6 +271,7 @@ static class SpriteLitRequiredFields
                 StructFields.Varyings.positionWS,
                 StructFields.Varyings.texCoord0,
                 StructFields.Varyings.screenPosition,
+                StructFields.Varyings.normalWS,
             };
 
             public static FieldCollection Normal = new FieldCollection()
diff --git a/Packages/com.unity.render-pipelines.universal/Editor/2D/ShaderGraph/Targets/UniversalSpriteUnlitSubTarget.cs b/Packages/com.unity.render-pipelines.universal/Editor/2D/ShaderGraph/Targets/UniversalSpriteUnlitSubTarget.cs
@@ -214,6 +214,7 @@ static class SpriteUnlitRequiredFields
                 StructFields.Varyings.positionWS,
                 StructFields.Varyings.color,
                 StructFields.Varyings.texCoord0,
+                StructFields.Varyings.normalWS,
             };
         }
         #endregion
diff --git a/Packages/com.unity.render-pipelines.universal/Runtime/2D/Rendergraph/DrawLight2DPass.cs b/Packages/com.unity.render-pipelines.universal/Runtime/2D/Rendergraph/DrawLight2DPass.cs
@@ -227,9 +227,22 @@ public void Render(RenderGraph graph, ContextContainer frameData, Renderer2DData
         {
             Universal2DResourceData universal2DResourceData = frameData.Get<Universal2DResourceData>();
             CommonResourceData commonResourceData = frameData.Get<CommonResourceData>();
+            UniversalCameraData cameraData = frameData.Get<UniversalCameraData>();
+
+            DebugHandler debugHandler = ScriptableRenderPass.GetActiveDebugHandler(cameraData);
+            var isDebugLightingActive = debugHandler?.IsLightingActive ?? true;
+
+#if UNITY_EDITOR
+            if (cameraData.isSceneViewCamera && UnityEditor.SceneView.currentDrawingSceneView != null)
+                isDebugLightingActive &= UnityEditor.SceneView.currentDrawingSceneView.sceneLighting;
+
+            if (cameraData.camera.cameraType == CameraType.Preview)
+                isDebugLightingActive = false;
+#endif
 
             if (!layerBatch.lightStats.useLights ||
-                isVolumetric && !layerBatch.lightStats.useVolumetricLights)
+                isVolumetric && !layerBatch.lightStats.useVolumetricLights ||
+                !isDebugLightingActive)
                 return;
 
             // Render single RTs by using low level pass for apis that don't support MRTs
diff --git a/Packages/com.unity.render-pipelines.universal/Runtime/2D/Rendergraph/DrawRenderer2DPass.cs b/Packages/com.unity.render-pipelines.universal/Runtime/2D/Rendergraph/DrawRenderer2DPass.cs
@@ -56,8 +56,15 @@ private static void Execute(RasterGraphContext context, PassData passData)
                 }
             }
 
-            // Draw all renderers in layer batch
-            cmd.DrawRendererList(passData.rendererList);
+            if (passData.activeDebugHandler)
+            {
+                passData.debugRendererLists.DrawWithRendererList(cmd);
+            }
+            else
+            {
+                // Draw all renderers in layer batch
+                cmd.DrawRendererList(passData.rendererList);
+            }
 
             RendererLighting.DisableAllKeywords(cmd);
         }
@@ -76,6 +83,8 @@ class PassData
             internal bool layerUseLights;
             internal TextureHandle[] lightTextures;
             internal RendererListHandle rendererList;
+            internal DebugRendererLists debugRendererLists;
+            internal bool activeDebugHandler;
 
 #if UNITY_EDITOR
             internal bool isLitView; // Required for prefab view and preview camera
@@ -142,9 +151,22 @@ public void Render(RenderGraph graph, ContextContainer frameData, Renderer2DData
                 RendererLighting.GetTransparencySortingMode(rendererData, cameraData.camera, ref sortSettings);
                 drawSettings.sortingSettings = sortSettings;
 
-                var param = new RendererListParams(renderingData.cullResults, drawSettings, filterSettings);
-                passData.rendererList = graph.CreateRendererList(param);
-                builder.UseRendererList(passData.rendererList);
+                var activeDebugHandler = GetActiveDebugHandler(cameraData);
+                passData.activeDebugHandler = activeDebugHandler != null;
+
+                if (activeDebugHandler != null)
+                {
+                    var renderStateBlock = new RenderStateBlock(RenderStateMask.Nothing);
+                    passData.debugRendererLists = activeDebugHandler.CreateRendererListsWithDebugRenderState(graph,
+                        ref renderingData.cullResults, ref drawSettings, ref filterSettings, ref renderStateBlock);
+                    passData.debugRendererLists.PrepareRendererListForRasterPass(builder);
+                }
+                else
+                {
+                    var param = new RendererListParams(renderingData.cullResults, drawSettings, filterSettings);
+                    passData.rendererList = graph.CreateRendererList(param);
+                    builder.UseRendererList(passData.rendererList);
+                }
 
                 if (passData.layerUseLights)
                 {
diff --git a/Packages/com.unity.render-pipelines.universal/Runtime/2D/Rendergraph/Renderer2DRendergraph.cs b/Packages/com.unity.render-pipelines.universal/Runtime/2D/Rendergraph/Renderer2DRendergraph.cs
@@ -217,6 +217,7 @@ ImportResourceSummary GetImportResourceSummary(RenderGraph renderGraph, Universa
             {
                 clearColor = true;
                 clearDepth = true;
+                debugHandler.TryGetScreenClearColor(ref cameraBackgroundColor);
             }
 
             output.cameraColorParams.clearOnFirstUse = clearColor;
@@ -947,11 +948,14 @@ private void OnAfterRendering(RenderGraph renderGraph)
             // If HDR debug views are enabled, DebugHandler will perform the blit from debugScreenColor (== finalColorHandle) to backBufferColor.
             DebugHandler?.Render(renderGraph, cameraData, finalColorHandle, commonResourceData.overlayUITexture, commonResourceData.backBufferColor);
 
-            if (cameraData.isSceneViewCamera)
-                DrawRenderGraphWireOverlay(renderGraph, frameData, commonResourceData.backBufferColor);
+            if (cameraData.resolveFinalTarget)
+            {
+                if (cameraData.isSceneViewCamera)
+                    DrawRenderGraphWireOverlay(renderGraph, frameData, commonResourceData.backBufferColor);
 
-            if (drawGizmos)
-                DrawRenderGraphGizmos(renderGraph, frameData, commonResourceData.activeColorTexture, commonResourceData.activeDepthTexture, GizmoSubset.PostImageEffects);
+                if (drawGizmos)
+                    DrawRenderGraphGizmos(renderGraph, frameData, commonResourceData.activeColorTexture, commonResourceData.activeDepthTexture, GizmoSubset.PostImageEffects);
+            }
         }
 
         public Renderer2DData GetRenderer2DData()
diff --git a/Packages/com.unity.render-pipelines.universal/ShaderLibrary/Debug/Debugging2D.hlsl b/Packages/com.unity.render-pipelines.universal/ShaderLibrary/Debug/Debugging2D.hlsl
@@ -38,7 +38,7 @@ bool CalculateDebugColorMaterialSettings(in SurfaceData2D surfaceData, in InputD
 
         case DEBUGMATERIALMODE_ALBEDO:
         {
-            debugColor = half4(surfaceData.albedo, 1);
+            debugColor = half4(surfaceData.albedo, surfaceData.alpha);
             return true;
         }
 
@@ -54,10 +54,15 @@ bool CalculateDebugColorMaterialSettings(in SurfaceData2D surfaceData, in InputD
             return true;
         }
 
-        case DEBUGMATERIALMODE_NORMAL_TANGENT_SPACE:
         case DEBUGMATERIALMODE_NORMAL_WORLD_SPACE:
         {
-            debugColor = half4(surfaceData.normalTS, 1);
+            debugColor = half4(surfaceData.normalWS * 0.5 + 0.5, surfaceData.alpha);
+            return true;
+        }
+
+        case DEBUGMATERIALMODE_NORMAL_TANGENT_SPACE:
+        {
+            debugColor = half4(surfaceData.normalTS * 0.5 + 0.5, surfaceData.alpha);
             return true;
         }
 
diff --git a/Packages/com.unity.render-pipelines.universal/Shaders/2D/Include/Core2D.hlsl b/Packages/com.unity.render-pipelines.universal/Shaders/2D/Include/Core2D.hlsl
@@ -19,6 +19,7 @@
 #define COMMON_2D_INPUTS                 \
         float3 positionOS   : POSITION;  \
         float2 uv           : TEXCOORD0; \
+        float3 normal       : NORMAL;    \
         UNITY_VERTEX_INPUT_INSTANCE_ID
 
 #define COMMON_2D_OUTPUTS_SHARED              \
@@ -29,7 +30,8 @@
 #if defined(DEBUG_DISPLAY)
     #define COMMON_2D_OUTPUTS                \
             COMMON_2D_OUTPUTS_SHARED         \
-            float3 positionWS  : TEXCOORD2;    
+            float3 positionWS  : TEXCOORD2;  \
+            half3  normalWS    : TEXCOORD3;
 #else
     #define COMMON_2D_OUTPUTS                \
             COMMON_2D_OUTPUTS_SHARED             
@@ -38,7 +40,6 @@
 // Normals
 #define COMMON_2D_NORMALS_INPUTS       \
         COMMON_2D_INPUTS               \
-        float3 normal       : NORMAL;  \
         float4 tangent      : TANGENT; \
 
 #define COMMON_2D_NORMALS_OUTPUTS          \
diff --git a/Packages/com.unity.render-pipelines.universal/Shaders/2D/Include/Lit2DCommon.hlsl b/Packages/com.unity.render-pipelines.universal/Shaders/2D/Include/Lit2DCommon.hlsl
@@ -10,16 +10,20 @@ UNITY_TEXTURE_STREAMING_DEBUG_VARS_FOR_TEX(_MainTex);
 TEXTURE2D(_MaskTex);
 SAMPLER(sampler_MaskTex);
 
+TEXTURE2D(_NormalMap);
+SAMPLER(sampler_NormalMap);
+
 Varyings CommonLitVertex(Attributes input)
 {
     Varyings o = (Varyings) 0;
     UNITY_SETUP_INSTANCE_ID(input);
     UNITY_INITIALIZE_VERTEX_OUTPUT_STEREO(o);
 
     o.positionCS = TransformObjectToHClip(input.positionOS);
-    #if defined(DEBUG_DISPLAY)
-        o.positionWS = TransformObjectToWorld(input.positionOS);
-    #endif
+#if defined(DEBUG_DISPLAY)
+    o.positionWS = TransformObjectToWorld(input.positionOS);
+    o.normalWS = TransformObjectToWorldDir(input.normal);
+#endif
     o.uv = input.uv;
     o.lightingUV = half2(ComputeScreenPos(o.positionCS / o.positionCS.w).xy);
     return o;
@@ -29,15 +33,17 @@ half4 CommonLitFragment(Varyings input, half4 color)
 {
     const half4 main = color * SAMPLE_TEXTURE2D(_MainTex, sampler_MainTex, input.uv);
     const half4 mask = SAMPLE_TEXTURE2D(_MaskTex, sampler_MaskTex, input.uv);
-
+    const half3 normalTS = UnpackNormal(SAMPLE_TEXTURE2D(_NormalMap, sampler_NormalMap, input.uv));
+    
     SurfaceData2D surfaceData;
     InputData2D inputData;
 
-    InitializeSurfaceData(main.rgb, main.a, mask, surfaceData);
+    InitializeSurfaceData(main.rgb, main.a, mask, normalTS, surfaceData);
     InitializeInputData(input.uv, input.lightingUV, inputData);
 
 #if defined(DEBUG_DISPLAY)
     SETUP_DEBUG_TEXTURE_DATA_2D_NO_TS(inputData, input.positionWS, input.positionCS, _MainTex);
+    surfaceData.normalWS = input.normalWS;
 #endif
 
     return CombinedShapeLightShared(surfaceData, inputData);
diff --git a/Packages/com.unity.render-pipelines.universal/Shaders/2D/Include/NormalsRenderingShared.hlsl b/Packages/com.unity.render-pipelines.universal/Shaders/2D/Include/NormalsRenderingShared.hlsl
@@ -13,6 +13,4 @@ half4 NormalsRenderingShared(half4 color, half3 normalTS, half3 tangent, half3 b
 
     return normalColor;
 }
-
-
 #endif
diff --git a/Packages/com.unity.render-pipelines.universal/Shaders/2D/Include/SurfaceData2D.hlsl b/Packages/com.unity.render-pipelines.universal/Shaders/2D/Include/SurfaceData2D.hlsl
@@ -8,6 +8,9 @@ struct SurfaceData2D
     half alpha;
     half4 mask;
     half3 normalTS;
+#if defined(DEBUG_DISPLAY)
+    half3 normalWS;
+#endif
 };
 
 void InitializeSurfaceData(half3 albedo, half alpha, half4 mask, half3 normalTS, out SurfaceData2D surfaceData)

Original file line number	Diff line number	Diff line change
`@@ -214,6 +214,7 @@ static class SpriteUnlitRequiredFields`
`214`	`214`	`StructFields.Varyings.positionWS,`
`215`	`215`	`StructFields.Varyings.color,`
`216`	`216`	`StructFields.Varyings.texCoord0,`
	`217`	`+ StructFields.Varyings.normalWS,`
`217`	`218`	`};`
`218`	`219`	`}`
`219`	`220`	`#endregion`
Original file line number	Diff line number	Diff line change
`@@ -38,7 +38,7 @@ bool CalculateDebugColorMaterialSettings(in SurfaceData2D surfaceData, in InputD`
`38`	`38`
`39`	`39`	`case DEBUGMATERIALMODE_ALBEDO:`
`40`	`40`	`{`
`41`		`- debugColor = half4(surfaceData.albedo, 1);`
	`41`	`+ debugColor = half4(surfaceData.albedo, surfaceData.alpha);`
`42`	`42`	`return true;`
`43`	`43`	`}`
`44`	`44`
`@@ -54,10 +54,15 @@ bool CalculateDebugColorMaterialSettings(in SurfaceData2D surfaceData, in InputD`
`54`	`54`	`return true;`
`55`	`55`	`}`
`56`	`56`
`57`		`- case DEBUGMATERIALMODE_NORMAL_TANGENT_SPACE:`
`58`	`57`	`case DEBUGMATERIALMODE_NORMAL_WORLD_SPACE:`
`59`	`58`	`{`
`60`		`- debugColor = half4(surfaceData.normalTS, 1);`
	`59`	`+ debugColor = half4(surfaceData.normalWS * 0.5 + 0.5, surfaceData.alpha);`
	`60`	`+ return true;`
	`61`	`+ }`
	`62`	`+`
	`63`	`+ case DEBUGMATERIALMODE_NORMAL_TANGENT_SPACE:`
	`64`	`+ {`
	`65`	`+ debugColor = half4(surfaceData.normalTS * 0.5 + 0.5, surfaceData.alpha);`
`61`	`66`	`return true;`
`62`	`67`	`}`
`63`	`68`