vsg-dev · robertosfield · Jan 8, 2024 · Dec 7, 2023 · Dec 7, 2023 · Dec 7, 2023
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -1,7 +1,7 @@
 cmake_minimum_required(VERSION 3.7)
 
 project(vsg
-    VERSION 1.1.0
+    VERSION 1.1.1
     DESCRIPTION "VulkanSceneGraph library"
     LANGUAGES CXX
 )
@@ -37,6 +37,9 @@ find_package(Vulkan ${Vulkan_MIN_VERSION} REQUIRED)
 
 find_package(Threads REQUIRED)
 
+# Set the instrumentation level to compile into sources
+set(VSG_MAX_INSTRUMENTATION_LEVEL 1 CACHE STRING "Set the instrumentation level to build into the VSG ibrary, 0 for off, 1 coarse grained, 2 medium, 3 fine grained." )
+
 # Enable/disable shader compilation support that pulls in glslang
 set(VSG_SUPPORTS_ShaderCompiler  1 CACHE STRING "Optional shader compiler support, 0 for off, 1 for enabled." )
 if (VSG_SUPPORTS_ShaderCompiler)

diff --git a/cmake/build_all_h.cmake b/cmake/build_all_h.cmake
@@ -26,6 +26,9 @@ macro(BUILD_ALL_H)
     file(GLOB RAYTRACING_HEADERS RELATIVE ${INCLUDE_DIR} ${INCLUDE_DIR}/vsg/raytracing/*.h )
     file(GLOB MESHSHADERS_HEADERS RELATIVE ${INCLUDE_DIR} ${INCLUDE_DIR}/vsg/meshshaders/*.h )
 
+    # remove items that are inapprorpiate to include in all.h as they are optional have external dependencies not provided by the VSG itself.
+    list (REMOVE_ITEM UTILS_HEADERS "vsg/utils/TracyInstrumentation.h")
+
     file(READ ${VSG_SOURCE_DIR}/cmake/header_license_preamble.txt ALL_H_CONTENTS)
     APPEND_INCLUDES(ALL_H_CONTENTS CORE_HEADERS "// Core header files\n")
     APPEND_INCLUDES(ALL_H_CONTENTS MATHS_HEADERS "// Maths header files\n")

diff --git a/include/vsg/all.h b/include/vsg/all.h
@@ -64,6 +64,7 @@ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLI
 #include <vsg/nodes/DepthSorted.h>
 #include <vsg/nodes/Geometry.h>
 #include <vsg/nodes/Group.h>
+#include <vsg/nodes/InstrumentationNode.h>
 #include <vsg/nodes/LOD.h>
 #include <vsg/nodes/Light.h>
 #include <vsg/nodes/MatrixTransform.h>
@@ -257,7 +258,9 @@ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLI
 #include <vsg/utils/Builder.h>
 #include <vsg/utils/CommandLine.h>
 #include <vsg/utils/ComputeBounds.h>
+#include <vsg/utils/GpuAnnotation.h>
 #include <vsg/utils/GraphicsPipelineConfigurator.h>
+#include <vsg/utils/Instrumentation.h>
 #include <vsg/utils/Intersector.h>
 #include <vsg/utils/LineSegmentIntersector.h>
 #include <vsg/utils/LoadPagedLOD.h>

diff --git a/include/vsg/app/CommandGraph.h b/include/vsg/app/CommandGraph.h
@@ -17,6 +17,7 @@ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLI
 #include <vsg/core/Export.h>
 #include <vsg/nodes/Bin.h>
 #include <vsg/nodes/Group.h>
+#include <vsg/utils/Instrumentation.h>
 #include <vsg/vk/CommandBuffer.h>
 
 namespace vsg
@@ -41,18 +42,17 @@ namespace vsg
         uint32_t maxSlot = 2;
         int submitOrder = 0;
 
-        inline ref_ptr<RecordTraversal> getOrCreateRecordTraversal()
-        {
-            if (!recordTraversal) recordTraversal = RecordTraversal::create(maxSlot);
-            return recordTraversal;
-        }
+        ref_ptr<RecordTraversal> getOrCreateRecordTraversal();
 
         ref_ptr<RecordTraversal> recordTraversal;
 
         virtual VkCommandBufferLevel level() const;
         virtual void reset();
         virtual void record(ref_ptr<RecordedCommandBuffers> recordedCommandBuffers, ref_ptr<FrameStamp> frameStamp = {}, ref_ptr<DatabasePager> databasePager = {});
 
+        /// hook for assigning Instrumentation to enable profiling of record traversal.
+        ref_ptr<Instrumentation> instrumentation;
+
     protected:
         virtual ~CommandGraph();
 

diff --git a/include/vsg/app/CompileManager.h b/include/vsg/app/CompileManager.h
@@ -58,6 +58,9 @@ namespace vsg
         /// add a compile Context for all the Views assigned to a Viewer
         void add(const Viewer& viewer, const ResourceRequirements& resourceRequirements = {});
 
+        /// assign Instrumentation to all CompileTraversal and their associated Context
+        void assignInstrumentation(ref_ptr<Instrumentation> in_instrumentation);
+
         using ContextSelectionFunction = std::function<bool(vsg::Context&)>;
 
         /// compile object

diff --git a/include/vsg/app/CompileTraversal.h b/include/vsg/app/CompileTraversal.h
@@ -19,6 +19,7 @@ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLI
 #include <vsg/state/BufferInfo.h>
 #include <vsg/state/Descriptor.h>
 #include <vsg/state/ResourceHints.h>
+#include <vsg/utils/Instrumentation.h>
 #include <vsg/vk/CommandPool.h>
 #include <vsg/vk/Context.h>
 #include <vsg/vk/DescriptorPool.h>
@@ -45,6 +46,9 @@ namespace vsg
         /// list of Context that Vulkan objects should be compiled for.
         std::list<ref_ptr<Context>> contexts;
 
+        /// Hook for assigning Instrumentation to enable profiling
+        ref_ptr<Instrumentation> instrumentation;
+
         /// add a compile Context for device
         void add(ref_ptr<Device> device, const ResourceRequirements& resourceRequirements = {});
 
@@ -60,6 +64,11 @@ namespace vsg
         /// add a compile Context for all the Views assigned to a Viewer
         void add(const Viewer& viewer, const ResourceRequirements& resourceRequirements = {});
 
+        /// assign Instrumentation to all Context
+        void assignInstrumentation(ref_ptr<Instrumentation> in_instrumentation);
+
+        Instrumentation* getInstrumentation() override { return instrumentation.get(); }
+
         virtual bool record();
         virtual void waitForCompletion();
 

diff --git a/include/vsg/app/RecordAndSubmitTask.h b/include/vsg/app/RecordAndSubmitTask.h
@@ -17,6 +17,7 @@ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLI
 #include <vsg/app/Window.h>
 #include <vsg/io/DatabasePager.h>
 #include <vsg/nodes/Group.h>
+#include <vsg/utils/Instrumentation.h>
 #include <vsg/vk/CommandBuffer.h>
 
 namespace vsg
@@ -59,6 +60,12 @@ namespace vsg
 
         ref_ptr<DatabasePager> databasePager;
 
+        /// hook for assigning Instrumentation to enable profiling of record traversal.
+        ref_ptr<Instrumentation> instrumentation;
+
+        /// Convenience method for assigning Instrumentation to the viewer and any associated objects.
+        void assignInstrumentation(ref_ptr<Instrumentation> in_instrumentation);
+
     protected:
         size_t _currentFrameIndex;
         std::vector<size_t> _indices;

diff --git a/include/vsg/app/RecordTraversal.h b/include/vsg/app/RecordTraversal.h
@@ -35,6 +35,10 @@ namespace vsg
     class DepthSorted;
     class Transform;
     class MatrixTransform;
+    class TileDatabase;
+    class VertexDraw;
+    class VertexIndexDraw;
+    class Geometry;
     class Command;
     class Commands;
     class CommandBuffer;
@@ -53,6 +57,7 @@ namespace vsg
     class SpotLight;
     class CommandGraph;
     class RecordedCommandBuffers;
+    class Instrumentation;
 
     VSG_type_name(vsg::RecordTraversal);
 
@@ -77,6 +82,8 @@ namespace vsg
         Mask traversalMask = MASK_ALL;
         Mask overrideMask = MASK_OFF;
 
+        ref_ptr<Instrumentation> instrumentation;
+
         /// Container for CommandBuffers that have been recorded in current frame
         ref_ptr<RecordedCommandBuffers> recordedCommandBuffers;
 
@@ -102,11 +109,17 @@ namespace vsg
         void apply(const QuadGroup& quadGroup);
         void apply(const LOD& lod);
         void apply(const PagedLOD& pagedLOD);
+        void apply(const TileDatabase& tileDatabase);
         void apply(const CullGroup& cullGroup);
         void apply(const CullNode& cullNode);
         void apply(const DepthSorted& depthSorted);
         void apply(const Switch& sw);
 
+        // leaf node
+        void apply(const VertexDraw& vid);
+        void apply(const VertexIndexDraw& vid);
+        void apply(const Geometry& vid);
+
         // positional state
         void apply(const Light& light);
         void apply(const AmbientLight& light);
@@ -118,16 +131,20 @@ namespace vsg
         void apply(const Transform& transform);
         void apply(const MatrixTransform& mt);
         void apply(const StateGroup& object);
+
+        // Commands
         void apply(const Commands& commands);
         void apply(const Command& command);
 
         // Viewer level nodes
+        void apply(const Bin& bin);
         void apply(const View& view);
         void apply(const CommandGraph& commandGraph);
 
         // clear the bins to record a new frame.
         void clearBins();
 
+
     protected:
         virtual ~RecordTraversal();
 

diff --git a/include/vsg/app/TransferTask.h b/include/vsg/app/TransferTask.h
@@ -49,6 +49,9 @@ namespace vsg
         ref_ptr<Queue> transferQueue;
         ref_ptr<Semaphore> currentTransferCompletedSemaphore;
 
+        /// hook for assigning Instrumentation to enable profiling of record traversal.
+        ref_ptr<Instrumentation> instrumentation;
+
     protected:
         using OffsetBufferInfoMap = std::map<VkDeviceSize, ref_ptr<BufferInfo>>;
         using BufferMap = std::map<ref_ptr<Buffer>, OffsetBufferInfoMap>;

diff --git a/include/vsg/app/Viewer.h b/include/vsg/app/Viewer.h
@@ -19,6 +19,7 @@ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLI
 #include <vsg/app/Window.h>
 #include <vsg/threading/Barrier.h>
 #include <vsg/threading/FrameBlock.h>
+#include <vsg/utils/Instrumentation.h>
 
 #include <map>
 
@@ -133,6 +134,12 @@ namespace vsg
         /// Call vkDeviceWaitIdle on all the devices associated with this Viewer
         virtual void deviceWaitIdle() const;
 
+        /// Hook for assigning Instrumentation to enable profiling of record traversal.
+        ref_ptr<Instrumentation> instrumentation;
+
+        /// Convenience method for assigning Instrumentation to the viewer and any associated objects.
+        void assignInstrumentation(ref_ptr<Instrumentation> in_instrumentation);
+
     protected:
         virtual ~Viewer();
 

diff --git a/include/vsg/core/ConstVisitor.h b/include/vsg/core/ConstVisitor.h
@@ -47,6 +47,7 @@ namespace vsg
     class DirectionalLight;
     class PointLight;
     class SpotLight;
+    class InstrumentationNode;
 
     // forward declare text classes
     class Text;
@@ -142,6 +143,7 @@ namespace vsg
 
     // forward declare general classes
     class FrameStamp;
+    class Instrumentation;
 
     class VSG_DECLSPEC ConstVisitor : public Object
     {
@@ -151,6 +153,8 @@ namespace vsg
         Mask traversalMask = MASK_ALL;
         Mask overrideMask = MASK_OFF;
 
+        virtual Instrumentation* getInstrumentation() { return nullptr; }
+
         virtual void apply(const Object&);
         virtual void apply(const Objects&);
         virtual void apply(const External&);
@@ -302,6 +306,7 @@ namespace vsg
         virtual void apply(const DirectionalLight&);
         virtual void apply(const PointLight&);
         virtual void apply(const SpotLight&);
+        virtual void apply(const InstrumentationNode&);
 
         // text
         virtual void apply(const Text&);

diff --git a/include/vsg/core/Visitor.h b/include/vsg/core/Visitor.h
@@ -47,6 +47,7 @@ namespace vsg
     class DirectionalLight;
     class PointLight;
     class SpotLight;
+    class InstrumentationNode;
 
     // forward declare text classes
     class Text;
@@ -142,6 +143,7 @@ namespace vsg
 
     // forward declare general classes
     class FrameStamp;
+    class Instrumentation;
 
     class VSG_DECLSPEC Visitor : public Object
     {
@@ -151,6 +153,8 @@ namespace vsg
         Mask traversalMask = MASK_ALL;
         Mask overrideMask = MASK_OFF;
 
+        virtual Instrumentation* getInstrumentation() { return nullptr; }
+
         virtual void apply(Object&);
         virtual void apply(Objects&);
         virtual void apply(External&);
@@ -302,6 +306,7 @@ namespace vsg
         virtual void apply(DirectionalLight&);
         virtual void apply(PointLight&);
         virtual void apply(SpotLight&);
+        virtual void apply(InstrumentationNode&);
 
         // text
         virtual void apply(Text&);

diff --git a/include/vsg/io/DatabasePager.h b/include/vsg/io/DatabasePager.h
@@ -12,16 +12,14 @@ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLI
 
 </editor-fold> */
 
+#include <vsg/app/CompileManager.h>
 #include <vsg/core/Inherit.h>
 #include <vsg/core/observer_ptr.h>
 #include <vsg/io/FileSystem.h>
 #include <vsg/io/Options.h>
-
 #include <vsg/nodes/PagedLOD.h>
-
 #include <vsg/threading/ActivityStatus.h>
-
-#include <vsg/app/CompileManager.h>
+#include <vsg/utils/Instrumentation.h>
 
 #include <condition_variable>
 #include <list>
@@ -96,8 +94,6 @@ namespace vsg
 
         virtual void updateSceneGraph(FrameStamp* frameStamp, CompileResult& cr);
 
-        ref_ptr<const Options> options;
-
         ref_ptr<CompileManager> compileManager;
 
         std::atomic_uint numActiveRequests{0};
@@ -112,6 +108,12 @@ namespace vsg
 
         ref_ptr<PagedLODContainer> pagedLODContainer;
 
+        /// Hook for assigning Instrumentation to enable profiling
+        ref_ptr<Instrumentation> instrumentation;
+
+        /// assign Instrumentation to all CompileTraversal and their associated Context
+        void assignInstrumentation(ref_ptr<Instrumentation> in_instrumentation);
+
     protected:
         virtual ~DatabasePager();
 

diff --git a/include/vsg/io/Options.h b/include/vsg/io/Options.h
@@ -17,6 +17,7 @@ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLI
 #include <vsg/io/FileSystem.h>
 #include <vsg/maths/transform.h>
 #include <vsg/state/StateCommand.h>
+#include <vsg/utils/Instrumentation.h>
 
 namespace vsg
 {
@@ -96,6 +97,9 @@ namespace vsg
         /// scene graph creation routines can use the inherited state information to avoid setting state in the local subgraph.
         StateCommands inheritedState;
 
+        /// Hook for assigning Instrumentation to enable profiling of record traversal.
+        ref_ptr<Instrumentation> instrumentation;
+
     protected:
         virtual ~Options();
     };

diff --git a/include/vsg/maths/color.h b/include/vsg/maths/color.h
@@ -99,28 +99,28 @@ namespace vsg
     template<typename T>
     constexpr t_vec4<T> linear_to_sRGB(const t_vec4<T>& src)
     {
-        const T exponent = 2.2;
+        const T exponent = static_cast<T>(2.2);
         return t_vec4<T>(std::pow(src.r, exponent), std::pow(src.g, exponent), std::pow(src.b, exponent), src.a);
     }
 
     template<typename T>
     constexpr t_vec4<T> linear_to_sRGB(T r, T g, T b, T a)
     {
-        const T exponent = 2.2;
+        const T exponent = static_cast<T>(2.2);
         return t_vec4<T>(std::pow(r, exponent), std::pow(g, exponent), std::pow(b, exponent), a);
     }
 
     template<typename T>
     constexpr t_vec4<T> sRGB_to_linear(const t_vec4<T>& src)
     {
-        const T exponent = 1.0 / 2.2;
+        const T exponent = static_cast<T>(1.0 / 2.2);
         return t_vec4<T>(std::pow(src.r, exponent), std::pow(src.g, exponent), std::pow(src.b, exponent), src.a);
     }
 
     template<typename T>
     constexpr t_vec4<T> sRGB_to_linear(T r, T g, T b, T a)
     {
-        const T exponent = 1.0 / 2.2;
+        const T exponent = static_cast<T>(1.0 / 2.2);
         return t_vec4<T>(std::pow(r, exponent), std::pow(g, exponent), std::pow(b, exponent), a);
     }