Hydrogent: a few minor updates/fixes

TheMostDiligent · TheMostDiligent · commit 498b153c3b8c · 2025-03-13T09:27:03.000-07:00
diff --git a/Hydrogent/interface/HnRenderPass.hpp b/Hydrogent/interface/HnRenderPass.hpp
@@ -73,7 +73,8 @@ struct HnRenderPassParams
     {
         return (Selection == rhs.Selection &&
                 Type == rhs.Type &&
-                UsdPsoFlags == rhs.UsdPsoFlags);
+                UsdPsoFlags == rhs.UsdPsoFlags &&
+                AlphaMode == rhs.AlphaMode);
     }
 
     static const char* GetSelectionTypeString(SelectionType Type);
diff --git a/Hydrogent/interface/HnRenderPassState.hpp b/Hydrogent/interface/HnRenderPassState.hpp
@@ -141,7 +141,7 @@ class HnRenderPassState final : public pxr::HdRenderPassState
     }
     bool GetUseReverseDepth() const
     {
-        return GetDepthFunc() == pxr::HdCmpFuncGreater;
+        return GetDepthFunc() == pxr::HdCmpFuncGreater || GetDepthFunc() == pxr::HdCmpFuncGEqual;
     }
 
     static constexpr Uint32 ClearDepthBit = 1u << 31u;
diff --git a/Hydrogent/interface/Tasks/HnBeginFrameTask.hpp b/Hydrogent/interface/Tasks/HnBeginFrameTask.hpp
@@ -48,7 +48,6 @@ namespace USD
 {
 
 class HnCamera;
-class HnRenderDelegate;
 
 struct HnBeginFrameTaskParams
 {
@@ -99,15 +98,16 @@ struct HnBeginFrameTaskParams
         constexpr bool operator==(const RendererParams& rhs) const
         {
             // clang-format off
-            return OcclusionStrength          == rhs.OcclusionStrength &&
-                   EmissionScale              == rhs.EmissionScale &&
-                   IBLScale                   == rhs.IBLScale &&
-                   UnshadedColor              == rhs.UnshadedColor &&
-                   PointSize                  == rhs.PointSize &&
-                   LoadingAnimationColor0     == rhs.LoadingAnimationColor0 &&
-                   LoadingAnimationColor1     == rhs.LoadingAnimationColor1 &&
-                   LoadingAnimationWorldScale == rhs.LoadingAnimationWorldScale &&
-                   LoadingAnimationSpeed      == rhs.LoadingAnimationSpeed;
+            return OcclusionStrength                  == rhs.OcclusionStrength &&
+                   EmissionScale                      == rhs.EmissionScale &&
+                   IBLScale                           == rhs.IBLScale &&
+                   UnshadedColor                      == rhs.UnshadedColor &&
+                   PointSize                          == rhs.PointSize &&
+                   LoadingAnimationColor0             == rhs.LoadingAnimationColor0 &&
+                   LoadingAnimationColor1             == rhs.LoadingAnimationColor1 &&
+                   LoadingAnimationWorldScale         == rhs.LoadingAnimationWorldScale &&
+                   LoadingAnimationSpeed              == rhs.LoadingAnimationSpeed &&
+                   LoadingAnimationTransitionDuration == rhs.LoadingAnimationTransitionDuration;
             // clang-format on
         }
     };
diff --git a/Hydrogent/interface/Tasks/HnBeginOITPassTask.hpp b/Hydrogent/interface/Tasks/HnBeginOITPassTask.hpp
@@ -55,7 +55,9 @@ struct HnBeginOITPassTaskParams
     }
 };
 
-/// Updates OIT layers
+/// Begins OIT pass
+/// - Binds OIT resources
+/// - Clears OIT layers
 class HnBeginOITPassTask final : public HnTask
 {
 public:
diff --git a/Hydrogent/interface/Tasks/HnEndOITPassTask.hpp b/Hydrogent/interface/Tasks/HnEndOITPassTask.hpp
@@ -50,7 +50,8 @@ struct HnEndOITPassTaskParams
     }
 };
 
-/// Updates OIT layers
+/// Ends OIT pass
+/// - Applies OIT attenuation to the color, base color, material and IBL targets
 class HnEndOITPassTask final : public HnTask
 {
 public:
diff --git a/Hydrogent/interface/Tasks/HnPostProcessTask.hpp b/Hydrogent/interface/Tasks/HnPostProcessTask.hpp
@@ -1,5 +1,5 @@
 /*
- *  Copyright 2023-2024 Diligent Graphics LLC
+ *  Copyright 2023-2025 Diligent Graphics LLC
  *
  *  Licensed under the Apache License, Version 2.0 (the "License");
  *  you may not use this file except in compliance with the License.
@@ -171,8 +171,10 @@ struct HnPostProcessTaskParams
 };
 
 /// Performs post processing:
-/// - Tone mapping
+/// - SSR, SSAO, TAA, DOF, Bloom, Tone mapping
 /// - Selection outline
+/// - Coordinate grid
+/// - Motion vectors
 /// - Converts output to sRGB, if needed
 class HnPostProcessTask final : public HnTask
 {
diff --git a/Hydrogent/interface/Tasks/HnRenderRprimsTask.hpp b/Hydrogent/interface/Tasks/HnRenderRprimsTask.hpp
@@ -1,5 +1,5 @@
 /*
- *  Copyright 2023-2024 Diligent Graphics LLC
+ *  Copyright 2023-2025 Diligent Graphics LLC
  *
  *  Licensed under the Apache License, Version 2.0 (the "License");
  *  you may not use this file except in compliance with the License.
@@ -72,7 +72,7 @@ struct HnRenderRprimsTaskParams
 DEFINE_FLAG_ENUM_OPERATORS(HnRenderRprimsTaskParams::RENDER_MODE_FLAGS);
 
 /// Renders the Rprims by executing the render pass.
-/// The task should be executed after the HnSetupRenderingTask that prepares
+/// The task should be executed after the HnBeginMainPassTask that prepares
 /// the render targets and sets the required task context and render pass state
 /// parameters.
 class HnRenderRprimsTask final : public HnTask
diff --git a/Hydrogent/interface/Tasks/HnTaskManager.hpp b/Hydrogent/interface/Tasks/HnTaskManager.hpp
@@ -111,12 +111,14 @@ class HnTaskManager
     ///                             * Binds and clears OIT layers for rendering
     ///                         - RenderRprimsOITLayers
     ///                         - EndOITPass
+    ///                             * Applies OIT attenuation to color, base color, material and IBL targets
     ///                         - RenderRprimsAdditive
     ///                             * Renders all Rprims with additive material tag
     ///                         - RenderRprimsTranslucent
     ///                             * Renders all Rprims with translucent material tag
-    ///                         - TaskUID_RenderRprimsTranslucentMeshId
-    ///                             * Renders all Rprims with translucent material tag (Mesh ID, Motion Vectors, Depth)
+    ///                             * If OIT is enabled, does not write Mesh ID, Motion Vectors, Normals, Depth
+    ///                         - RenderRprimsTranslucentMeshId
+    ///                             * Renders all Rprims with translucent material tag (Mesh ID, Motion Vectors, Normals, Depth)
     ///                         - RenderRprimsAdditiveSelected
     ///                             * Renders only selected Rprims with the additive material tag (depth only)
     ///                         - RenderRprimsTranslucentSelected
@@ -140,10 +142,10 @@ class HnTaskManager
     ///     | RenderBoundBox                  |                  |                   |   V    |           |          |                  |            |
     ///     | RenderRprimsAdditive            |       V          |         V         |   V    |     V     |    V     |                  |     V      |
     ///     | BeginOITPass                    |                  |                   |        |           |          |                  |            |
-    ///     | RenderRprimsOITLayers           |                  |                   |        |           |          |                  |            |
+    ///     | RenderRprimsOITLayers           |       V          |         V         |        |           |          |                  |            |
     ///	    | EndOITPass                      |                  |                   |        |           |          |                  |            |
     ///     | RenderRprimsTranslucent         |       V          |         V         |   V    |     V     |    V     |                  |     V      |
-    ///     | RenderRprimsTranslucentMeshId   |       V          |         V         |        |     V     |          |                  |     V      |
+    ///     | RenderRprimsTranslucentMeshId   |       V          |         V         |        |     V     |  MV, N   |                  |     V      |
     ///     | RenderRprimsAdditiveSelected    |       V          |                   |        |           |          |        V         |            |
     ///     | RenderRprimsTranslucentSelected |       V          |                   |        |           |          |        V         |            |
     ///     | ReadRprimId                     |                  |                   |        |           |          |                  |            |
diff --git a/Hydrogent/src/HnRenderDelegate.cpp b/Hydrogent/src/HnRenderDelegate.cpp
@@ -760,6 +760,7 @@ void HnRenderDelegate::CommitResources(pxr::HdChangeTracker* tracker)
         {
             m_ShadowAtlasVersion = ShadowAtlasVersion;
 
+            // Release the frame attribs SRBs to update the shadow map SRV.
             static_assert(static_cast<size_t>(FrameAttribsSRBType::Count) == 2, "Did you add a new FrameAttribsSRBType? You may need to update this code.");
             for (FrameAttribsSRBType Type : {FrameAttribsSRBType::Opaque, FrameAttribsSRBType::Transparent})
                 _GetFrameAttribsSRB(Type).Release();
@@ -769,8 +770,7 @@ void HnRenderDelegate::CommitResources(pxr::HdChangeTracker* tracker)
     const bool EnableOIT = m_USDRenderer->GetSettings().OITLayerCount > 0;
     if (EnableOIT)
     {
-        // OIT resource version is made dirty by HnBeginOITPassTask when the frame size changes.
-        // OIT resources will be set in the SRB by HnBeginOITPassTask::Execute().
+        // OIT resource version is made dirty by HnBeginOITPassTask::Prepare() when the frame size changes.
         if (m_OITResourcesVersion != m_RenderParam->GetAttribVersion(HnRenderParam::GlobalAttrib::OITResources))
         {
             m_OITResourcesVersion = m_RenderParam->GetAttribVersion(HnRenderParam::GlobalAttrib::OITResources);
@@ -832,6 +832,7 @@ void HnRenderDelegate::CommitResources(pxr::HdChangeTracker* tracker)
     {
         if (!TransparentPassFrameAttribsSRB)
         {
+            // OIT resources are set in the transparent pass SRB by HnBeginOITPassTask::Execute().
             TransparentPassFrameAttribsSRB = CreateFrameAttribsSRB(m_USDRenderer->GetPRBFrameAttribsSize(), pShadowSRV);
         }
     }
diff --git a/Hydrogent/src/HnRenderPass.cpp b/Hydrogent/src/HnRenderPass.cpp
@@ -181,7 +181,7 @@ struct HnRenderPass::RenderState
         if (Type == PBR_Renderer::RenderPassType::OITLayers && pRWOITLayersSRB == nullptr)
         {
             pRWOITLayersSRB = RPState.GetRWOITLayersSRB();
-            VERIFY_EXPR(pRWOITLayersSRB != nullptr);
+            VERIFY_EXPR(pRWOITLayersSRB != nullptr, "RW OIT layers SRB is null. It should have been set in the render pass state by HnBeginOITPassTask::Execute().");
             pCtx->CommitShaderResources(pRWOITLayersSRB, RESOURCE_STATE_TRANSITION_MODE_VERIFY);
         }
 
diff --git a/Hydrogent/src/Tasks/HnBeginFrameTask.cpp b/Hydrogent/src/Tasks/HnBeginFrameTask.cpp
@@ -252,7 +252,7 @@ void HnBeginFrameTask::PrepareRenderTargets(pxr::HdRenderIndex* RenderIndex,
     std::array<float4, HnFrameRenderTargets::GBUFFER_TARGET_COUNT> ClearValues; // No need to zero-initialize
     for (Uint32 i = 0; i < HnFrameRenderTargets::GBUFFER_TARGET_COUNT; ++i)
     {
-        // NB: we should clear alpha to one as it accumulates total transmittance
+        // NB: we should clear alpha to one as it accumulates the total transmittance
         ClearValues[i] = (i == HnFrameRenderTargets::GBUFFER_TARGET_SCENE_COLOR) ?
             float4{m_Params.ClearColor.r, m_Params.ClearColor.g, m_Params.ClearColor.b, 1.0} :
             float4{0};
diff --git a/Hydrogent/src/Tasks/HnBeginOITPassTask.cpp b/Hydrogent/src/Tasks/HnBeginOITPassTask.cpp
@@ -104,12 +104,13 @@ void HnBeginOITPassTask::Prepare(pxr::HdTaskContext* TaskCtx,
     VERIFY_EXPR(Renderer.GetSettings().OITLayerCount > 0);
 
     // If no translucent draw items were rendered in the last frame, we can skip clearing the layers.
+    // Note that m_RenderPassState.Begin() clears the stats, so we need to check the stats before calling it.
     m_OITLayersCleared = static_cast<bool>(FrameTargets->OIT) && m_RenderPassState.GetStats().NumDrawItems == 0;
 
     if (!FrameTargets->OIT)
     {
         FrameTargets->OIT = Renderer.CreateOITResources(ColorTargetDesc.Width, ColorTargetDesc.Height);
-        // Mark OIT resources dirty to make render delegate recreate transparent pass frame attribs SRB.
+        // Mark OIT resources dirty to make render delegate recreate transparent pass frame attribs SRB in HnRenderDelegate::CommitResources().
         // We will set the OIT resources in the SBR in Execute().
         static_cast<HnRenderParam*>(RenderDelegate->GetRenderParam())->MakeAttribDirty(HnRenderParam::GlobalAttrib::OITResources);
     }
diff --git a/Hydrogent/src/Tasks/HnEndOITPassTask.cpp b/Hydrogent/src/Tasks/HnEndOITPassTask.cpp
@@ -146,18 +146,8 @@ void HnEndOITPassTask::Execute(pxr::HdTaskContext* TaskCtx)
         return;
     }
 
-    std::array<ITextureView*, OITBlendTargetIds.size()> ppRTVs;
-    for (size_t i = 0; i < ppRTVs.size(); ++i)
-    {
-        ppRTVs[i] = FrameTargets->GBufferRTVs[OITBlendTargetIds[i]];
-        if (ppRTVs[i] == nullptr)
-        {
-            UNEXPECTED("Frame render target ", HnFrameRenderTargets::GetGBufferTargetName(OITBlendTargetIds[i]), " is null");
-            return;
-        }
-    }
-    pCtx->SetRenderTargets(static_cast<Uint32>(ppRTVs.size()), ppRTVs.data(), nullptr, RESOURCE_STATE_TRANSITION_MODE_TRANSITION);
-
+    // Ubind OIT resources from output and transition to shader resource state
+    pCtx->SetRenderTargets(0, nullptr, nullptr, RESOURCE_STATE_TRANSITION_MODE_TRANSITION);
     const StateTransitionDesc Barriers[] =
         {
             {FrameTargets->OIT.Layers, RESOURCE_STATE_UNKNOWN, RESOURCE_STATE_SHADER_RESOURCE, STATE_TRANSITION_FLAG_UPDATE_STATE},
@@ -169,6 +159,18 @@ void HnEndOITPassTask::Execute(pxr::HdTaskContext* TaskCtx)
     VERIFY_EXPR(RenderPassState != nullptr);
     if (RenderPassState != nullptr && RenderPassState->GetStats().NumDrawItems > 0)
     {
+        std::array<ITextureView*, OITBlendTargetIds.size()> ppRTVs;
+        for (size_t i = 0; i < ppRTVs.size(); ++i)
+        {
+            ppRTVs[i] = FrameTargets->GBufferRTVs[OITBlendTargetIds[i]];
+            if (ppRTVs[i] == nullptr)
+            {
+                UNEXPECTED("Frame render target ", HnFrameRenderTargets::GetGBufferTargetName(OITBlendTargetIds[i]), " is null");
+                return;
+            }
+        }
+        pCtx->SetRenderTargets(static_cast<Uint32>(ppRTVs.size()), ppRTVs.data(), nullptr, RESOURCE_STATE_TRANSITION_MODE_TRANSITION);
+
         Renderer.ApplyOITAttenuation(pCtx, m_ApplyOITAttenuationPSO, m_ApplyOITAttenuationSRB);
     }
 }
diff --git a/Hydrogent/src/Tasks/HnRenderBoundBoxTask.cpp b/Hydrogent/src/Tasks/HnRenderBoundBoxTask.cpp
@@ -88,7 +88,6 @@ void main(in BoundBoxVSOutput VSOut,
     BoundBoxOutput BoundBox = GetBoundBoxOutput(VSOut);
 
     // Write 1.0 alpha as if bound box was fully transparent.
-    // In particular, this disables SSR.
     Color = float4(BoundBox.Color.rgb, 1.0);
 
     MotionVec = float4(BoundBox.MotionVector, 0.0, 1.0);
diff --git a/Hydrogent/src/Tasks/HnTaskManager.cpp b/Hydrogent/src/Tasks/HnTaskManager.cpp
@@ -628,6 +628,7 @@ void HnTaskManager::EnableMaterial(const pxr::TfToken& MaterialTag, bool Enable)
             EnableTask(TaskUID_BeginOITPass, Enable);
             EnableTask(TaskUID_RenderRprimsOITLayers, Enable);
             EnableTask(TaskUID_EndOITPass, Enable);
+            EnableTask(TaskUID_RenderRprimsTranslucentMeshId, Enable);
         }
     }
     else

Original file line number	Diff line number	Diff line change
`@@ -73,7 +73,8 @@ struct HnRenderPassParams`
`73`	`73`	`{`
`74`	`74`	`return (Selection == rhs.Selection &&`
`75`	`75`	`Type == rhs.Type &&`
`76`		`- UsdPsoFlags == rhs.UsdPsoFlags);`
	`76`	`+ UsdPsoFlags == rhs.UsdPsoFlags &&`
	`77`	`+ AlphaMode == rhs.AlphaMode);`
`77`	`78`	`}`
`78`	`79`
`79`	`80`	`static const char* GetSelectionTypeString(SelectionType Type);`
Original file line number	Diff line number	Diff line change
`@@ -141,7 +141,7 @@ class HnRenderPassState final : public pxr::HdRenderPassState`
`141`	`141`	`}`
`142`	`142`	`bool GetUseReverseDepth() const`
`143`	`143`	`{`
`144`		`- return GetDepthFunc() == pxr::HdCmpFuncGreater;`
	`144`	`+ return GetDepthFunc() == pxr::HdCmpFuncGreater \|\| GetDepthFunc() == pxr::HdCmpFuncGEqual;`
`145`	`145`	`}`
`146`	`146`
`147`	`147`	`static constexpr Uint32 ClearDepthBit = 1u << 31u;`
Original file line number	Diff line number	Diff line change
`@@ -55,7 +55,9 @@ struct HnBeginOITPassTaskParams`
`55`	`55`	`}`
`56`	`56`	`};`
`57`	`57`
`58`		`-/// Updates OIT layers`
	`58`	`+/// Begins OIT pass`
	`59`	`+/// - Binds OIT resources`
	`60`	`+/// - Clears OIT layers`
`59`	`61`	`class HnBeginOITPassTask final : public HnTask`
`60`	`62`	`{`
`61`	`63`	`public:`
Original file line number	Diff line number	Diff line change
`@@ -50,7 +50,8 @@ struct HnEndOITPassTaskParams`
`50`	`50`	`}`
`51`	`51`	`};`
`52`	`52`
`53`		`-/// Updates OIT layers`
	`53`	`+/// Ends OIT pass`
	`54`	`+/// - Applies OIT attenuation to the color, base color, material and IBL targets`
`54`	`55`	`class HnEndOITPassTask final : public HnTask`
`55`	`56`	`{`
`56`	`57`	`public:`
Original file line number	Diff line number	Diff line change
`@@ -760,6 +760,7 @@ void HnRenderDelegate::CommitResources(pxr::HdChangeTracker* tracker)`
`760`	`760`	`{`
`761`	`761`	`m_ShadowAtlasVersion = ShadowAtlasVersion;`
`762`	`762`
	`763`	`+ // Release the frame attribs SRBs to update the shadow map SRV.`
`763`	`764`	`static_assert(static_cast<size_t>(FrameAttribsSRBType::Count) == 2, "Did you add a new FrameAttribsSRBType? You may need to update this code.");`
`764`	`765`	`for (FrameAttribsSRBType Type : {FrameAttribsSRBType::Opaque, FrameAttribsSRBType::Transparent})`
`765`	`766`	`_GetFrameAttribsSRB(Type).Release();`
`@@ -769,8 +770,7 @@ void HnRenderDelegate::CommitResources(pxr::HdChangeTracker* tracker)`
`769`	`770`	`const bool EnableOIT = m_USDRenderer->GetSettings().OITLayerCount > 0;`
`770`	`771`	`if (EnableOIT)`
`771`	`772`	`{`
`772`		`- // OIT resource version is made dirty by HnBeginOITPassTask when the frame size changes.`
`773`		`- // OIT resources will be set in the SRB by HnBeginOITPassTask::Execute().`
	`773`	`+ // OIT resource version is made dirty by HnBeginOITPassTask::Prepare() when the frame size changes.`
`774`	`774`	`if (m_OITResourcesVersion != m_RenderParam->GetAttribVersion(HnRenderParam::GlobalAttrib::OITResources))`
`775`	`775`	`{`
`776`	`776`	`m_OITResourcesVersion = m_RenderParam->GetAttribVersion(HnRenderParam::GlobalAttrib::OITResources);`
`@@ -832,6 +832,7 @@ void HnRenderDelegate::CommitResources(pxr::HdChangeTracker* tracker)`
`832`	`832`	`{`
`833`	`833`	`if (!TransparentPassFrameAttribsSRB)`
`834`	`834`	`{`
	`835`	`+ // OIT resources are set in the transparent pass SRB by HnBeginOITPassTask::Execute().`
`835`	`836`	`TransparentPassFrameAttribsSRB = CreateFrameAttribsSRB(m_USDRenderer->GetPRBFrameAttribsSize(), pShadowSRV);`
`836`	`837`	`}`
`837`	`838`	`}`
Original file line number	Diff line number	Diff line change
`@@ -181,7 +181,7 @@ struct HnRenderPass::RenderState`
`181`	`181`	`if (Type == PBR_Renderer::RenderPassType::OITLayers && pRWOITLayersSRB == nullptr)`
`182`	`182`	`{`
`183`	`183`	`pRWOITLayersSRB = RPState.GetRWOITLayersSRB();`
`184`		`- VERIFY_EXPR(pRWOITLayersSRB != nullptr);`
	`184`	`+ VERIFY_EXPR(pRWOITLayersSRB != nullptr, "RW OIT layers SRB is null. It should have been set in the render pass state by HnBeginOITPassTask::Execute().");`
`185`	`185`	`pCtx->CommitShaderResources(pRWOITLayersSRB, RESOURCE_STATE_TRANSITION_MODE_VERIFY);`
`186`	`186`	`}`
`187`	`187`