Created dedicated InstanceDraw and InstanceDrawIndexed.

robertosfield · robertosfield · commit 1b4f2aecfc6c · 2025-06-13T11:32:48.000+01:00
diff --git a/include/vsg/all.h b/include/vsg/all.h
@@ -68,6 +68,7 @@ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLI
 #include <vsg/nodes/Geometry.h>
 #include <vsg/nodes/Group.h>
 #include <vsg/nodes/InstanceDraw.h>
+#include <vsg/nodes/InstanceDrawIndexed.h>
 #include <vsg/nodes/InstanceNode.h>
 #include <vsg/nodes/InstrumentationNode.h>
 #include <vsg/nodes/LOD.h>
diff --git a/include/vsg/core/ConstVisitor.h b/include/vsg/core/ConstVisitor.h
@@ -53,6 +53,7 @@ namespace vsg
     class RegionOfInterest;
     class InstanceNode;
     class InstanceDraw;
+    class InstanceDrawIndexed;
 
     // forward declare text classes
     class Text;
@@ -358,6 +359,7 @@ namespace vsg
         virtual void apply(const RegionOfInterest&);
         virtual void apply(const InstanceNode&);
         virtual void apply(const InstanceDraw&);
+        virtual void apply(const InstanceDrawIndexed&);
 
         // text
         virtual void apply(const Text&);
diff --git a/include/vsg/core/Visitor.h b/include/vsg/core/Visitor.h
@@ -53,6 +53,7 @@ namespace vsg
     class RegionOfInterest;
     class InstanceNode;
     class InstanceDraw;
+    class InstanceDrawIndexed;
 
     // forward declare text classes
     class Text;
@@ -358,6 +359,7 @@ namespace vsg
         virtual void apply(RegionOfInterest&);
         virtual void apply(InstanceNode&);
         virtual void apply(InstanceDraw&);
+        virtual void apply(InstanceDrawIndexed&);
 
         // text
         virtual void apply(Text&);
diff --git a/include/vsg/nodes/InstanceDraw.h b/include/vsg/nodes/InstanceDraw.h
@@ -19,26 +19,23 @@ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLI
 namespace vsg
 {
 
-    /** InstanceDraw provides a lightweight way of binding vertex arrays, indices and then issuing a vkCmdDrawIndexed command.
-      * Higher performance equivalent to use of individual vsg::BindVertexBuffers, vsg::BindIndexBuffer and vsg::DrawIndexed commands.*/
+    /** InstanceDraw provides a lightweight way of binding vertex arrays, indices and then issuing a vkCmdDraw command.
+      * Higher performance equivalent to use of individual vsg::BindVertexBuffers, vsg::BindIndexBuffer and vsg::Draw commands.*/
     class VSG_DECLSPEC InstanceDraw : public Inherit<Command, InstanceDraw>
     {
     public:
         InstanceDraw();
         InstanceDraw(const InstanceDraw& rhs, const CopyOp& copyop = {});
 
-        // vkCmdDrawIndexed settings
-        // vkCmdDrawIndexed(commandBuffer, indexCount, instanceCount, firstIndex, vertexOffset, firstInstance);
-        uint32_t indexCount = 0;
-        uint32_t firstIndex = 0;
-        uint32_t vertexOffset = 0;
+        // vkCmdDraw settings
+        // vkCmdDraw(commandBuffer, vertexCount, instanceCount, firstVertex, firstInstance);
+        uint32_t vertexCount = 0;
+        uint32_t firstVertex = 0;
 
         uint32_t firstBinding = 0;
         BufferInfoList arrays;
-        ref_ptr<BufferInfo> indices;
 
         void assignArrays(const DataList& in_arrays);
-        void assignIndices(ref_ptr<Data> in_indices);
 
     public:
         ref_ptr<Object> clone(const CopyOp& copyop = {}) const override { return InstanceDraw::create(*this, copyop); }
@@ -52,9 +49,6 @@ namespace vsg
 
     protected:
         virtual ~InstanceDraw();
-
-        vk_buffer<VulkanArrayData> _vulkanData;
-        VkIndexType indexType = VK_INDEX_TYPE_UINT16;
     };
     VSG_type_name(vsg::InstanceDraw)
 
diff --git a/include/vsg/nodes/InstanceDrawIndexed.h b/include/vsg/nodes/InstanceDrawIndexed.h
@@ -0,0 +1,60 @@
+#pragma once
+
+/* <editor-fold desc="MIT License">
+
+Copyright(c) 2018 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> */
+
+#include <vsg/commands/Command.h>
+#include <vsg/nodes/Node.h>
+#include <vsg/state/BufferInfo.h>
+
+namespace vsg
+{
+
+    /** InstanceDrawIndexed provides a lightweight way of binding vertex arrays, indices and then issuing a vkCmdDrawIndexed command.
+      * Higher performance equivalent to use of individual vsg::BindVertexBuffers, vsg::BindIndexBuffer and vsg::DrawIndexed commands.*/
+    class VSG_DECLSPEC InstanceDrawIndexed : public Inherit<Command, InstanceDrawIndexed>
+    {
+    public:
+        InstanceDrawIndexed();
+        InstanceDrawIndexed(const InstanceDrawIndexed& rhs, const CopyOp& copyop = {});
+
+        // vkCmdDrawIndexed settings
+        // vkCmdDrawIndexed(commandBuffer, indexCount, instanceCount, firstIndex, vertexOffset, firstInstance);
+        uint32_t indexCount = 0;
+        uint32_t firstIndex = 0;
+        uint32_t vertexOffset = 0;
+
+        uint32_t firstBinding = 0;
+        BufferInfoList arrays;
+        ref_ptr<BufferInfo> indices;
+
+        void assignArrays(const DataList& in_arrays);
+        void assignIndices(ref_ptr<Data> in_indices);
+
+    public:
+        ref_ptr<Object> clone(const CopyOp& copyop = {}) const override { return InstanceDrawIndexed::create(*this, copyop); }
+        int compare(const Object& rhs) const override;
+
+        void read(Input& input) override;
+        void write(Output& output) const override;
+
+        void compile(Context& context) override;
+        void record(CommandBuffer& commandBuffer) const override;
+
+    protected:
+        virtual ~InstanceDrawIndexed();
+
+        VkIndexType indexType = VK_INDEX_TYPE_UINT16;
+    };
+    VSG_type_name(vsg::InstanceDrawIndexed)
+
+} // namespace vsg
diff --git a/include/vsg/state/ArrayState.h b/include/vsg/state/ArrayState.h
@@ -76,6 +76,7 @@ namespace vsg
         void apply(const VertexIndexDraw& vid) override;
         void apply(const InstanceNode& in) override;
         void apply(const InstanceDraw& id) override;
+        void apply(const InstanceDrawIndexed& id) override;
         void apply(const BindVertexBuffers& bvb) override;
         void apply(const BufferInfo& bufferInfo) override;
 
diff --git a/include/vsg/utils/ComputeBounds.h b/include/vsg/utils/ComputeBounds.h
@@ -56,6 +56,7 @@ namespace vsg
         void apply(const VertexIndexDraw& vid) override;
         void apply(const InstanceNode& in) override;
         void apply(const InstanceDraw& id) override;
+        void apply(const InstanceDrawIndexed& id) override;
         void apply(const BindVertexBuffers& bvb) override;
         void apply(const BindIndexBuffer& bib) override;
         void apply(const StateCommand& statecommand) override;
diff --git a/src/vsg/CMakeLists.txt b/src/vsg/CMakeLists.txt
@@ -49,6 +49,7 @@ set(SOURCES
     nodes/RegionOfInterest.cpp
     nodes/InstanceNode.cpp
     nodes/InstanceDraw.cpp
+    nodes/InstanceDrawIndexed.cpp
 
     lighting/Light.cpp
     lighting/AmbientLight.cpp
diff --git a/src/vsg/core/ConstVisitor.cpp b/src/vsg/core/ConstVisitor.cpp
@@ -685,6 +685,10 @@ void ConstVisitor::apply(const InstanceDraw& value)
 {
     apply(static_cast<const Command&>(value));
 }
+void ConstVisitor::apply(const InstanceDrawIndexed& value)
+{
+    apply(static_cast<const Command&>(value));
+}
 
 ////////////////////////////////////////////////////////////////////////////////
 //
diff --git a/src/vsg/core/Visitor.cpp b/src/vsg/core/Visitor.cpp
@@ -685,6 +685,10 @@ void Visitor::apply(InstanceDraw& value)
 {
     apply(static_cast<Command&>(value));
 }
+void Visitor::apply(InstanceDrawIndexed& value)
+{
+    apply(static_cast<Command&>(value));
+}
 
 ////////////////////////////////////////////////////////////////////////////////
 //
diff --git a/src/vsg/io/ObjectFactory.cpp b/src/vsg/io/ObjectFactory.cpp
@@ -192,6 +192,7 @@ ObjectFactory::ObjectFactory()
     add<vsg::InstrumentationNode>();
     add<vsg::InstanceNode>();
     add<vsg::InstanceDraw>();
+    add<vsg::InstanceDrawIndexed>();
 
     // lighting
     add<vsg::Light>();
diff --git a/src/vsg/nodes/InstanceDraw.cpp b/src/vsg/nodes/InstanceDraw.cpp
@@ -25,12 +25,10 @@ InstanceDraw::InstanceDraw()
 
 InstanceDraw::InstanceDraw(const InstanceDraw& rhs, const CopyOp& copyop) :
     Inherit(rhs, copyop),
-    indexCount(rhs.indexCount),
-    firstIndex(rhs.firstIndex),
-    vertexOffset(rhs.vertexOffset),
+    vertexCount(rhs.vertexCount),
+    firstVertex(rhs.firstVertex),
     firstBinding(rhs.firstBinding),
-    arrays(copyop(rhs.arrays)),
-    indices(copyop(rhs.indices))
+    arrays(copyop(rhs.arrays))
 {
 }
 
@@ -44,12 +42,10 @@ int InstanceDraw::compare(const Object& rhs_object) const
     if (result != 0) return result;
 
     const auto& rhs = static_cast<decltype(*this)>(rhs_object);
-    if ((result = compare_value(indexCount, rhs.indexCount)) != 0) return result;
-    if ((result = compare_value(firstIndex, rhs.firstIndex)) != 0) return result;
-    if ((result = compare_value(vertexOffset, rhs.vertexOffset)) != 0) return result;
+    if ((result = compare_value(vertexCount, rhs.vertexCount)) != 0) return result;
+    if ((result = compare_value(firstVertex, rhs.firstVertex)) != 0) return result;
     if ((result = compare_value(firstBinding, rhs.firstBinding)) != 0) return result;
-    if ((result = compare_pointer_container(arrays, rhs.arrays)) != 0) return result;
-    return compare_pointer(indices, rhs.indices);
+    return compare_pointer_container(arrays, rhs.arrays);
 }
 
 void InstanceDraw::assignArrays(const DataList& arrayData)
@@ -62,23 +58,8 @@ void InstanceDraw::assignArrays(const DataList& arrayData)
     }
 }
 
-void InstanceDraw::assignIndices(ref_ptr<vsg::Data> indexData)
-{
-    if (indexData)
-    {
-        indices = BufferInfo::create(indexData);
-        indexType = computeIndexType(indices->data);
-    }
-    else
-    {
-        indices = {};
-    }
-}
-
 void InstanceDraw::read(Input& input)
 {
-    _vulkanData.clear();
-
     Command::read(input);
 
     input.read("firstBinding", firstBinding);
@@ -91,15 +72,9 @@ void InstanceDraw::read(Input& input)
     }
     assignArrays(dataList);
 
-    ref_ptr<vsg::Data> indices_data;
-    input.readObject("Indices", indices_data);
-
-    assignIndices(indices_data);
-
-    // vkCmdDrawIndexed settings
-    input.read("indexCount", indexCount);
-    input.read("firstIndex", firstIndex);
-    input.read("vertexOffset", vertexOffset);
+    // vkCmdDraw settings
+    input.read("vertexCount", vertexCount);
+    input.read("firstVertex", firstVertex);
 }
 
 void InstanceDraw::write(Output& output) const
@@ -116,15 +91,9 @@ void InstanceDraw::write(Output& output) const
             output.writeObject("Array", nullptr);
     }
 
-    if (indices)
-        output.writeObject("Indices", indices->data.get());
-    else
-        output.writeObject("Indices", nullptr);
-
     // vkCmdDrawIndexed settings
-    output.write("indexCount", indexCount);
-    output.write("firstIndex", firstIndex);
-    output.write("vertexOffset", vertexOffset);
+    output.write("vertexCount", vertexCount);
+    output.write("firstVertex", firstVertex);
 }
 
 void InstanceDraw::compile(Context& context)
@@ -138,34 +107,25 @@ void InstanceDraw::compile(Context& context)
     auto deviceID = context.deviceID;
 
     bool requiresCreateAndCopy = false;
-    if (indices && indices->requiresCopy(deviceID))
-        requiresCreateAndCopy = true;
-    else
+    for (auto& array : arrays)
     {
-        for (auto& array : arrays)
+        if (array->requiresCopy(deviceID))
         {
-            if (array->requiresCopy(deviceID))
-            {
-                requiresCreateAndCopy = true;
-                break;
-            }
+            requiresCreateAndCopy = true;
+            break;
         }
     }
 
     if (requiresCreateAndCopy)
     {
-        BufferInfoList combinedBufferInfos(arrays);
-        if (indices) combinedBufferInfos.push_back(indices);
-        createBufferAndTransferData(context, combinedBufferInfos, VK_BUFFER_USAGE_VERTEX_BUFFER_BIT | VK_BUFFER_USAGE_INDEX_BUFFER_BIT, VK_SHARING_MODE_EXCLUSIVE);
+        createBufferAndTransferData(context, arrays, VK_BUFFER_USAGE_VERTEX_BUFFER_BIT, VK_SHARING_MODE_EXCLUSIVE);
 
         // info("InstanceDraw::compile() create and copy ", this);
     }
     else
     {
         // info("InstanceDraw::compile() no need to create and copy ", this);
     }
-
-    assignVulkanArrayData(deviceID, arrays, _vulkanData[deviceID]);
 }
 
 void InstanceDraw::record(CommandBuffer& commandBuffer) const
@@ -205,17 +165,7 @@ void InstanceDraw::record(CommandBuffer& commandBuffer) const
     // TODO: will need to get the values to apply by combing the inherited InstanceNode values with local arrays
     vkCmdBindVertexBuffers(cmdBuffer, firstBinding, static_cast<uint32_t>(vkBuffers.size()), vkBuffers.data(), offsets.data());
 
-    if (indices)
-    {
-        // vsg::info("InstanceDraw::record(CommandBuffer& commandBuffer) vkCmdDrawIndexed vkBuffers.size() = ", vkBuffers.size(), ", indexCount = ", indexCount, ", instanceNode->instanceCount = ", instanceNode->instanceCount);
-
-        vkCmdBindIndexBuffer(cmdBuffer, indices->buffer->vk(deviceID), indices->offset, indexType);
-        vkCmdDrawIndexed(cmdBuffer, indexCount, instanceNode->instanceCount, firstIndex, vertexOffset, instanceNode->firstInstance);
-    }
-    else
-    {
-        // vsg::info("InstanceDraw::record(CommandBuffer& commandBuffer) vkCmdDraw vkBuffers.size() = ", vkBuffers.size(), ", indexCount = ", indexCount, ", instanceNode->instanceCount = ", instanceNode->instanceCount);
-        vkCmdDraw(cmdBuffer, indexCount, instanceNode->instanceCount, firstIndex, instanceNode->firstInstance);
-    }
+    // vsg::info("InstanceDraw::record(CommandBuffer& commandBuffer) vkCmdDraw vkBuffers.size() = ", vkBuffers.size(), ", vertexCount = ", vertexCount, ", instanceNode->instanceCount = ", instanceNode->instanceCount);
+    vkCmdDraw(cmdBuffer, vertexCount, instanceNode->instanceCount, firstVertex, instanceNode->firstInstance);
 
 }
diff --git a/src/vsg/nodes/InstanceDrawIndexed.cpp b/src/vsg/nodes/InstanceDrawIndexed.cpp
diff --git a/src/vsg/state/ArrayState.cpp b/src/vsg/state/ArrayState.cpp
diff --git a/src/vsg/utils/ComputeBounds.cpp b/src/vsg/utils/ComputeBounds.cpp

Original file line number	Diff line number	Diff line change
`@@ -685,6 +685,10 @@ void ConstVisitor::apply(const InstanceDraw& value)`
`685`	`685`	`{`
`686`	`686`	`apply(static_cast<const Command&>(value));`
`687`	`687`	`}`
	`688`	`+void ConstVisitor::apply(const InstanceDrawIndexed& value)`
	`689`	`+{`
	`690`	`+ apply(static_cast<const Command&>(value));`
	`691`	`+}`
`688`	`692`
`689`	`693`	`////////////////////////////////////////////////////////////////////////////////`
`690`	`694`	`//`
Original file line number	Diff line number	Diff line change
`@@ -685,6 +685,10 @@ void Visitor::apply(InstanceDraw& value)`
`685`	`685`	`{`
`686`	`686`	`apply(static_cast<Command&>(value));`
`687`	`687`	`}`
	`688`	`+void Visitor::apply(InstanceDrawIndexed& value)`
	`689`	`+{`
	`690`	`+ apply(static_cast<Command&>(value));`
	`691`	`+}`
`688`	`692`
`689`	`693`	`////////////////////////////////////////////////////////////////////////////////`
`690`	`694`	`//`