BoundBoxRenderer: support reverse depth

Author: TheMostDiligent

Components/interface/BoundBoxRenderer.hpp

@@ -1,5 +1,5 @@
 /*
- *  Copyright 2024 Diligent Graphics LLC
+ *  Copyright 2024-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.
@@ -34,6 +34,7 @@
 #include "../../../DiligentCore/Common/interface/RefCntAutoPtr.hpp"
 #include "../../../DiligentCore/Common/interface/HashUtils.hpp"
 #include "../../../DiligentCore/Common/interface/BasicMath.hpp"
+#include "../../../DiligentCore/Primitives/interface/FlagEnum.h"
 
 namespace Diligent
 {
@@ -68,6 +69,21 @@ class BoundBoxRenderer
     BoundBoxRenderer(const CreateInfo& CI);
     ~BoundBoxRenderer();
 
+    /// Option flags.
+    enum OPTION_FLAGS : Uint32
+    {
+        OPTION_FLAG_NONE = 0u,
+
+        /// Manually convert shader output to sRGB color space.
+        OPTION_FLAG_CONVERT_OUTPUT_TO_SRGB = 1u << 0u,
+
+        /// Compute motion vectors.
+        OPTION_FLAG_COMPUTE_MOTION_VECTORS = 1u << 1u,
+
+        /// Use reverse depth (i.e. near plane is at 1.0, far plane is at 0.0).
+        OPTION_FLAG_USE_REVERSE_DEPTH = 1u << 2u
+    };
+
     struct RenderAttribs
     {
         /// Bounding box transformation matrix.
@@ -86,43 +102,36 @@ class BoundBoxRenderer
         /// For example, use 0x0000FFFFu to draw a dashed line.
         Uint32 PatternMask = 0xFFFFFFFFu;
 
-        /// Manually convert shader output to sRGB color space.
-        bool ConvertOutputToSRGB = false;
-
-        bool ComputeMotionVectors = false;
+        /// Render options.
+        OPTION_FLAGS Options = OPTION_FLAG_NONE;
     };
     void Prepare(IDeviceContext* pContext, const RenderAttribs& Attribs);
     void Render(IDeviceContext* pContext);
 
-
+private:
     struct PSOKey
     {
-        const bool ConvertOutputToSRGB;
-        const bool ComputeMotionVectors;
+        const OPTION_FLAGS Flags;
 
-        PSOKey(bool _ConvertOutputToSRGB,
-               bool _ComputeMotionVectors) :
-            ConvertOutputToSRGB{_ConvertOutputToSRGB},
-            ComputeMotionVectors{_ComputeMotionVectors}
+        explicit PSOKey(OPTION_FLAGS _Flags) :
+            Flags{_Flags}
         {}
 
         constexpr bool operator==(const PSOKey& rhs) const
         {
-            return (ConvertOutputToSRGB == rhs.ConvertOutputToSRGB &&
-                    ComputeMotionVectors == rhs.ComputeMotionVectors);
+            return Flags == rhs.Flags;
         }
 
         struct Hasher
         {
             size_t operator()(const PSOKey& Key) const
             {
-                return ComputeHash(Key.ConvertOutputToSRGB);
+                return ComputeHash(Key.Flags);
             }
         };
     };
     IPipelineState* GetPSO(const PSOKey& Key);
 
-private:
     RefCntAutoPtr<IRenderDevice>     m_pDevice;
     RefCntAutoPtr<IRenderStateCache> m_pStateCache;
     RefCntAutoPtr<IBuffer>           m_pCameraAttribsCB;
@@ -143,5 +152,7 @@ class BoundBoxRenderer
     struct BoundBoxShaderAttribs;
     std::unique_ptr<BoundBoxShaderAttribs> m_ShaderAttribs;
 };
+DEFINE_FLAG_ENUM_OPERATORS(BoundBoxRenderer::OPTION_FLAGS);
+
 
 } // namespace Diligent

Components/src/BoundBoxRenderer.cpp

@@ -1,5 +1,5 @@
 /*
- *  Copyright 2024 Diligent Graphics LLC
+ *  Copyright 2024-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.
@@ -114,8 +114,8 @@ IPipelineState* BoundBoxRenderer::GetPSO(const PSOKey& Key)
 
     ShaderMacroHelper Macros;
     Macros
-        .Add("CONVERT_OUTPUT_TO_SRGB", Key.ConvertOutputToSRGB)
-        .Add("COMPUTE_MOTION_VECTORS", Key.ComputeMotionVectors);
+        .Add("CONVERT_OUTPUT_TO_SRGB", (Key.Flags & OPTION_FLAG_CONVERT_OUTPUT_TO_SRGB) != 0)
+        .Add("COMPUTE_MOTION_VECTORS", (Key.Flags & OPTION_FLAG_COMPUTE_MOTION_VECTORS) != 0);
     ShaderCI.Macros = Macros;
 
     RefCntAutoPtr<IShader> pVS;
@@ -157,7 +157,7 @@ IPipelineState* BoundBoxRenderer::GetPSO(const PSOKey& Key)
 
     PsoCI.PSODesc.ResourceLayout.DefaultVariableMergeStages  = SHADER_TYPE_VS_PS;
     PsoCI.PSODesc.ResourceLayout.DefaultVariableType         = SHADER_RESOURCE_VARIABLE_TYPE_MUTABLE;
-    PsoCI.GraphicsPipeline.DepthStencilDesc.DepthFunc        = COMPARISON_FUNC_LESS_EQUAL;
+    PsoCI.GraphicsPipeline.DepthStencilDesc.DepthFunc        = (Key.Flags & OPTION_FLAG_USE_REVERSE_DEPTH) != 0 ? COMPARISON_FUNC_GREATER_EQUAL : COMPARISON_FUNC_LESS_EQUAL;
     PsoCI.GraphicsPipeline.DepthStencilDesc.DepthWriteEnable = false;
     if (m_AsyncShaders)
         PsoCI.Flags |= PSO_CREATE_FLAG_ASYNCHRONOUS;
@@ -175,7 +175,7 @@ IPipelineState* BoundBoxRenderer::GetPSO(const PSOKey& Key)
 
 void BoundBoxRenderer::Prepare(IDeviceContext* pContext, const RenderAttribs& Attribs)
 {
-    m_pCurrentPSO = GetPSO({Attribs.ConvertOutputToSRGB, Attribs.ComputeMotionVectors});
+    m_pCurrentPSO = GetPSO(PSOKey{Attribs.Options});
     if (m_pCurrentPSO == nullptr)
     {
         UNEXPECTED("Failed to get PSO");

Hydrogent/src/Tasks/HnRenderBoundBoxTask.cpp

@@ -1,5 +1,5 @@
 /*
- *  Copyright 2024 Diligent Graphics LLC
+ *  Copyright 2024-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.
@@ -194,11 +194,14 @@ void HnRenderBoundBoxTask::Prepare(pxr::HdTaskContext* TaskCtx,
     }
 
     BoundBoxRenderer::RenderAttribs Attribs;
-    Attribs.Color                = &m_Params.Color;
-    Attribs.BoundBoxTransform    = &BoundBoxTransform;
-    Attribs.PatternLength        = m_Params.PatternLength;
-    Attribs.PatternMask          = m_Params.PatternMask;
-    Attribs.ComputeMotionVectors = true;
+    Attribs.Color             = &m_Params.Color;
+    Attribs.BoundBoxTransform = &BoundBoxTransform;
+    Attribs.PatternLength     = m_Params.PatternLength;
+    Attribs.PatternMask       = m_Params.PatternMask;
+    Attribs.Options           = BoundBoxRenderer::OPTION_FLAG_COMPUTE_MOTION_VECTORS;
+    if (pRenderParam->GetConfig().UseReverseDepth)
+        Attribs.Options |= BoundBoxRenderer::OPTION_FLAG_USE_REVERSE_DEPTH;
+
     m_BoundBoxRenderer->Prepare(pRenderDelegate->GetDeviceContext(), Attribs);
 
     m_RenderBoundBox = true;