Graphics/SRP - Enable RenderGraph.nativeRenderPassesEnabled by default and deprecate Legacy Render Graph API

Author: axoloto

Packages/com.unity.render-pipelines.core/Runtime/RenderGraph/RenderGraph.cs

@@ -129,6 +129,7 @@ internal interface IDerivedRendergraphContext
     /// in favor of more specific contexts that have more specific command buffer types.
     /// </summary>
     [MovedFrom(true, "UnityEngine.Experimental.Rendering.RenderGraphModule", "UnityEngine.Rendering.RenderGraphModule")]
+    [Obsolete("RenderGraphContext is deprecated, use RasterGraphContext/ComputeGraphContext/UnsafeGraphContext instead.")]
     public struct RenderGraphContext : IDerivedRendergraphContext
     {
         private InternalRenderGraphContext wrappedContext;
@@ -394,9 +395,9 @@ public void Reset(RenderGraphPass pass, int index)
         }
 
         /// <summary>
-        /// Enable the use of the render pass API by the graph instead of traditional SetRenderTarget. This is an advanced
-        /// feature and users have to be aware of the specific impact it has on rendergraph/graphics APIs below.
-        ///
+        /// Enable the use of the render pass API instead of the traditional SetRenderTarget workflow for AddRasterRenderPass() API. Enabled by default since 6000.3.
+        /// </summary>
+        /// <remarks>
         /// When enabled, the render graph try to use render passes and supasses instead of relying on SetRendertarget. It
         /// will try to aggressively optimize the number of BeginRenderPass+EndRenderPass calls as well as calls to NextSubPass.
         /// This with the aim to maximize the time spent "on chip" on tile based renderers.
@@ -416,11 +417,8 @@ public void Reset(RenderGraphPass pass, int index)
         ///
         /// Note: that CommandBuffer.BeginRenderPass/EndRenderPass calls are different by design from SetRenderTarget so this could also have
         /// effects outside of render graph (e.g. for code relying on the currently active render target as this will not be updated when using render passes).
-        /// </summary>
-        public bool nativeRenderPassesEnabled
-        {
-            get; set;
-        }
+        /// </remarks>
+        public bool nativeRenderPassesEnabled { get; set; } = true;
 
         internal static bool hasAnyRenderGraphWithNativeRenderPassesEnabled
         {
@@ -547,7 +545,7 @@ public RenderGraphDefaultResources defaultResources
         /// <summary>
         /// Render Graph constructor.
         /// </summary>
-        /// <param name="name">Optional name used to identify the render graph instnace.</param>
+        /// <param name="name">Optional name used to identify the render graph instance.</param>
         public RenderGraph(string name = "RenderGraph")
         {
             this.name = name;
@@ -843,6 +841,7 @@ public TextureHandle CreateTexture(in TextureDesc desc)
         /// <param name="desc">Creation descriptor of the texture.</param>
         /// <param name="explicitRelease">Set to true if you want to manage the lifetime of the resource yourself. Otherwise the resource will be released automatically if unused for a time.</param>
         /// <returns>A new TextureHandle.</returns>
+        [Obsolete("CreateSharedTexture() and shared texture workflow are deprecated, use ImportTexture() workflow instead.")]
         public TextureHandle CreateSharedTexture(in TextureDesc desc, bool explicitRelease = false)
         {
             CheckNotUsingNativeRenderPassCompiler();
@@ -859,6 +858,7 @@ public TextureHandle CreateSharedTexture(in TextureDesc desc, bool explicitRelea
         /// </remarks>
         /// <param name="handle">Shared texture that needs to be updated.</param>
         /// <param name="desc">New Descriptor for the texture.</param>
+        [Obsolete("RefreshSharedTextureDesc() and shared texture workflow are deprecated, use ImportTexture() workflow instead.")]
         public void RefreshSharedTextureDesc(TextureHandle handle, in TextureDesc desc)
         {
             CheckNotUsingNativeRenderPassCompiler();
@@ -873,6 +873,7 @@ public void RefreshSharedTextureDesc(TextureHandle handle, in TextureDesc desc)
         /// This API should not be used with URP NRP Render Graph. This API cannot be called when Render Graph is active, please call it outside of RecordRenderGraph().
         /// </remarks>
         /// <param name="texture">The handle to the texture that needs to be release.</param>
+        [Obsolete("ReleaseSharedTexture() and shared texture workflow are deprecated, use ImportTexture() workflow instead.")]
         public void ReleaseSharedTexture(TextureHandle texture)
         {
             CheckNotUsingNativeRenderPassCompiler();
@@ -1431,6 +1432,7 @@ public IUnsafeRenderGraphBuilder AddUnsafePass<PassData>(string passName, out Pa
         /// <param name="file">File name of the source file this function is called from. Used for debugging. This parameter is automatically generated by the compiler. Users do not need to pass it.</param>
         /// <param name="line">File line of the source file this function is called from. Used for debugging. This parameter is automatically generated by the compiler. Users do not need to pass it.</param>
         /// <returns>A new instance of a RenderGraphBuilder used to setup the new Render Pass.</returns>
+        [Obsolete("AddRenderPass() is deprecated, use AddRasterRenderPass/AddComputePass/AddUnsafePass() instead.")]
         public RenderGraphBuilder AddRenderPass<PassData>(string passName, out PassData passData, ProfilingSampler sampler
 #if !CORE_PACKAGE_DOCTOOLS
             ,[CallerFilePath] string file = "",
@@ -1467,6 +1469,7 @@ public RenderGraphBuilder AddRenderPass<PassData>(string passName, out PassData
         /// <param name="file">File name of the source file this function is called from. Used for debugging. This parameter is automatically generated by the compiler. Users do not need to pass it.</param>
         /// <param name="line">File line of the source file this function is called from. Used for debugging. This parameter is automatically generated by the compiler. Users do not need to pass it.</param>
         /// <returns>A new instance of a RenderGraphBuilder used to setup the new Render Pass.</returns>
+        [Obsolete("AddRenderPass() is deprecated, use AddRasterRenderPass/AddComputePass/AddUnsafePass() instead.")]
         public RenderGraphBuilder AddRenderPass<PassData>(string passName, out PassData passData
 #if !CORE_PACKAGE_DOCTOOLS
             ,[CallerFilePath] string file = "",

Packages/com.unity.render-pipelines.core/Runtime/RenderGraph/RenderGraphBuilder.cs

@@ -8,6 +8,7 @@ namespace UnityEngine.Rendering.RenderGraphModule
     /// Use this struct to set up a new Render Pass.
     /// </summary>
     [MovedFrom(true, "UnityEngine.Experimental.Rendering.RenderGraphModule", "UnityEngine.Rendering.RenderGraphModule")]
+    [Obsolete("RenderGraphBuilder is deprecated, use IComputeRenderGraphBuilder/IRasterRenderGraphBuilder/IUnsafeRenderGraphBuilder instead.")]
     public struct RenderGraphBuilder : IDisposable
     {
         RenderGraphPass m_RenderPass;

Packages/com.unity.render-pipelines.core/Runtime/RenderGraph/RenderGraphBuilders.cs

@@ -363,7 +363,7 @@ private void CheckUseFragment(TextureHandle tex, bool isDepth)
 
                 m_Resources.GetRenderTargetInfo(tex.handle, out var info);
 
-                // The old path is full of invalid uses that somehow work (or seemt to work) so we skip the tests if not using actual native renderpass
+                // The old path is full of invalid uses that somehow work (or seem to work) so we skip validation if not using actual native renderpass
                 if (m_RenderGraph.nativeRenderPassesEnabled)
                 {
                     if (isDepth)

Packages/com.unity.render-pipelines.core/Runtime/RenderGraph/RenderGraphPass.cs

@@ -640,6 +640,7 @@ public override int GetRenderFuncHash()
     }
 
     [DebuggerDisplay("RenderPass: {name} (Index:{index} Async:{enableAsyncCompute})")]
+    [Obsolete("RenderGraphPass is deprecated, use RasterRenderGraphPass/ComputeRenderGraphPass/UnsafeRenderGraphPass instead.")]
     internal sealed class RenderGraphPass<PassData> : BaseRenderGraphPass<PassData, RenderGraphContext>
         where PassData : class, new()
     {

Packages/com.unity.render-pipelines.core/Runtime/Utilities/GPUPrefixSum/GPUPrefixSum.Data.cs

@@ -89,6 +89,7 @@ public static RenderGraphResources Create(int newMaxElementCount, RenderGraph re
                 return resources;
             }
 
+#pragma warning disable CS0618 // Type or member is obsolete
             void Initialize(int newMaxElementCount, RenderGraph renderGraph, RenderGraphBuilder builder, bool outputIsTemp = false)
             {
                 newMaxElementCount = Math.Max(newMaxElementCount, 1);
@@ -104,6 +105,7 @@ void Initialize(int newMaxElementCount, RenderGraph renderGraph, RenderGraphBuil
                 maxBufferCount = totalSize;
                 maxLevelCount = levelCounts;
             }
+#pragma warning restore CS0618 // Type or member is obsolete
 
             /// <summary>
             /// Creates the render graph buffer resources from an input count.

Packages/com.unity.render-pipelines.core/Tests/Editor/NativePassCompilerRenderGraphTests.cs

@@ -83,7 +83,6 @@ public void OneTimeTearDown()
         RenderGraph AllocateRenderGraph()
         {
             RenderGraph g = new RenderGraph();
-            g.nativeRenderPassesEnabled = true;
             return g;
         }
 

Packages/com.unity.render-pipelines.core/Tests/Editor/RenderGraphTests.cs

@@ -812,11 +812,13 @@ public void ExceptionsOnExecuteAreHandledAsExpected()
         [Test]
         public void UsingAddRenderPassWithNRPThrows()
         {
-            // m_RenderGraph.nativeRenderPassesEnabled is set to true in the setup
+            // m_RenderGraph.nativeRenderPassesEnabled is true by default
             // record and execute render graph calls
             m_RenderGraphTestPipeline.recordRenderGraphBody = (context, camera, cmd) =>
             {
+#pragma warning disable CS0618 // Type or member is obsolete
                 using var builder = m_RenderGraph.AddRenderPass<RenderGraphTestPassData>("HDRP Render Pass", out var passData);
+#pragma warning restore CS0618 // Type or member is obsolete
             };
 
             LogAssert.Expect(LogType.Error, "Render Graph Execution error");

Packages/com.unity.render-pipelines.high-definition/Runtime/RenderPipeline/HDRenderPipeline.RenderGraph.cs

@@ -461,8 +461,6 @@ void ExecuteWithRenderGraph(RenderRequest renderRequest,
                 commandBuffer = commandBuffer
             };
 
-            m_RenderGraph.nativeRenderPassesEnabled = true;
-
             try
             {
                 m_RenderGraph.BeginRecording(parameters);

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

@@ -209,7 +209,7 @@ internal bool useRenderGraph
         }
 
         /// <inheritdoc/>
-        public bool isImmediateModeSupported => true;
+        public bool isImmediateModeSupported => false;
 
         [SerializeField] private CustomPostProcessVolumeComponentList m_CompositorCustomVolumeComponentsList = new(CustomPostProcessInjectionPoint.BeforePostProcess);
 

Packages/com.unity.render-pipelines.universal/Runtime/UniversalRenderPipeline.cs

@@ -746,12 +746,7 @@ static void RenderSingleCamera(ScriptableRenderContext context, UniversalCameraD
                 return;
 
             ScriptableRenderer.current = renderer;
-#if RENDER_GRAPH_OLD_COMPILER
-            s_RenderGraph.nativeRenderPassesEnabled = false;
-            Debug.LogWarning("The native render pass compiler is disabled. Use this for debugging only. Mobile performance may be sub-optimal.");
-#else
-            s_RenderGraph.nativeRenderPassesEnabled = renderer.supportsNativeRenderPassRendergraphCompiler;
-#endif
+
             bool isSceneViewCamera = cameraData.isSceneViewCamera;
 
             // NOTE: Do NOT mix ProfilingScope with named CommandBuffers i.e. CommandBufferPool.Get("name").