Ported heightmap debugview to 10.3 (#20)

Author: GGijonUnity

com.unity.render-pipelines.high-definition/Runtime/Debug/DebugDisplay.cs

@@ -35,6 +35,7 @@ unsafe struct ShaderVariablesDebugDisplay
         public Vector4 _MousePixelCoord;  // xy unorm, zw norm
         public Vector4 _MouseClickPixelCoord;  // xy unorm, zw norm
         public Vector4 _DebugLutParams; // x: 1/width, y: 1/height, z: height-1, w: unused
+        public Vector4 _DebugShowHeightMaps; // xyz = color to use for materials not using heightmaps, w = albedo blend
 
         public int _MatcapMixAlbedo;
         public float _MatcapViewScale;
@@ -120,6 +121,8 @@ public enum FullScreenDebugMode
         ValidateDiffuseColor,
         /// <summary>Display specular Color validation mode.</summary>
         ValidateSpecularColor,
+        /// <summary>Display material heightmaps.</summary>
+        Heightmaps,
         /// <summary>Maximum Full Screen Material debug mode value (used internally).</summary>
         MaxMaterialFullScreenDebug,
         // TODO: Move before count for 11.0
@@ -336,6 +339,7 @@ internal DebugDisplaySettings()
 
             s_MaterialFullScreenDebugStrings[(int)FullScreenDebugMode.ValidateDiffuseColor - ((int)FullScreenDebugMode.MinMaterialFullScreenDebug)] = new GUIContent("Diffuse Color");
             s_MaterialFullScreenDebugStrings[(int)FullScreenDebugMode.ValidateSpecularColor - ((int)FullScreenDebugMode.MinMaterialFullScreenDebug)] = new GUIContent("Metal or SpecularColor");
+            s_MaterialFullScreenDebugStrings[(int)FullScreenDebugMode.Heightmaps - ((int)FullScreenDebugMode.MinMaterialFullScreenDebug)] = new GUIContent("Show Heightmaps");
 
             s_MsaaSamplesDebugStrings = Enum.GetNames(typeof(MSAASamples))
                 .Select(t => new GUIContent(t))
@@ -518,7 +522,7 @@ public bool IsDebugExposureModeEnabled()
         /// <returns>True if any material validation is enabled.</returns>
         public bool IsMaterialValidationEnabled()
         {
-            return (data.fullScreenDebugMode == FullScreenDebugMode.ValidateDiffuseColor) || (data.fullScreenDebugMode == FullScreenDebugMode.ValidateSpecularColor);
+            return (data.fullScreenDebugMode == FullScreenDebugMode.ValidateDiffuseColor) || (data.fullScreenDebugMode == FullScreenDebugMode.ValidateSpecularColor) || (data.fullScreenDebugMode == FullScreenDebugMode.Heightmaps);
         }
 
         /// <summary>
@@ -1017,6 +1021,17 @@ void RegisterMaterialDebug()
                     }
                 });
             }
+            else if (data.fullScreenDebugMode == FullScreenDebugMode.Heightmaps)
+            {
+                list.Add(new DebugUI.Container
+                {
+                    children =
+                    {
+                        new DebugUI.ColorField { displayName = "No HeightMap Color", getter = () => data.materialDebugSettings.showHeightMapsDefaultColor, setter = value => data.materialDebugSettings.showHeightMapsDefaultColor = value, showAlpha = false, hdr = false },
+                        new DebugUI.FloatField { displayName = "Blend Albedo", getter = () => data.materialDebugSettings.showHeightMapsBlendAlbedo, setter = (v) => data.materialDebugSettings.showHeightMapsBlendAlbedo = v, min = () => 0.0f, max = () => 1.0f, },
+                    }
+                });
+            }
 
             m_DebugMaterialItems = list.ToArray();
             var panel = DebugManager.instance.GetPanel(k_PanelMaterials, true);

com.unity.render-pipelines.high-definition/Runtime/Debug/DebugDisplay.cs.hlsl

@@ -37,9 +37,10 @@
 #define FULLSCREENDEBUGMODE_MIN_MATERIAL_FULL_SCREEN_DEBUG (27)
 #define FULLSCREENDEBUGMODE_VALIDATE_DIFFUSE_COLOR (28)
 #define FULLSCREENDEBUGMODE_VALIDATE_SPECULAR_COLOR (29)
-#define FULLSCREENDEBUGMODE_MAX_MATERIAL_FULL_SCREEN_DEBUG (30)
-#define FULLSCREENDEBUGMODE_SCREEN_SPACE_REFLECTIONS_PREV (31)
-#define FULLSCREENDEBUGMODE_SCREEN_SPACE_REFLECTIONS_ACCUM (32)
+#define FULLSCREENDEBUGMODE_HEIGHTMAPS (30)
+#define FULLSCREENDEBUGMODE_MAX_MATERIAL_FULL_SCREEN_DEBUG (31)
+#define FULLSCREENDEBUGMODE_SCREEN_SPACE_REFLECTIONS_PREV (32)
+#define FULLSCREENDEBUGMODE_SCREEN_SPACE_REFLECTIONS_ACCUM (33)
 
 // Generated from UnityEngine.Rendering.HighDefinition.ShaderVariablesDebugDisplay
 // PackingRules = Exact
@@ -66,6 +67,7 @@ CBUFFER_START(ShaderVariablesDebugDisplay)
     float4 _MousePixelCoord;
     float4 _MouseClickPixelCoord;
     float4 _DebugLutParams;
+    float4 _DebugShowHeightMaps;
     int _MatcapMixAlbedo;
     float _MatcapViewScale;
     int _DebugSingleShadowIndex;

com.unity.render-pipelines.high-definition/Runtime/Debug/MaterialDebug.cs

@@ -441,6 +441,10 @@ static void BuildDebugRepresentation()
         public Color materialValidateTrueMetalColor = new Color(1.0f, 1.0f, 0.0f);
         /// <summary>Enable display of materials using a true metallic value.</summary>
         public bool  materialValidateTrueMetal = false;
+        /// <summary>Color for displaying materials that don't have a HeightMap in Show Heightmaps mode.</summary>
+        public Color showHeightMapsDefaultColor = new Color(0.5f, 0.5f, 0.5f);
+        /// <summary>How much from the albedo map is used to tint the heightmap.</summary>
+        public float showHeightMapsBlendAlbedo = 0.2f;
 
         /// <summary>
         /// Current Debug View Material.

com.unity.render-pipelines.high-definition/Runtime/Material/AxF/AxF.hlsl

@@ -340,6 +340,10 @@ void GetPBRValidatorDebug(SurfaceData surfaceData, inout float3 result)
     result = surfaceData.diffuseColor;
 }
 
+float4 GetHeightMapDebug(SurfaceData surfaceData)
+{
+    return float4(surfaceData.diffuseColor, 1);
+}
 
 
 // This function is used to help with debugging and must be implemented by any lit material

com.unity.render-pipelines.high-definition/Runtime/Material/AxF/AxFData.hlsl

@@ -668,6 +668,16 @@ void GetSurfaceAndBuiltinData(FragInputs input, float3 V, inout PositionInputs p
     // We need to call ApplyDebugToSurfaceData after filling the surfarcedata and before filling builtinData
     // as it can modify attribute use for static lighting
     ApplyDebugToSurfaceData(input.tangentToWorld, surfaceData);
+
+    if (_DebugFullScreenMode == FULLSCREENDEBUGMODE_HEIGHTMAPS)
+    {
+        float3 heightmap = _DebugShowHeightMaps.rgb;
+#if defined(_HEIGHTMAP)
+        float  lod = ComputeTextureLOD(GetMinUvSize(layerTexCoord));
+        heightmap = SAMPLE_TEXTURE2D_LOD(_HeightMap, sampler_HeightMap, layerTexCoord.base.uvZY, lod).rrr;
+#endif
+        surfaceData.diffuseColor = lerp(heightmap, surfaceData.diffuseColor, _DebugShowHeightMaps.a);
+    }
 #endif
 
     // -------------------------------------------------------------

com.unity.render-pipelines.high-definition/Runtime/Material/LayeredLit/LayeredLitData.hlsl

@@ -813,6 +813,36 @@ void GetSurfaceAndBuiltinData(FragInputs input, float3 V, inout PositionInputs p
     // We need to call ApplyDebugToSurfaceData after filling the surfarcedata and before filling builtinData
     // as it can modify attribute use for static lighting
     ApplyDebugToSurfaceData(input.tangentToWorld, surfaceData);
+
+    if (_DebugFullScreenMode == FULLSCREENDEBUGMODE_HEIGHTMAPS)
+    {
+        float3 heightmap = _DebugShowHeightMaps.rgb;
+
+#if LAYERS_HEIGHTMAP_ENABLE
+        LayerTexCoord layerTexCoord;
+        ZERO_INITIALIZE(LayerTexCoord, layerTexCoord);
+        GetLayerTexCoord(input, layerTexCoord);
+
+        float4 blendMasks = GetBlendMask(layerTexCoord, input.color);
+        SetEnabledHeightByLayer(blendMasks.x, blendMasks.y, blendMasks.z, blendMasks.w); // Nullify weights for unused layers
+
+        float totalWeight = length(blendMasks);
+        if (totalWeight > 0)
+        {
+
+            float lod = ComputeTextureLOD(GetMinUvSize(layerTexCoord));
+
+            float height0 = SAMPLE_TEXTURE2D_LOD(_HeightMap0, SAMPLER_HEIGHTMAP_IDX, layerTexCoord.base0.uv, lod).r;
+            float height1 = SAMPLE_TEXTURE2D_LOD(_HeightMap1, SAMPLER_HEIGHTMAP_IDX, layerTexCoord.base1.uv, lod).r;
+            float height2 = SAMPLE_TEXTURE2D_LOD(_HeightMap2, SAMPLER_HEIGHTMAP_IDX, layerTexCoord.base2.uv, lod).r;
+            float height3 = SAMPLE_TEXTURE2D_LOD(_HeightMap3, SAMPLER_HEIGHTMAP_IDX, layerTexCoord.base3.uv, lod).r;
+
+            heightmap = dot(float4(height0, height1, height2, height3), blendMasks.argb) / totalWeight;
+        }
+#endif
+
+        surfaceData.baseColor = lerp(heightmap, surfaceData.baseColor, _DebugShowHeightMaps.a);
+    }
 #endif
 
     // By default we use the ambient occlusion with Tri-ace trick (apply outside) for specular occlusion.

com.unity.render-pipelines.high-definition/Runtime/Material/Lit/Lit.hlsl

@@ -1021,6 +1021,11 @@ void GetPBRValidatorDebug(SurfaceData surfaceData, inout float3 result)
     result = surfaceData.baseColor;
 }
 
+float4 GetHeightMapDebug(SurfaceData surfaceData)
+{
+    return float4(surfaceData.baseColor, 1);
+}
+
 //-----------------------------------------------------------------------------
 // PreLightData
 //-----------------------------------------------------------------------------

com.unity.render-pipelines.high-definition/Runtime/Material/Lit/LitData.hlsl

@@ -279,6 +279,16 @@ void GetSurfaceAndBuiltinData(FragInputs input, float3 V, inout PositionInputs p
     // We need to call ApplyDebugToSurfaceData after filling the surfarcedata and before filling builtinData
     // as it can modify attribute use for static lighting
     ApplyDebugToSurfaceData(input.tangentToWorld, surfaceData);
+
+    if (_DebugFullScreenMode == FULLSCREENDEBUGMODE_HEIGHTMAPS)
+    {
+        float3 heightmap = _DebugShowHeightMaps.rgb;
+#if defined(_HEIGHTMAP)
+        float  lod = ComputeTextureLOD(GetMinUvSize(layerTexCoord));
+        heightmap = SAMPLE_TEXTURE2D_LOD(_HeightMap, sampler_HeightMap, layerTexCoord.base.uvZY, lod).rrr;
+#endif
+        surfaceData.baseColor = lerp(heightmap, surfaceData.baseColor, _DebugShowHeightMaps.a);
+    }
 #endif
 
     // By default we use the ambient occlusion with Tri-ace trick (apply outside) for specular occlusion.

com.unity.render-pipelines.high-definition/Runtime/Material/TerrainLit/TerrainLitData.hlsl

@@ -237,6 +237,16 @@ void GetSurfaceAndBuiltinData(inout FragInputs input, float3 V, inout PositionIn
     // We need to call ApplyDebugToSurfaceData after filling the surfarcedata and before filling builtinData
     // as it can modify attribute use for static lighting
     ApplyDebugToSurfaceData(input.tangentToWorld, surfaceData);
+
+    if (_DebugFullScreenMode == FULLSCREENDEBUGMODE_HEIGHTMAPS)
+    {
+        float3 heightmap = _DebugShowHeightMaps.rgb;
+#if defined(_HEIGHTMAP)
+        float  lod = ComputeTextureLOD(GetMinUvSize(layerTexCoord));
+        heightmap = SAMPLE_TEXTURE2D_LOD(_HeightMap, sampler_HeightMap, layerTexCoord.base.uvZY, lod).rrr;
+#endif
+        surfaceData.baseColor = lerp(heightmap, surfaceData.baseColor, _DebugShowHeightMaps.a);
+    }
 #endif
 
     // By default we use the ambient occlusion with Tri-ace trick (apply outside) for specular occlusion.

com.unity.render-pipelines.high-definition/Runtime/Material/Unlit/UnlitData.hlsl

@@ -87,5 +87,17 @@ void GetSurfaceAndBuiltinData(FragInputs input, float3 V, inout PositionInputs p
 
     ApplyDebugToBuiltinData(builtinData);
 
+#if defined(DEBUG_DISPLAY) && !defined(SHADER_STAGE_RAY_TRACING)
+    if (_DebugFullScreenMode == FULLSCREENDEBUGMODE_HEIGHTMAPS)
+    {
+        float3 heightmap = _DebugShowHeightMaps.rgb;
+#if defined(_HEIGHTMAP)
+        float  lod = ComputeTextureLOD(GetMinUvSize(layerTexCoord));
+        heightmap = SAMPLE_TEXTURE2D_LOD(_HeightMap, sampler_HeightMap, layerTexCoord.base.uvZY, lod).rrr;
+#endif
+        surfaceData.color = lerp(heightmap, surfaceData.color, _DebugShowHeightMaps.a);
+    }
+#endif
+
     RAY_TRACING_OPTIONAL_ALPHA_TEST_PASS
 }