Default use of dynamic ViewportState.

CMakeLists.txt

@@ -1,7 +1,7 @@
 cmake_minimum_required(VERSION 3.7)
 
 project(vsg
-    VERSION 1.1.10
+    VERSION 1.1.11
     DESCRIPTION "VulkanSceneGraph library"
     LANGUAGES CXX
 )

cmake/cppcheck-suppression-list.txt

@@ -29,6 +29,7 @@ useStlAlgorithm:*/src/vsg/nodes/VertexIndexDraw.cpp
 useStlAlgorithm:*/src/vsg/nodes/Switch.cpp
 useStlAlgorithm:*/src/vsg/nodes/LOD.cpp
 useStlAlgorithm:*/src/vsg/state/DescriptorBuffer.cpp
+useStlAlgorithm:*/src/vsg/state/GraphicsPipeline.cpp
 useStlAlgorithm:*/src/vsg/state/PipelineLayout.cpp
 useStlAlgorithm:*/src/vsg/state/StateSwitch.cpp
 useStlAlgorithm:*/src/vsg/state/ViewDependentState.cpp
@@ -60,7 +61,6 @@ useStlAlgorithm:*/src/vsg/io/Path.cpp
 useStlAlgorithm:*/src/vsg/utils/PolytopeIntersector.cpp
 useStlAlgorithm:*/src/vsg/vk/PhysicalDevice.cpp
 
-
 // suppress the warning about valid C++17 if (init; condition) usage
 syntaxError:*/include/vsg/core/Inherit.h
 syntaxError:*/src/vsg/io/AsciiOutput.cpp

include/vsg/app/RenderGraph.h

@@ -47,9 +47,12 @@ namespace vsg
         /// Get the Extent2D of the attached Framebuffer or Window.
         VkExtent2D getExtent() const;
 
-        /// RenderArea settings for VkRenderPassBeginInfo.renderArea passed to the vkCmdBeginRenderPass, usually matches the ViewportState's scissor
+        /// RenderArea settings for VkRenderPassBeginInfo.renderArea passed to the vkCmdBeginRenderPass
         VkRect2D renderArea;
 
+        // Default ViewportState to use for graphics pipelines under this RenderGraph, this be will synced with the renderArea.
+        ref_ptr<ViewportState> viewportState;
+
         /// RenderPass to use passed to the vkCmdBeginRenderPass in place of the framebuffer's or window's renderPass. renderPass must be compatible with the render pass used to create the window or framebuffer.
         ref_ptr<RenderPass> renderPass;
 

include/vsg/app/WindowResizeHandler.h

@@ -23,6 +23,7 @@ namespace vsg
 
     /// Utility class for updating a scene graph when a View's camera ViewportState has been updated so that associated GraphicsPipelines in the
     /// scene graph can be recompiled and correctly reflect the new ViewportState.
+    /// As viewport size and scissor is dynamic by default, this is only necessary when opting out of that or when the viewport count has changed.
     class VSG_DECLSPEC UpdateGraphicsPipelines : public Inherit<Visitor, UpdateGraphicsPipelines>
     {
     public:
@@ -43,7 +44,6 @@ namespace vsg
     class VSG_DECLSPEC WindowResizeHandler : public Inherit<Visitor, WindowResizeHandler>
     {
     public:
-        ref_ptr<Context> context;
         VkRect2D renderArea;
         VkExtent2D previous_extent;
         VkExtent2D new_extent;
@@ -63,7 +63,6 @@ namespace vsg
         /// return true if the object was visited
         bool visit(const Object* object, uint32_t index = 0);
 
-        void apply(BindGraphicsPipeline& bindPipeline) override;
         void apply(Object& object) override;
         void apply(ClearAttachments& clearAttachments) override;
         void apply(View& view) override;

include/vsg/io/stream.h

@@ -287,12 +287,12 @@ namespace vsg
 
     inline std::istream& operator>>(std::istream& input, CoordinateSpace& coordinateSpace)
     {
-        std::string value;
-        input >> value;
+        std::string str;
+        input >> str;
 
-        if (value == "LINEAR")
+        if (str == "LINEAR")
             coordinateSpace = CoordinateSpace::LINEAR;
-        else if (value == "sRGB")
+        else if (str == "sRGB")
             coordinateSpace = CoordinateSpace::sRGB;
         else
             coordinateSpace = CoordinateSpace::NO_PREFERENCE;

include/vsg/state/DynamicState.h

@@ -18,6 +18,7 @@ namespace vsg
 {
 
     /// DynamicState encapsulates VkPipelineDynamicStateCreateInfo settings passed when setting up GraphicsPipeline
+    /// By default, viewport and scissor are set to dynamic
     class VSG_DECLSPEC DynamicState : public Inherit<GraphicsPipelineState, DynamicState>
     {
     public:

include/vsg/state/GraphicsPipeline.h

@@ -25,7 +25,7 @@ namespace vsg
     /// Base class for setting up the various pipeline states with the VkGraphicsPipelineCreateInfo
     /// Subclasses are ColorBlendState, DepthStencilState, DynamicState, InputAssemblyState,
     /// MultisampleState, RasterizationState, TessellationState, VertexInputState and ViewportState.
-    class VSG_DECLSPEC GraphicsPipelineState : public Inherit<Object, GraphicsPipelineState>
+    class VSG_DECLSPEC GraphicsPipelineState : public Inherit<StateCommand, GraphicsPipelineState>
     {
     public:
         GraphicsPipelineState() {}
@@ -36,6 +36,7 @@ namespace vsg
         Mask mask = MASK_ALL;
 
         virtual void apply(Context& context, VkGraphicsPipelineCreateInfo& pipelineInfo) const = 0;
+        void record(CommandBuffer&) const override {};
 
     public:
         int compare(const Object& rhs) const override;
@@ -95,6 +96,7 @@ namespace vsg
 
             virtual ~Implementation();
 
+            GraphicsPipelineStates _pipelineStates;
             VkPipeline _pipeline;
 
             ref_ptr<Device> _device;

include/vsg/state/ViewportState.h

@@ -51,6 +51,9 @@ namespace vsg
         void write(Output& output) const override;
         void apply(Context& context, VkGraphicsPipelineCreateInfo& pipelineInfo) const override;
 
+        /// enable ViewportState to be recorded via vkCmdSetScissor and vkCmdSetViewport
+        void record(CommandBuffer& commandBuffer) const override;
+
     protected:
         virtual ~ViewportState();
     };

include/vsg/vk/ResourceRequirements.h

@@ -130,6 +130,7 @@ namespace vsg
         void apply(const DescriptorImage& descriptorImage) override;
         void apply(const PagedLOD& plod) override;
         void apply(const Light& light) override;
+        void apply(const RenderGraph& rg) override;
         void apply(const View& view) override;
         void apply(const DepthSorted& depthSorted) override;
         void apply(const Layer& layer) override;

include/vsg/vk/State.h

@@ -299,6 +299,36 @@ namespace vsg
             }
         }
 
+        inline void push(const StateCommands& commands)
+        {
+            for (auto& command : commands)
+            {
+                stateStacks[command->slot].push(command);
+            }
+            dirty = true;
+        }
+
+        inline void pop(const StateCommands& commands)
+        {
+            for (const auto& command : commands)
+            {
+                stateStacks[command->slot].pop();
+            }
+            dirty = true;
+        }
+
+        inline void push(ref_ptr<StateCommand> command)
+        {
+            stateStacks[command->slot].push(command);
+            dirty = true;
+        }
+
+        inline void pop(ref_ptr<StateCommand> command)
+        {
+            stateStacks[command->slot].pop();
+            dirty = true;
+        }
+
         inline void pushFrustum()
         {
             _frustumStack.push(Frustum(_frustumProjected, modelviewMatrixStack.top()));

src/vsg/app/CompileTraversal.cpp

@@ -386,15 +386,9 @@ void CompileTraversal::apply(RenderGraph& renderGraph)
         auto previousDefaultPipelineStates = context->defaultPipelineStates;
         auto previousOverridePipelineStates = context->overridePipelineStates;
 
+        mergeGraphicsPipelineStates(context->mask, context->defaultPipelineStates, renderGraph.viewportState);
+
         context->renderPass = renderGraph.getRenderPass();
-        if (renderGraph.window)
-        {
-            mergeGraphicsPipelineStates(context->mask, context->defaultPipelineStates, ViewportState::create(renderGraph.window->extent2D()));
-        }
-        else if (renderGraph.framebuffer)
-        {
-            mergeGraphicsPipelineStates(context->mask, context->defaultPipelineStates, ViewportState::create(renderGraph.framebuffer->extent2D()));
-        }
 
         if (context->renderPass)
         {
@@ -438,7 +432,7 @@ void CompileTraversal::apply(View& view)
         }
 
         // assign view specific pipeline states
-        if (view.camera && view.camera->viewportState) mergeGraphicsPipelineStates(context->mask, context->defaultPipelineStates, view.camera->viewportState);
+        mergeGraphicsPipelineStates(context->mask, context->defaultPipelineStates, view.camera->viewportState);
         mergeGraphicsPipelineStates(context->mask, context->overridePipelineStates, view.overridePipelineStates);
 
         view.traverse(*this);

src/vsg/app/RecordTraversal.cpp

@@ -484,19 +484,11 @@ void RecordTraversal::apply(const StateGroup& stateGroup)
 
     //debug("Visiting StateGroup");
 
-    for (auto& command : stateGroup.stateCommands)
-    {
-        _state->stateStacks[command->slot].push(command);
-    }
-    _state->dirty = true;
+    _state->push(stateGroup.stateCommands);
 
     stateGroup.traverse(*this);
 
-    for (const auto& command : stateGroup.stateCommands)
-    {
-        _state->stateStacks[command->slot].pop();
-    }
-    _state->dirty = true;
+    _state->pop(stateGroup.stateCommands);
 }
 
 void RecordTraversal::apply(const Commands& commands)
@@ -575,27 +567,40 @@ void RecordTraversal::apply(const View& view)
         _state->inheritViewForLODScaling = (view.features & INHERIT_VIEWPOINT) != 0;
         _state->setProjectionAndViewMatrix(view.camera->projectionMatrix->transform(), view.camera->viewMatrix->transform());
 
-        if (_viewDependentState && _viewDependentState->viewportData && view.camera->viewportState)
+        if (const auto& viewportState = view.camera->viewportState)
         {
-            auto& viewportData = _viewDependentState->viewportData;
-            auto& viewports = view.camera->viewportState->viewports;
+            _state->push(viewportState);
 
-            auto dest_itr = viewportData->begin();
-            for (auto src_itr = viewports.begin();
-                 dest_itr != viewportData->end() && src_itr != viewports.end();
-                 ++dest_itr, ++src_itr)
+            if (_viewDependentState)
             {
-                auto& dest_viewport = *dest_itr;
-                vec4 src_viewport(src_itr->x, src_itr->y, src_itr->width, src_itr->height);
-                if (dest_viewport != src_viewport)
+                auto& viewportData = _viewDependentState->viewportData;
+                if (viewportData)
                 {
-                    dest_viewport = src_viewport;
-                    viewportData->dirty();
+                    auto& viewports = viewportState->viewports;
+                    auto dest_itr = viewportData->begin();
+                    for (auto src_itr = viewports.begin();
+                         dest_itr != viewportData->end() && src_itr != viewports.end();
+                         ++dest_itr, ++src_itr)
+                    {
+                        auto& dest_viewport = *dest_itr;
+                        vec4 src_viewport(src_itr->x, src_itr->y, src_itr->width, src_itr->height);
+                        if (dest_viewport != src_viewport)
+                        {
+                            dest_viewport = src_viewport;
+                            viewportData->dirty();
+                        }
+                    }
                 }
             }
-        }
 
-        view.traverse(*this);
+            view.traverse(*this);
+
+            _state->pop(viewportState);
+        }
+        else
+        {
+            view.traverse(*this);
+        }
     }
     else
     {

src/vsg/app/RenderGraph.cpp

@@ -22,14 +22,15 @@ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLI
 using namespace vsg;
 
 RenderGraph::RenderGraph() :
+    viewportState(ViewportState::create()),
     windowResizeHandler(WindowResizeHandler::create())
 {
 }
 
 RenderGraph::RenderGraph(ref_ptr<Window> in_window, ref_ptr<View> in_view) :
-    window(in_window),
-    windowResizeHandler(WindowResizeHandler::create())
+    RenderGraph()
 {
+    window = in_window;
 
     if (in_view)
     {
@@ -48,6 +49,8 @@ RenderGraph::RenderGraph(ref_ptr<Window> in_window, ref_ptr<View> in_view) :
         renderArea.extent = window->extent2D();
     }
 
+    viewportState->set(renderArea.offset.x, renderArea.offset.y, renderArea.extent.width, renderArea.extent.height);
+
     // set up the clearValues based on the RenderPass's attachments.
     setClearValues(window->clearColor(), VkClearDepthStencilValue{0.0f, 0});
 }
@@ -144,9 +147,15 @@ void RenderGraph::accept(RecordTraversal& recordTraversal) const
     VkCommandBuffer vk_commandBuffer = *(recordTraversal.getState()->_commandBuffer);
     vkCmdBeginRenderPass(vk_commandBuffer, &renderPassInfo, contents);
 
+    // sync the viewportState and push
+    viewportState->set(renderArea.offset.x, renderArea.offset.y, renderArea.extent.width, renderArea.extent.height);
+    recordTraversal.getState()->push(viewportState);
+
     // traverse the subgraph to place commands into the command buffer.
     traverse(recordTraversal);
 
+    recordTraversal.getState()->pop(viewportState);
+
     vkCmdEndRenderPass(vk_commandBuffer);
 }
 
@@ -155,30 +164,15 @@ void RenderGraph::resized()
     if (!windowResizeHandler) return;
     if (!window && !framebuffer) return;
 
-    auto activeRenderPass = getRenderPass();
-    if (!activeRenderPass) return;
-
-    auto device = activeRenderPass->device;
-
-    if (!windowResizeHandler->context) windowResizeHandler->context = vsg::Context::create(device);
+    if (!getRenderPass()) return;
 
     auto extent = getExtent();
 
-    windowResizeHandler->context->commandPool = nullptr;
-    windowResizeHandler->context->renderPass = activeRenderPass;
     windowResizeHandler->renderArea = renderArea;
     windowResizeHandler->previous_extent = previous_extent;
     windowResizeHandler->new_extent = extent;
     windowResizeHandler->visited.clear();
 
-    if (activeRenderPass->maxSamples != VK_SAMPLE_COUNT_1_BIT)
-    {
-        windowResizeHandler->context->overridePipelineStates.emplace_back(vsg::MultisampleState::create(activeRenderPass->maxSamples));
-    }
-
-    // make sure the device is idle before we recreate any Vulkan objects
-    vkDeviceWaitIdle(*(device));
-
     traverse(*windowResizeHandler);
 
     windowResizeHandler->scale_rect(renderArea);