Grpahics Accessories: a bit more documentation updates + minor code cleanup

TheMostDiligent · TheMostDiligent · commit 78d36eda995c · 2025-04-09T13:08:59.000-07:00
diff --git a/Graphics/GraphicsAccessories/interface/ResourceReleaseQueue.hpp b/Graphics/GraphicsAccessories/interface/ResourceReleaseQueue.hpp
@@ -1,5 +1,5 @@
 /*
- *  Copyright 2019-2022 Diligent Graphics LLC
+ *  Copyright 2019-2025 Diligent Graphics LLC
  *  Copyright 2015-2019 Egor Yusov
  *
  *  Licensed under the Apache License, Version 2.0 (the "License");
@@ -218,7 +218,7 @@ class StaticStaleResourceWrapper
 /// * When command list is submitted to the command queue, all stale objects associated with this
 ///   and earlier command lists are moved to the release queue, along with the fence value associated with
 ///   the command list
-/// * Resources are removed and actually destroyed from the queue when fence is signaled and the queue is Purged
+/// * Resources are removed and actually destroyed from the queue when fence is signaled and the queue is purged
 ///
 /// \tparam ResourceWrapperType -  Type of the resource wrapper used by the release queue.
 template <typename ResourceWrapperType>
@@ -239,6 +239,7 @@ class ResourceReleaseQueue
     }
 
     /// Creates a resource wrapper for the specific resource type
+
     /// \param [in] Resource      - Resource to be released
     /// \param [in] NumReferences - Number of references to the resource
     template <typename ResourceType, typename = typename std::enable_if<std::is_object<ResourceType>::value>::type>
@@ -248,6 +249,7 @@ class ResourceReleaseQueue
     }
 
     /// Moves a resource to the stale resources queue
+
     /// \param [in] Resource              - Resource to be released
     /// \param [in] NextCommandListNumber - Number of the command list that will be submitted to the queue next
     template <typename ResourceType, typename = typename std::enable_if<std::is_object<ResourceType>::value>::type>
@@ -257,6 +259,7 @@ class ResourceReleaseQueue
     }
 
     /// Moves a resource wrapper to the stale resources queue
+
     /// \param [in] Wrapper               - Resource wrapper containing the resource to be released
     /// \param [in] NextCommandListNumber - Number of the command list that will be submitted to the queue next
     void SafeReleaseResource(ResourceWrapperType&& Wrapper, Uint64 NextCommandListNumber)
@@ -266,6 +269,7 @@ class ResourceReleaseQueue
     }
 
     /// Moves a copy of the resource wrapper to the stale resources queue
+
     /// \param [in] Wrapper               - Resource wrapper containing the resource to be released
     /// \param [in] NextCommandListNumber - Number of the command list that will be submitted to the queue next
     void SafeReleaseResource(const ResourceWrapperType& Wrapper, Uint64 NextCommandListNumber)
@@ -275,6 +279,7 @@ class ResourceReleaseQueue
     }
 
     /// Adds a resource directly to the release queue
+
     /// \param [in] Resource    - Resource to be released.
     /// \param [in] FenceValue  - Fence value indicating when the resource was used last time.
     template <typename ResourceType, typename = typename std::enable_if<std::is_object<ResourceType>::value>::type>
@@ -284,6 +289,7 @@ class ResourceReleaseQueue
     }
 
     /// Adds a resource wrapper directly to the release queue
+
     /// \param [in] Wrapper     - Resource wrapper containing the resource to be released.
     /// \param [in] FenceValue  - Fence value indicating when the resource was used last time.
     void DiscardResource(ResourceWrapperType&& Wrapper, Uint64 FenceValue)
@@ -293,6 +299,7 @@ class ResourceReleaseQueue
     }
 
     /// Adds a copy of the resource wrapper directly to the release queue
+
     /// \param [in] Wrapper     - Resource wrapper containing the resource to be released.
     /// \param [in] FenceValue  - Fence value indicating when the resource was used last time.
     void DiscardResource(const ResourceWrapperType& Wrapper, Uint64 FenceValue)
@@ -302,6 +309,7 @@ class ResourceReleaseQueue
     }
 
     /// Adds multiple resources directly to the release queue
+
     /// \param [in] FenceValue  - Fence value indicating when the resource was used last time.
     /// \param [in] Iterator    - Iterator that returns resources to be released.
     template <typename ResourceType, typename IteratorType>
@@ -316,6 +324,7 @@ class ResourceReleaseQueue
     }
 
     /// Moves stale objects to the release queue
+
     /// \param [in] SubmittedCmdBuffNumber - number of the last submitted command list.
     ///                                      All resources in the stale object list whose command list number is
     ///                                      less than or equal to this value are moved to the release queue.
@@ -344,6 +353,7 @@ class ResourceReleaseQueue
 
     /// Removes all objects from the release queue whose fence value is
     /// less than or equal to CompletedFenceValue
+
     /// \param [in] CompletedFenceValue  -  Value of the fence that has been completed by the GPU
     void Purge(Uint64 CompletedFenceValue)
     {
diff --git a/Graphics/GraphicsAccessories/interface/RingBuffer.hpp b/Graphics/GraphicsAccessories/interface/RingBuffer.hpp
@@ -1,5 +1,5 @@
 /*
- *  Copyright 2019-2022 Diligent Graphics LLC
+ *  Copyright 2019-2025 Diligent Graphics LLC
  *  Copyright 2015-2019 Egor Yusov
  *
  *  Licensed under the Apache License, Version 2.0 (the "License");
@@ -123,7 +123,7 @@ class RingBuffer
             return InvalidOffset;
         }
 
-        auto AlignedHead = AlignUp(m_Head, Alignment);
+        OffsetType AlignedHead = AlignUp(m_Head, Alignment);
         if (m_Head >= m_Tail)
         {
             //                                         AlignedHead
@@ -134,8 +134,8 @@ class RingBuffer
             //
             if (AlignedHead + Size <= m_MaxSize)
             {
-                auto Offset       = AlignedHead;
-                auto AdjustedSize = Size + (AlignedHead - m_Head);
+                OffsetType Offset       = AlignedHead;
+                OffsetType AdjustedSize = Size + (AlignedHead - m_Head);
                 m_Head += AdjustedSize;
                 m_UsedSize += AdjustedSize;
                 m_CurrFrameSize += AdjustedSize;
@@ -164,8 +164,8 @@ class RingBuffer
             //       |  |              |
             //  [xxxx...               xxxxxxxxxxxxxxxxxxxxxxxxxx]
             //
-            auto Offset       = AlignedHead;
-            auto AdjustedSize = Size + (AlignedHead - m_Head);
+            OffsetType Offset       = AlignedHead;
+            OffsetType AdjustedSize = Size + (AlignedHead - m_Head);
             m_Head += AdjustedSize;
             m_UsedSize += AdjustedSize;
             m_CurrFrameSize += AdjustedSize;
@@ -199,7 +199,7 @@ class RingBuffer
         // We can release all heads whose associated fence value is less than or equal to CompletedFenceValue
         while (!m_CompletedFrameHeads.empty() && m_CompletedFrameHeads.front().FenceValue <= CompletedFenceValue)
         {
-            const auto& OldestFrameHead = m_CompletedFrameHeads.front();
+            const FrameHeadAttribs& OldestFrameHead = m_CompletedFrameHeads.front();
             VERIFY_EXPR(OldestFrameHead.Size <= m_UsedSize);
             m_UsedSize -= OldestFrameHead.Size;
             m_Tail = OldestFrameHead.Offset;
@@ -210,7 +210,7 @@ class RingBuffer
         {
 #ifdef DILIGENT_DEBUG
             VERIFY(m_CompletedFrameHeads.empty(), "Zero-size heads are not added to the list, and since the buffer is empty, there must be no heads in the list");
-            for (const auto& head : m_CompletedFrameHeads)
+            for (const FrameHeadAttribs& head : m_CompletedFrameHeads)
                 VERIFY(head.Size == 0, "Non zero-size head found");
 #endif
             m_CompletedFrameHeads.clear();
diff --git a/Graphics/GraphicsAccessories/interface/VariableSizeAllocationsManager.hpp b/Graphics/GraphicsAccessories/interface/VariableSizeAllocationsManager.hpp
@@ -1,5 +1,5 @@
 /*
- *  Copyright 2019-2022 Diligent Graphics LLC
+ *  Copyright 2019-2025 Diligent Graphics LLC
  *  Copyright 2015-2019 Egor Yusov
  *
  *  Licensed under the Apache License, Version 2.0 (the "License");
@@ -26,7 +26,6 @@
  */
 
 // Helper class that handles free memory block management to accommodate variable-size allocation requests
-// See http://diligentgraphics.com/diligent-engine/architecture/d3d12/variable-size-memory-allocations-manager/
 
 #pragma once
 
@@ -40,6 +39,7 @@
 
 namespace Diligent
 {
+
 // The class handles free memory block management to accommodate variable-size allocation requests.
 // It keeps track of free blocks only and does not record allocation sizes. The class uses two ordered maps
 // to facilitate operations. The first map keeps blocks sorted by their offsets. The second multimap keeps blocks
@@ -211,7 +211,7 @@ class VariableSizeAllocationsManager
         if (m_FreeSize < Size)
             return Allocation::InvalidAllocation();
 
-        auto AlignmentReserve = (Alignment > m_CurrAlignment) ? Alignment - m_CurrAlignment : 0;
+        OffsetType AlignmentReserve = (Alignment > m_CurrAlignment) ? Alignment - m_CurrAlignment : 0;
         // Get the first block that is large enough to encompass Size + AlignmentReserve bytes
         // lower_bound() returns an iterator pointing to the first element that
         // is not less (i.e. >= ) than key
@@ -230,13 +230,13 @@ class VariableSizeAllocationsManager
         //        |                  |
         //      Offset              NewOffset
         //
-        auto Offset = SmallestBlockIt->first;
+        OffsetType Offset = SmallestBlockIt->first;
         VERIFY_EXPR(Offset % m_CurrAlignment == 0);
-        auto AlignedOffset = AlignUp(Offset, Alignment);
-        auto AdjustedSize  = Size + (AlignedOffset - Offset);
+        OffsetType AlignedOffset = AlignUp(Offset, Alignment);
+        OffsetType AdjustedSize  = Size + (AlignedOffset - Offset);
         VERIFY_EXPR(AdjustedSize <= Size + AlignmentReserve);
-        auto NewOffset = Offset + AdjustedSize;
-        auto NewSize   = SmallestBlockIt->second.Size - AdjustedSize;
+        OffsetType NewOffset = Offset + AdjustedSize;
+        OffsetType NewSize   = SmallestBlockIt->second.Size - AdjustedSize;
         VERIFY_EXPR(SmallestBlockItIt == SmallestBlockIt->second.OrderBySizeIt);
         m_FreeBlocksBySize.erase(SmallestBlockItIt);
         m_FreeBlocksByOffset.erase(SmallestBlockIt);
@@ -401,8 +401,8 @@ class VariableSizeAllocationsManager
             auto LastBlockIt = m_FreeBlocksByOffset.end();
             --LastBlockIt;
 
-            const auto LastBlockOffset = LastBlockIt->first;
-            const auto LastBlockSize   = LastBlockIt->second.Size;
+            const OffsetType LastBlockOffset = LastBlockIt->first;
+            const OffsetType LastBlockSize   = LastBlockIt->second.Size;
             if (LastBlockOffset + LastBlockSize == m_MaxSize)
             {
                 // Extend the last block
diff --git a/Graphics/GraphicsAccessories/interface/VariableSizeGPUAllocationsManager.hpp b/Graphics/GraphicsAccessories/interface/VariableSizeGPUAllocationsManager.hpp
@@ -1,5 +1,5 @@
 /*
- *  Copyright 2019-2022 Diligent Graphics LLC
+ *  Copyright 2019-2025 Diligent Graphics LLC
  *  Copyright 2015-2019 Egor Yusov
  *
  *  Licensed under the Apache License, Version 2.0 (the "License");
@@ -27,7 +27,6 @@
 
 
 // An GPU-tailored extension of the basic variable-size allocations manager
-// See http://diligentgraphics.com/diligent-engine/architecture/d3d12/variable-size-memory-allocations-manager/
 
 #pragma once
 
@@ -36,6 +35,7 @@
 
 namespace Diligent
 {
+
 // Class extends basic variable-size memory block allocator by deferring deallocation
 // of freed blocks until the corresponding frame is completed
 class VariableSizeGPUAllocationsManager : public VariableSizeAllocationsManager
@@ -101,7 +101,7 @@ class VariableSizeGPUAllocationsManager : public VariableSizeAllocationsManager
         // Free all allocations from the beginning of the queue that belong to completed command lists
         while (!m_StaleAllocations.empty() && m_StaleAllocations.front().FenceValue <= LastCompletedFenceValue)
         {
-            auto& OldestAllocation = m_StaleAllocations.front();
+            StaleAllocationAttribs& OldestAllocation = m_StaleAllocations.front();
             VariableSizeAllocationsManager::Free(OldestAllocation.Offset, OldestAllocation.Size);
             m_StaleAllocationsSize -= OldestAllocation.Size;
             m_StaleAllocations.pop_front();
