Added vstracyinstrumentation example and vsg::GpuInstrumentation support to vsgviewer

CMakeLists.txt

@@ -1,7 +1,7 @@
 cmake_minimum_required(VERSION 3.7)
 
 project(vsgExamples
-        VERSION 1.1.0
+        VERSION 1.1.1
         DESCRIPTION "Set of example programs that test and illustrate how to use the VulkanSceneGraph"
         LANGUAGES CXX C
 )
@@ -21,7 +21,7 @@ if (VULKAN_SDK)
     set(ENV{VULKAN_SDK} ${VULKAN_SDK})
 endif()
 
-find_package(vsg 1.1.0)
+find_package(vsg 1.1.1)
 
 vsg_setup_dir_vars()
 vsg_setup_build_vars()
@@ -32,6 +32,8 @@ find_package(vsgXchange 1.0.5 QUIET)
 # find the optional vsgImGui that can be used for GUI elements added into graphics windows.
 find_package(vsgImGui QUIET)
 
+find_package(Tracy QUIET)
+
 # set the use of C++17 globally as all examples require it
 set(CMAKE_CXX_STANDARD 17)
 

examples/app/vsgviewer/vsgviewer.cpp

@@ -118,6 +118,20 @@ int main(int argc, char** argv)
 
         if (int log_level = 0; arguments.read("--log-level", log_level)) vsg::Logger::instance()->level = vsg::Logger::Level(log_level);
 
+        vsg::ref_ptr<vsg::Instrumentation> instrumentation;
+        if (arguments.read({"--gpu-annotation", "--ga"}) && vsg::isExtensionSupported(VK_EXT_DEBUG_UTILS_EXTENSION_NAME))
+        {
+            windowTraits->debugUtils = true;
+
+            auto gpu_instrumentation = vsg::GpuAnnotation::create();
+            if (arguments.read("--name")) gpu_instrumentation->labelType = vsg::GpuAnnotation::SourceLocation_name;
+            else if (arguments.read("--className")) gpu_instrumentation->labelType = vsg::GpuAnnotation::Object_className;
+            else if (arguments.read("--func")) gpu_instrumentation->labelType = vsg::GpuAnnotation::SourceLocation_function;
+
+            instrumentation = gpu_instrumentation;
+        }
+
+
         if (arguments.errors()) return arguments.writeErrorMessages(std::cerr);
 
         if (argc <= 1)
@@ -227,6 +241,8 @@ int main(int argc, char** argv)
         auto commandGraph = vsg::createCommandGraphForView(window, camera, vsg_scene);
         viewer->assignRecordAndSubmitTaskAndPresentation({commandGraph});
 
+        if (instrumentation) viewer->assignInstrumentation(instrumentation);
+
         viewer->compile();
 
         if (maxPagedLOD > 0)

examples/nodes/vsgshadow/CMakeLists.txt

@@ -11,4 +11,9 @@ if (vsgXchange_FOUND)
     target_link_libraries(vsgshadow vsgXchange::vsgXchange)
 endif()
 
+if (Tracy_FOUND)
+    target_compile_definitions(vsgshadow PRIVATE Tracy_FOUND)
+    target_link_libraries(vsgshadow Tracy::TracyClient)
+endif()
+
 install(TARGETS vsgshadow RUNTIME DESTINATION bin)

examples/nodes/vsgshadow/vsgshadow.cpp

@@ -4,6 +4,10 @@
 #    include <vsgXchange/all.h>
 #endif
 
+#ifdef Tracy_FOUND
+#    include <vsg/utils/TracyInstrumentation.h>
+#endif
+
 #include <iostream>
 
 struct ModelSettings
@@ -210,6 +214,28 @@ int main(int argc, char** argv)
         windowTraits->decoration = false;
     }
 
+    vsg::ref_ptr<vsg::Instrumentation> instrumentation;
+    if (arguments.read({"--gpu-annotation", "--ga"}) && vsg::isExtensionSupported(VK_EXT_DEBUG_UTILS_EXTENSION_NAME))
+    {
+        windowTraits->debugUtils = true;
+
+        auto gpu_instrumentation = vsg::GpuAnnotation::create();
+        if (arguments.read("--func")) gpu_instrumentation->labelType = vsg::GpuAnnotation::SourceLocation_function;
+
+        instrumentation = gpu_instrumentation;
+    }
+#ifdef Tracy_FOUND
+    else if (arguments.read("--tracy"))
+    {
+        windowTraits->deviceExtensionNames.push_back(VK_EXT_CALIBRATED_TIMESTAMPS_EXTENSION_NAME);
+
+        auto tracy_instrumentation = vsg::TracyInstrumentation::create();
+        arguments.read("--cpu", tracy_instrumentation->settings->cpu_instumentation_level);
+        arguments.read("--gpu", tracy_instrumentation->settings->gpu_instumentation_level);
+        instrumentation = tracy_instrumentation;
+    }
+#endif
+
     double maxShadowDistance = arguments.value<double>(1e8, "--sd");
     double shadowMapBias = arguments.value<double>(0.005, "--sb");
     double lambda = arguments.value<double>(0.5, "--lambda");
@@ -523,6 +549,8 @@ int main(int argc, char** argv)
     auto commandGraph = vsg::CommandGraph::create(window, renderGraph);
     viewer->assignRecordAndSubmitTaskAndPresentation({commandGraph});
 
+    if (instrumentation) viewer->assignInstrumentation(instrumentation);
+
     viewer->compile(resourceHints);
 
     auto startTime = vsg::clock::now();

examples/utils/CMakeLists.txt

@@ -4,3 +4,7 @@ add_subdirectory(vsgshaderset)
 add_subdirectory(vsgintersection)
 add_subdirectory(vsgstoragebuffer)
 add_subdirectory(vsgcustomshaderset)
+
+if (Tracy_FOUND)
+    add_subdirectory(vsgtracyinstrumentation)
+endif()

examples/utils/vsgtracyinstrumentation/CMakeLists.txt

@@ -0,0 +1,14 @@
+set(SOURCES
+    vsgtracyinstrumentation.cpp
+)
+
+add_executable(vsgtracyinstrumentation ${SOURCES})
+
+target_link_libraries(vsgtracyinstrumentation vsg::vsg Tracy::TracyClient)
+
+if (vsgXchange_FOUND)
+    target_compile_definitions(vsgtracyinstrumentation PRIVATE vsgXchange_FOUND)
+    target_link_libraries(vsgtracyinstrumentation vsgXchange::vsgXchange)
+endif()
+
+install(TARGETS vsgtracyinstrumentation RUNTIME DESTINATION bin)