[XPipeline]Consolidation for Material's Priority in URP and HDRP (#3966)

Author: alex-vazquez

com.unity.render-pipelines.high-definition/CHANGELOG.md

@@ -208,6 +208,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 - The default LookDev volume profile is now copied and referened in the Asset folder instead of the package folder.
 - Changed normal used in path tracing to create a local light list from the geometric to the smooth shading one.
 - Embed the HDRP config package instead of copying locally, the `Packages` folder is versionned by Collaborate. (case 1276518)
+- Materials with Transparent Surface type, the property Sorting Priority is clamped on the UI from -50 to 50 instead of -100 to 100.
 - Improved lighting models for AxF shader area lights.
 - Updated Wizard to better handle RenderPipelineAsset in Quality Settings
 - UI for Frame Settings has been updated: default values in the HDRP Settings and Custom Frame Settings are always editable

com.unity.render-pipelines.high-definition/Documentation~/Renderer-And-Material-Priority.md

@@ -16,7 +16,7 @@ The resulting queue is a list of GameObjects that are first sorted by their Mate
 
 ## Sorting by Material
 
-Materials with a **Transparent Surface Type** have a **Sorting Priority** property that you can use to sort groups of Meshes that use different Materials. This property is an integer value clamped between -100 and 100.
+Materials with a **Transparent Surface Type** have a **Sorting Priority** property that you can use to sort groups of Meshes that use different Materials. This property is an integer value clamped between -50 and 50.
 
 ![](Images/RendererAndMaterialPriority1.png)
 

com.unity.render-pipelines.high-definition/Documentation~/Upgrading-from-2021.1-to-2021.2.md

@@ -17,3 +17,9 @@ ClearFlag.Depth does not implicitely clear stencil anymore. ClearFlag.Stencil ad
 ## HDRP Global Settings
 
 From 2021.2, the HDRP Asset assigned in the Graphics Settings no longer acts as the default Asset for HDRP. A new HDRP Global Settings Asset now exists to save settings unrelated to which HDRP Asset is active.
+
+## Materials
+
+### Transparent Surface Type
+
+From 2021.2, the range for **Sorting Priority** values has decreased from between -100 and 100 to between -50 and 50. If you used transparent materials (**Surface Type** set to **Transparent**) with a sorting priority lower than -50 or greater than 50, you must remap them to within the new range. HDRP does not clamp the Sorting Priority to the new range until you edit the Sorting Priority property.

com.unity.render-pipelines.high-definition/Editor/Material/UIBlocks/AdvancedOptionsUIBlock.cs

@@ -47,9 +47,9 @@ internal class Styles
         }
 
         MaterialProperty specularOcclusionMode = null;
-        MaterialProperty addPrecomputedVelocity = null;
-
         const string kSpecularOcclusionMode = "_SpecularOcclusionMode";
+
+        MaterialProperty addPrecomputedVelocity = null;
         const string kAddPrecomputedVelocity = HDMaterialProperties.kAddPrecomputedVelocity;
 
         Features    m_Features;

com.unity.render-pipelines.high-definition/Editor/Material/UIBlocks/SurfaceOptionUIBlock.cs

@@ -581,7 +581,7 @@ protected void DrawSurfaceGUI()
                 }
 
                 if (transparentSortPriority != null)
-                    materialEditor.IntShaderProperty(transparentSortPriority, Styles.transparentSortPriorityText, HDRenderQueue.ClampsTransparentRangePriority);
+                    materialEditor.IntSliderShaderProperty(transparentSortPriority, -HDRenderQueue.sortingPriortyRange, HDRenderQueue.sortingPriortyRange, Styles.transparentSortPriorityText);
 
                 if (enableFogOnTransparent != null)
                     materialEditor.ShaderProperty(enableFogOnTransparent, Styles.enableTransparentFogText);

com.unity.render-pipelines.high-definition/Runtime/RenderPipeline/HDRenderQueue.cs

@@ -9,42 +9,42 @@ namespace UnityEngine.Rendering.HighDefinition
 
     internal static class HDRenderQueue
     {
-        const int k_TransparentPriorityQueueRange = 100;
+        const int k_TransparentPriorityQueueRangeStep = 100;
 
         public enum Priority
         {
-            Background = UnityEngine.Rendering.RenderQueue.Background,
+            Background = RenderQueue.Background,
 
 
-            Opaque = UnityEngine.Rendering.RenderQueue.Geometry,
-            OpaqueDecal = UnityEngine.Rendering.RenderQueue.Geometry + 225, // Opaque Decal mean Opaque that can receive decal
-            OpaqueAlphaTest = UnityEngine.Rendering.RenderQueue.AlphaTest,
-            OpaqueDecalAlphaTest = UnityEngine.Rendering.RenderQueue.AlphaTest + 25,
+            Opaque = RenderQueue.Geometry,
+            OpaqueDecal = RenderQueue.Geometry + 225, // Opaque Decal mean Opaque that can receive decal
+            OpaqueAlphaTest = RenderQueue.AlphaTest,
+            OpaqueDecalAlphaTest = RenderQueue.AlphaTest + 25,
             // Warning: we must not change Geometry last value to stay compatible with occlusion
-            OpaqueLast = UnityEngine.Rendering.RenderQueue.GeometryLast,
+            OpaqueLast = RenderQueue.GeometryLast,
 
-            AfterPostprocessOpaque = UnityEngine.Rendering.RenderQueue.GeometryLast + 1,
-            AfterPostprocessOpaqueAlphaTest = UnityEngine.Rendering.RenderQueue.GeometryLast + 10,
+            AfterPostprocessOpaque = RenderQueue.GeometryLast + 1,
+            AfterPostprocessOpaqueAlphaTest = RenderQueue.GeometryLast + 10,
 
             // For transparent pass we define a range of 200 value to define the priority
             // Warning: Be sure no range are overlapping
-            PreRefractionFirst = 2750 - k_TransparentPriorityQueueRange,
+            PreRefractionFirst = 2750 - k_TransparentPriorityQueueRangeStep,
             PreRefraction = 2750,
-            PreRefractionLast = 2750 + k_TransparentPriorityQueueRange,
+            PreRefractionLast = 2750 + k_TransparentPriorityQueueRangeStep,
 
-            TransparentFirst = UnityEngine.Rendering.RenderQueue.Transparent - k_TransparentPriorityQueueRange,
-            Transparent = UnityEngine.Rendering.RenderQueue.Transparent,
-            TransparentLast = UnityEngine.Rendering.RenderQueue.Transparent + k_TransparentPriorityQueueRange,
+            TransparentFirst = RenderQueue.Transparent - k_TransparentPriorityQueueRangeStep,
+            Transparent = RenderQueue.Transparent,
+            TransparentLast = RenderQueue.Transparent + k_TransparentPriorityQueueRangeStep,
 
-            LowTransparentFirst = 3400 - k_TransparentPriorityQueueRange,
+            LowTransparentFirst = 3400 - k_TransparentPriorityQueueRangeStep,
             LowTransparent = 3400,
-            LowTransparentLast = 3400 + k_TransparentPriorityQueueRange,
+            LowTransparentLast = 3400 + k_TransparentPriorityQueueRangeStep,
 
-            AfterPostprocessTransparentFirst = 3700 - k_TransparentPriorityQueueRange,
+            AfterPostprocessTransparentFirst = 3700 - k_TransparentPriorityQueueRangeStep,
             AfterPostprocessTransparent = 3700,
-            AfterPostprocessTransparentLast = 3700 + k_TransparentPriorityQueueRange,
+            AfterPostprocessTransparentLast = 3700 + k_TransparentPriorityQueueRangeStep,
 
-            Overlay = UnityEngine.Rendering.RenderQueue.Overlay
+            Overlay = RenderQueue.Overlay
         }
 
         public enum RenderQueueType
@@ -107,7 +107,8 @@ internal static RenderQueueType MigrateRenderQueueToHDRP10(RenderQueueType rende
 
         public static int Clamps(this RenderQueueRange range, int value) => Math.Max(range.lowerBound, Math.Min(value, range.upperBound));
 
-        public static int ClampsTransparentRangePriority(int value) => Math.Max(-k_TransparentPriorityQueueRange, Math.Min(value, k_TransparentPriorityQueueRange));
+        public const int sortingPriortyRange = 50;
+        public static int ClampsTransparentRangePriority(int value) => Math.Max(-sortingPriortyRange, Math.Min(value, sortingPriortyRange));
 
         public static RenderQueueType GetTypeByRenderQueueValue(int renderQueue)
         {
@@ -170,7 +171,7 @@ public static RenderQueueType GetTransparentEquivalent(RenderQueueType type)
                     return type;
                 case RenderQueueType.Overlay:
                 case RenderQueueType.Background:
-                    throw new ArgumentException("Unknow RenderQueueType conversion to transparent equivalent, was " + type);
+                    throw new ArgumentException("Unknown RenderQueueType conversion to transparent equivalent, was " + type);
             }
         }
 
@@ -189,7 +190,7 @@ public static RenderQueueType GetOpaqueEquivalent(RenderQueueType type)
                     return type;
                 case RenderQueueType.Overlay:
                 case RenderQueueType.Background:
-                    throw new ArgumentException("Unknow RenderQueueType conversion to opaque equivalent, was " + type);
+                    throw new ArgumentException("Unknown RenderQueueType conversion to opaque equivalent, was " + type);
             }
         }
 
@@ -272,9 +273,9 @@ public static string GetShaderTagValue(int index)
         {
             // Special case for transparent (as we have transparent range from PreRefractionFirst to AfterPostprocessTransparentLast
             // that start before RenderQueue.Transparent value
-            if (HDRenderQueue.k_RenderQueue_AllTransparent.Contains(index)
-                || HDRenderQueue.k_RenderQueue_AfterPostProcessTransparent.Contains(index)
-                || HDRenderQueue.k_RenderQueue_LowTransparent.Contains(index))
+            if (k_RenderQueue_AllTransparent.Contains(index)
+                || k_RenderQueue_AfterPostProcessTransparent.Contains(index)
+                || k_RenderQueue_LowTransparent.Contains(index))
             {
                 int v = (index - (int)RenderQueue.Transparent);
                 return "Transparent" + ((v < 0) ? "" : "+") + v;

com.unity.render-pipelines.universal/CHANGELOG.md

@@ -33,6 +33,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 - Changed UniversalRenderPipelineCameraEditor to URPCameraEditor
 - Reduced the size of the fragment input struct of the TerrainLitPasses and LitGBufferPass, SimpleLitForwardPass and SimpleLitGBufferPass lighting shaders.
 - Bokeh Depth of Field performance improvement: moved some calculations from GPU to CPU.
+- Advanced Options > Priority has been renamed to Sorting Priority
 - Opacity as Density blending feature for Terrain Lit Shader is now disabled when the Terrain has more than four Terrain Layers. This is now similar to the Height-blend feature for the Terrain Lit Shader.
 - DepthNormals passes now sample normal maps if used on the material, otherwise output the geometry normal.
 - SSAO Texture is now R8 instead of ARGB32 if supported by the platform.

com.unity.render-pipelines.universal/Editor/ShaderGUI/BaseShaderGUI.cs

@@ -95,8 +95,8 @@ protected class Styles
             public static readonly GUIContent fixNormalNow = EditorGUIUtility.TrTextContent("Fix now",
                 "Converts the assigned texture to be a normal map format.");
 
-            public static readonly GUIContent queueSlider = EditorGUIUtility.TrTextContent("Priority",
-                "Determines the chronological rendering order for a Material. High values are rendered first.");
+            public static readonly GUIContent queueSlider = EditorGUIUtility.TrTextContent("Sorting Priority",
+                "Determines the chronological rendering order for a Material. Materials with lower value are rendered first.");
         }
 
         #endregion