Introduced vsg::Slots struct for holding the max state and view slot numbers.

robertosfield · robertosfield · commit 097e488ecddd · 2025-04-02T14:51:44.000+01:00
diff --git a/include/vsg/app/CommandGraph.h b/include/vsg/app/CommandGraph.h
@@ -39,9 +39,8 @@ namespace vsg
 
         int queueFamily = -1;
         int presentFamily = -1;
-        uint32_t maxStateSlot = 0;
-        uint32_t maxViewSlot = 0;
         int submitOrder = 0;
+        Slots maxSlots;
 
         ref_ptr<RecordTraversal> getOrCreateRecordTraversal();
 
diff --git a/include/vsg/app/CompileManager.h b/include/vsg/app/CompileManager.h
@@ -27,8 +27,7 @@ namespace vsg
     {
         int result = VK_INCOMPLETE;
         std::string message;
-        uint32_t maxStateSlot = 0;
-        uint32_t maxViewSlot = 0;
+        Slots maxSlots;
         bool containsPagedLOD = false;
         ResourceRequirements::Views views;
         ResourceRequirements::DynamicData dynamicData;
diff --git a/include/vsg/app/RecordTraversal.h b/include/vsg/app/RecordTraversal.h
@@ -16,6 +16,7 @@ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLI
 #include <vsg/core/Object.h>
 #include <vsg/core/type_name.h>
 #include <vsg/maths/mat4.h>
+#include <vsg/vk/Slots.h>
 
 #include <set>
 #include <vector>
@@ -69,7 +70,7 @@ namespace vsg
     class VSG_DECLSPEC RecordTraversal : public Object
     {
     public:
-        explicit RecordTraversal(uint32_t in_maxStateSlot = 0, uint32_t in_maxViewSlot = 0, const std::set<Bin*>& in_bins = {});
+        explicit RecordTraversal(const Slots& in_maxSlots = {}, const std::set<Bin*>& in_bins = {});
 
         RecordTraversal(const RecordTraversal&) = delete;
         RecordTraversal& operator=(const RecordTraversal& rhs) = delete;
diff --git a/include/vsg/state/ResourceHints.h b/include/vsg/state/ResourceHints.h
@@ -30,16 +30,16 @@ namespace vsg
         DYNAMIC_VIEWPORTSTATE = 1 << 1
     };
 
+
     /// ResourceHints provides settings that help preallocation of Vulkan resources and memory.
     class VSG_DECLSPEC ResourceHints : public Inherit<Object, ResourceHints>
     {
     public:
         ResourceHints();
 
-        bool empty() const noexcept { return maxStateSlot == 0 && maxViewSlot == 0 && numDescriptorSets == 0 && descriptorPoolSizes.empty(); }
+        bool empty() const noexcept { return maxSlots.state == 0 && maxSlots.view == 0 && numDescriptorSets == 0 && descriptorPoolSizes.empty(); }
 
-        uint32_t maxStateSlot = 0;
-        uint32_t maxViewSlot = 0;
+        Slots maxSlots;
         uint32_t numDescriptorSets = 0;
         DescriptorPoolSizes descriptorPoolSizes;
 
diff --git a/include/vsg/vk/CommandBuffer.h b/include/vsg/vk/CommandBuffer.h
@@ -23,6 +23,7 @@ namespace vsg
     class ViewDependentState;
     class GPUStatsCollection;
 
+
     /// CommandBuffer encapsulates VkCommandBuffer
     class VSG_DECLSPEC CommandBuffer : public Inherit<Object, CommandBuffer>
     {
diff --git a/include/vsg/vk/ResourceRequirements.h b/include/vsg/vk/ResourceRequirements.h
@@ -88,8 +88,7 @@ namespace vsg
         Views views;
         ViewDetailStack viewDetailsStack;
 
-        uint32_t maxStateSlot = 0;
-        uint32_t maxViewSlot = 0;
+        Slots maxSlots;
         uint32_t externalNumDescriptorSets = 0;
         bool containsPagedLOD = false;
 
diff --git a/include/vsg/vk/Slots.h b/include/vsg/vk/Slots.h
@@ -0,0 +1,37 @@
+#pragma once
+
+/* <editor-fold desc="MIT License">
+
+Copyright(c) 2025 Robert Osfield
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+</editor-fold> */
+
+namespace vsg
+{
+
+    /// max slot values used for general state and view state related State::stateStacks
+    struct Slots
+    {
+        uint32_t state = 0;
+        uint32_t view = 0;
+
+        /// return maximum of the state and view slot numbers
+        uint32_t max() const
+        {
+            return view > state ? view : state;
+        }
+
+        void merge(const Slots& rhs)
+        {
+            if (rhs.state > state) state = rhs.state;
+            if (rhs.view > view) view = rhs.view;
+        }
+    };
+
+} // namespace vsg
diff --git a/include/vsg/vk/State.h b/include/vsg/vk/State.h
@@ -226,7 +226,7 @@ namespace vsg
     class State : public Inherit<Object, State>
     {
     public:
-        explicit State(uint32_t in_maxStateSlot, uint32_t in_maxViewSlot);
+        explicit State(const Slots& in_maxSlots);
 
         using StateCommandStack = StateStack<StateCommand>;
         using StateStacks = std::vector<StateCommandStack>;
@@ -246,9 +246,8 @@ namespace vsg
         dmat4 inheritedViewMatrix;
         dmat4 inheritedViewTransform;
 
+        Slots maxSlots;
         uint32_t activeMaxStateSlot = 0;
-        uint32_t maxStateSlot = 0;
-        uint32_t maxViewSlot = 0;
 
         StateStacks stateStacks;
 
@@ -257,7 +256,7 @@ namespace vsg
         MatrixStack projectionMatrixStack{0};
         MatrixStack modelviewMatrixStack{64};
 
-        void reserve(uint32_t in_maxStateSlot, uint32_t in_maxViewSlot);
+        void reserve(const Slots& in_maxSlots);
 
         void reset();
 
@@ -299,7 +298,7 @@ namespace vsg
                 }
 
                 // reset the active maxslot to the minimum required
-                activeMaxStateSlot = maxStateSlot;
+                activeMaxStateSlot = maxSlots.state;
 
                 projectionMatrixStack.record(*_commandBuffer);
                 modelviewMatrixStack.record(*_commandBuffer);
diff --git a/src/vsg/app/CommandGraph.cpp b/src/vsg/app/CommandGraph.cpp
@@ -66,9 +66,9 @@ ref_ptr<RecordTraversal> CommandGraph::getOrCreateRecordTraversal()
 {
     //CPU_INSTRUMENTATION_L1(instrumentation);
     if (!recordTraversal)
-        recordTraversal = RecordTraversal::create(maxStateSlot, maxViewSlot);
+        recordTraversal = RecordTraversal::create(maxSlots);
     else
-        recordTraversal->getState()->reserve(maxStateSlot, maxViewSlot);
+        recordTraversal->getState()->reserve(maxSlots);
 
     return recordTraversal;
 }
diff --git a/src/vsg/app/CompileManager.cpp b/src/vsg/app/CompileManager.cpp
@@ -24,8 +24,7 @@ using namespace vsg;
 void CompileResult::reset()
 {
     result = VK_INCOMPLETE;
-    maxStateSlot = 0;
-    maxViewSlot = 0;
+    maxSlots = {};
     containsPagedLOD = false;
     views.clear();
     dynamicData.clear();
@@ -38,8 +37,8 @@ void CompileResult::add(const CompileResult& cr)
         result = cr.result;
     }
 
-    if (cr.maxStateSlot > maxStateSlot) maxStateSlot = cr.maxStateSlot;
-    if (cr.maxViewSlot > maxViewSlot) maxViewSlot = cr.maxViewSlot;
+    maxSlots.merge(cr.maxSlots);
+
     if (!containsPagedLOD) containsPagedLOD = cr.containsPagedLOD;
 
     for (auto& [src_view, src_binDetails] : cr.views)
@@ -177,8 +176,7 @@ CompileResult CompileManager::compile(ref_ptr<Object> object, ContextSelectionFu
     auto& viewDetailsStack = requirements.viewDetailsStack;
 
     CompileResult result;
-    result.maxStateSlot = requirements.maxStateSlot;
-    result.maxViewSlot = requirements.maxViewSlot;
+    result.maxSlots = requirements.maxSlots;
     result.containsPagedLOD = requirements.containsPagedLOD;
     result.views = requirements.views;
     result.dynamicData = requirements.dynamicData;
diff --git a/src/vsg/app/CompileTraversal.cpp b/src/vsg/app/CompileTraversal.cpp
@@ -323,8 +323,7 @@ void CompileTraversal::apply(CommandGraph& commandGraph)
 
     for (const auto& context : contexts)
     {
-        if (context->resourceRequirements.maxStateSlot > commandGraph.maxStateSlot) commandGraph.maxStateSlot = context->resourceRequirements.maxStateSlot;
-        if (context->resourceRequirements.maxViewSlot > commandGraph.maxViewSlot) commandGraph.maxViewSlot = context->resourceRequirements.maxViewSlot;
+        commandGraph.maxSlots.merge(context->resourceRequirements.maxSlots);
     }
 
     commandGraph.traverse(*this);
@@ -338,8 +337,7 @@ void CompileTraversal::apply(SecondaryCommandGraph& secondaryCommandGraph)
 
     for (auto& context : contexts)
     {
-        if (context->resourceRequirements.maxStateSlot > secondaryCommandGraph.maxStateSlot) secondaryCommandGraph.maxStateSlot = context->resourceRequirements.maxStateSlot;
-        if (context->resourceRequirements.maxViewSlot > secondaryCommandGraph.maxViewSlot) secondaryCommandGraph.maxViewSlot = context->resourceRequirements.maxViewSlot;
+        secondaryCommandGraph.maxSlots.merge(context->resourceRequirements.maxSlots);
 
         // save previous states to be restored after traversal
         auto previousRenderPass = context->renderPass;
diff --git a/src/vsg/app/RecordAndSubmitTask.cpp b/src/vsg/app/RecordAndSubmitTask.cpp
@@ -298,8 +298,7 @@ void vsg::updateTasks(RecordAndSubmitTasks& tasks, ref_ptr<CompileManager> compi
     {
         for (const auto& commandGraph : task->commandGraphs)
         {
-            if (compileResult.maxStateSlot > commandGraph->maxStateSlot) commandGraph->maxStateSlot = compileResult.maxStateSlot;
-            if (compileResult.maxViewSlot > commandGraph->maxViewSlot) commandGraph->maxViewSlot = compileResult.maxViewSlot;
+            commandGraph->maxSlots.merge(compileResult.maxSlots);
         }
     }
 
diff --git a/src/vsg/app/RecordTraversal.cpp b/src/vsg/app/RecordTraversal.cpp
@@ -56,8 +56,8 @@ using namespace vsg;
 
 #define INLINE_TRAVERSE 0
 
-RecordTraversal::RecordTraversal(uint32_t in_maxStateSlot, uint32_t in_maxViewSlot, const std::set<Bin*>& in_bins) :
-    _state(new State(in_maxStateSlot, in_maxViewSlot))
+RecordTraversal::RecordTraversal(const Slots& in_maxSlots, const std::set<Bin*>& in_bins) :
+    _state(new State(in_maxSlots))
 {
     CPU_INSTRUMENTATION_L1_C(instrumentation, COLOR_RECORD);
 
diff --git a/src/vsg/app/Viewer.cpp b/src/vsg/app/Viewer.cpp
@@ -361,8 +361,7 @@ void Viewer::compile(ref_ptr<ResourceHints> hints)
 
         for (const auto& commandGraph : task->commandGraphs)
         {
-            commandGraph->maxStateSlot = resourceRequirements.maxStateSlot;
-            commandGraph->maxViewSlot = resourceRequirements.maxViewSlot;
+            commandGraph->maxSlots = resourceRequirements.maxSlots;
             if (resourceRequirements.containsPagedLOD) task_containsPagedLOD = true;
         }
 
diff --git a/src/vsg/state/ResourceHints.cpp b/src/vsg/state/ResourceHints.cpp
@@ -28,12 +28,13 @@ void ResourceHints::read(Input& input)
 
     if (input.version_greater_equal(1, 1, 11))
     {
-        input.read("maxStateSlot", maxStateSlot);
-        input.read("maxViewSlot", maxViewSlot);
+        input.read("maxSlots.state", maxSlots.state);
+        input.read("maxSlots.view", maxSlots.view);
     }
     else
     {
-        input.read("maxSlot", maxStateSlot);
+        input.read("maxSlot", maxSlots.state);
+        maxSlots.view = maxSlots.state;
     }
 
     input.read("numDescriptorSets", numDescriptorSets);
@@ -82,12 +83,12 @@ void ResourceHints::write(Output& output) const
 
     if (output.version_greater_equal(1, 1, 11))
     {
-        output.write("maxStateSlot", maxStateSlot);
-        output.write("maxViewSlot", maxViewSlot);
+        output.write("maxSlots.state", maxSlots.state);
+        output.write("maxSlots.view", maxSlots.view);
     }
     else
     {
-        output.write("maxSlot", maxStateSlot);
+        output.write("maxSlot", maxSlots.state);
     }
 
     output.write("numDescriptorSets", numDescriptorSets);
diff --git a/src/vsg/state/ViewDependentState.cpp b/src/vsg/state/ViewDependentState.cpp
@@ -425,8 +425,7 @@ void ViewDependentState::update(ResourceRequirements& requirements)
 {
     if (preRenderCommandGraph)
     {
-        if (requirements.maxStateSlot > preRenderCommandGraph->maxStateSlot) preRenderCommandGraph->maxStateSlot = requirements.maxStateSlot;
-        if (requirements.maxViewSlot > preRenderCommandGraph->maxViewSlot) preRenderCommandGraph->maxViewSlot = requirements.maxViewSlot;
+        preRenderCommandGraph->maxSlots.merge(requirements.maxSlots);
     }
 }
 
diff --git a/src/vsg/vk/Context.cpp b/src/vsg/vk/Context.cpp
@@ -197,8 +197,7 @@ void Context::reserve(const ResourceRequirements& requirements)
 {
     CPU_INSTRUMENTATION_L2_NC(instrumentation, "Context reserve", COLOR_COMPILE)
 
-    if (requirements.maxStateSlot > resourceRequirements.maxStateSlot) resourceRequirements.maxStateSlot = requirements.maxStateSlot;
-    if (requirements.maxViewSlot > resourceRequirements.maxViewSlot) resourceRequirements.maxViewSlot = requirements.maxViewSlot;
+    resourceRequirements.maxSlots.merge(requirements.maxSlots);
 
     descriptorPools->reserve(requirements);
 }
diff --git a/src/vsg/vk/ResourceRequirements.cpp b/src/vsg/vk/ResourceRequirements.cpp
@@ -64,8 +64,7 @@ DescriptorPoolSizes ResourceRequirements::computeDescriptorPoolSizes() const
 
 void ResourceRequirements::apply(const ResourceHints& resourceHints)
 {
-    if (resourceHints.maxStateSlot > maxStateSlot) maxStateSlot = resourceHints.maxStateSlot;
-    if (resourceHints.maxViewSlot > maxViewSlot) maxViewSlot = resourceHints.maxViewSlot;
+    maxSlots.merge(resourceHints.maxSlots);
 
     if (!resourceHints.descriptorPoolSizes.empty() || resourceHints.numDescriptorSets > 0)
     {
@@ -97,8 +96,7 @@ ref_ptr<ResourceHints> CollectResourceRequirements::createResourceHints(uint32_t
 {
     auto resourceHints = vsg::ResourceHints::create();
 
-    resourceHints->maxStateSlot = requirements.maxStateSlot;
-    resourceHints->maxViewSlot = requirements.maxViewSlot;
+    resourceHints->maxSlots = requirements.maxSlots;
     resourceHints->numDescriptorSets = static_cast<uint32_t>(requirements.computeNumDescriptorSets() * tileMultiplier);
     resourceHints->descriptorPoolSizes = requirements.computeDescriptorPoolSizes();
 
@@ -157,7 +155,7 @@ void CollectResourceRequirements::apply(const PagedLOD& plod)
 
 void CollectResourceRequirements::apply(const StateCommand& stateCommand)
 {
-    if (stateCommand.slot > requirements.maxStateSlot) requirements.maxStateSlot = stateCommand.slot;
+    if (stateCommand.slot > requirements.maxSlots.state) requirements.maxSlots.state = stateCommand.slot;
     stateCommand.traverse(*this);
 }
 
@@ -216,15 +214,15 @@ void CollectResourceRequirements::apply(const Light& light)
 
 void CollectResourceRequirements::apply(const RenderGraph& rg)
 {
-    if (rg.viewportState) requirements.maxViewSlot = std::max(requirements.maxViewSlot, rg.viewportState->slot);
+    if (rg.viewportState) requirements.maxSlots.view = std::max(requirements.maxSlots.view, rg.viewportState->slot);
     rg.traverse(*this);
 }
 
 void CollectResourceRequirements::apply(const View& view)
 {
     if (view.camera && view.camera->viewportState)
     {
-        requirements.maxViewSlot = std::max(requirements.maxViewSlot, view.camera->viewportState->slot);
+        requirements.maxSlots.view = std::max(requirements.maxSlots.view, view.camera->viewportState->slot);
     }
 
     if (auto itr = requirements.views.find(&view); itr != requirements.views.end())
diff --git a/src/vsg/vk/State.cpp b/src/vsg/vk/State.cpp
@@ -16,17 +16,16 @@ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLI
 
 using namespace vsg;
 
-State::State(uint32_t in_maxStateSlot, uint32_t in_maxViewSlot) :
+State::State(const Slots& in_maxSlots) :
     dirty(false)
 {
-    reserve(in_maxStateSlot, in_maxViewSlot);
+    reserve(in_maxSlots);
 }
 
-void State::reserve(uint32_t in_maxStateSlot, uint32_t in_maxViewSlot)
+void State::reserve(const Slots& in_maxSlots)
 {
-    maxStateSlot = in_maxStateSlot;
-    maxViewSlot = in_maxViewSlot;
-    activeMaxStateSlot = std::max(maxViewSlot, maxStateSlot);
+    maxSlots = in_maxSlots;
+    activeMaxStateSlot = maxSlots.max();
 
     size_t required_size = static_cast<size_t>(activeMaxStateSlot) + 1;
     if (required_size > stateStacks.size()) stateStacks.resize(required_size);
@@ -42,19 +41,19 @@ void State::reset()
         stateStack.reset();
     }
 
-    activeMaxStateSlot = std::max(maxViewSlot, maxStateSlot);
+    activeMaxStateSlot = maxSlots.max();
 }
 
 void State::pushView(ref_ptr<StateCommand> command)
 {
     stateStacks[command->slot].push(command);
-    activeMaxStateSlot = std::max(maxViewSlot, maxStateSlot);
+    activeMaxStateSlot = maxSlots.max();
 }
 
 void State::popView(ref_ptr<StateCommand> command)
 {
     stateStacks[command->slot].pop();
-    activeMaxStateSlot = std::max(maxViewSlot, maxStateSlot);
+    activeMaxStateSlot = maxSlots.max();
 }
 
 void State::pushView(const View& view)

Original file line number	Diff line number	Diff line change
`@@ -23,6 +23,7 @@ namespace vsg`
`23`	`23`	`class ViewDependentState;`
`24`	`24`	`class GPUStatsCollection;`
`25`	`25`
	`26`	`+`
`26`	`27`	`/// CommandBuffer encapsulates VkCommandBuffer`
`27`	`28`	`class VSG_DECLSPEC CommandBuffer : public Inherit<Object, CommandBuffer>`
`28`	`29`	`{`
Original file line number	Diff line number	Diff line change
`@@ -66,9 +66,9 @@ ref_ptr<RecordTraversal> CommandGraph::getOrCreateRecordTraversal()`
`66`	`66`	`{`
`67`	`67`	`//CPU_INSTRUMENTATION_L1(instrumentation);`
`68`	`68`	`if (!recordTraversal)`
`69`		`- recordTraversal = RecordTraversal::create(maxStateSlot, maxViewSlot);`
	`69`	`+ recordTraversal = RecordTraversal::create(maxSlots);`
`70`	`70`	`else`
`71`		`- recordTraversal->getState()->reserve(maxStateSlot, maxViewSlot);`
	`71`	`+ recordTraversal->getState()->reserve(maxSlots);`
`72`	`72`
`73`	`73`	`return recordTraversal;`
`74`	`74`	`}`