ngfx integration

Author: keptsecret

include/nbl/video/IAPIConnection.h

@@ -11,7 +11,7 @@
 #include "nbl/video/debug/IDebugCallback.h"
 
 #include "nbl/video/utilities/renderdoc.h"
-
+#include "nbl/video/utilities/ngfx.h"
 
 namespace nbl::video
 {
@@ -61,7 +61,16 @@ class NBL_API2 IAPIConnection : public core::IReferenceCounted
 
         const SFeatures& getEnabledFeatures() const { return m_enabledFeatures; }
 
-        const bool isRunningInRenderdoc() const { return m_rdoc_api; }
+        enum DebuggerType
+        {
+            EDT_NONE,
+            EDT_RENDERDOC,
+            EDT_NGFX
+        };
+        const DebuggerType isRunningInGraphicsDebugger() const {
+            return m_ngfx_api.useNGFX ? EDT_NGFX :      // ngfx takes priority?
+                m_rdoc_api ? EDT_RENDERDOC : EDT_NONE;
+        }
         virtual bool startCapture() = 0;
         virtual bool endCapture() = 0;
 
@@ -70,6 +79,7 @@ class NBL_API2 IAPIConnection : public core::IReferenceCounted
 
         std::vector<std::unique_ptr<IPhysicalDevice>> m_physicalDevices;
         renderdoc_api_t* m_rdoc_api;
+        ngfx_api_t m_ngfx_api;
         SFeatures m_enabledFeatures = {};
 };
 

include/nbl/video/utilities/ngfx.h

@@ -0,0 +1,79 @@
+#ifndef _NBL_VIDEO_UTILITIES_NGFX_H_INCLUDED_
+#define _NBL_VIDEO_UTILITIES_NGFX_H_INCLUDED_
+
+#include "C:\Program Files\NVIDIA Corporation\Nsight Graphics 2024.1.0\SDKs\NsightGraphicsSDK\0.8.0\include\NGFX_Injection.h"
+
+namespace nbl::video
+{
+    struct SNGFXIntegration
+    {
+        bool useNGFX;
+        NGFX_Injection_InstallationInfo versionInfo;
+    };
+
+    bool injectNGFXToProcess(SNGFXIntegration& api)
+    {
+        uint32_t numInstallations = 0;
+        auto result = NGFX_Injection_EnumerateInstallations(&numInstallations, nullptr);
+        if (numInstallations == 0 || NGFX_INJECTION_RESULT_OK != result)
+        {
+            api.useNGFX = false;
+            return false;
+        }
+
+        std::vector<NGFX_Injection_InstallationInfo> installations(numInstallations);
+        result = NGFX_Injection_EnumerateInstallations(&numInstallations, installations.data());
+        if (numInstallations == 0 || NGFX_INJECTION_RESULT_OK != result)
+        {
+            api.useNGFX = false;
+            return false;
+        }
+
+        // get latest installation
+        api.versionInfo = installations.back();
+
+        uint32_t numActivities = 0;
+        result = NGFX_Injection_EnumerateActivities(&api.versionInfo, &numActivities, nullptr);
+        if (numActivities == 0 || NGFX_INJECTION_RESULT_OK != result)
+        {
+            api.useNGFX = false;
+            return false;
+        }
+
+        std::vector<NGFX_Injection_Activity> activities(numActivities);
+        result = NGFX_Injection_EnumerateActivities(&api.versionInfo, &numActivities, activities.data());
+        if (NGFX_INJECTION_RESULT_OK != result)
+        {
+            api.useNGFX = false;
+            return false;
+        }
+
+        const NGFX_Injection_Activity* pActivityToInject = nullptr;
+        for (const NGFX_Injection_Activity& activity : activities)
+        {
+            if (activity.type == NGFX_INJECTION_ACTIVITY_FRAME_DEBUGGER)    // only want frame debugger
+            {
+                pActivityToInject = &activity;
+                break;
+            }
+        }
+
+        if (!pActivityToInject) {
+            api.useNGFX = false;
+            return false;
+        }
+
+        result = NGFX_Injection_InjectToProcess(&api.versionInfo, pActivityToInject);
+        if (NGFX_INJECTION_RESULT_OK != result)
+        {
+            api.useNGFX = false;
+            return false;
+        }
+
+        return true;
+    }
+
+    using ngfx_api_t = SNGFXIntegration;
+}
+
+#endif //_NBL_VIDEO_UTILITIES_NGFX_H_INCLUDED_

src/nbl/video/CVulkanConnection.cpp

@@ -323,7 +323,8 @@ CVulkanConnection::~CVulkanConnection()
 
 bool CVulkanConnection::startCapture()
 {
-    if (!isRunningInRenderdoc())
+    auto debugType = isRunningInGraphicsDebugger();
+    if (debugType == EDT_NONE)
         return false;
     if (flag.test())
     {
@@ -335,13 +336,17 @@ bool CVulkanConnection::startCapture()
     }
 
     flag.test_and_set();
-    m_rdoc_api->StartFrameCapture(RENDERDOC_DEVICEPOINTER_FROM_VKINSTANCE(m_vkInstance), NULL);
+    if (debugType == EDT_RENDERDOC)
+        m_rdoc_api->StartFrameCapture(RENDERDOC_DEVICEPOINTER_FROM_VKINSTANCE(m_vkInstance), NULL);
+    else
+        NGFX_Injection_ExecuteActivityCommand();
     return true;
 }
 
 bool CVulkanConnection::endCapture()
 {
-    if (!isRunningInRenderdoc())
+    auto debugType = isRunningInGraphicsDebugger();
+    if (debugType == EDT_NONE)
         return false;
     if (!flag.test())
     {
@@ -352,7 +357,9 @@ bool CVulkanConnection::endCapture()
         return false;
     }
 
-    m_rdoc_api->EndFrameCapture(RENDERDOC_DEVICEPOINTER_FROM_VKINSTANCE(m_vkInstance), NULL);
+    if (debugType == EDT_RENDERDOC)
+        m_rdoc_api->EndFrameCapture(RENDERDOC_DEVICEPOINTER_FROM_VKINSTANCE(m_vkInstance), NULL);
+    // no equivalent end frame capture for ngfx, ends captures on next frame delimiter
     flag.clear();
     return true;
 }

src/nbl/video/IAPIConnection.cpp

@@ -43,6 +43,9 @@ IAPIConnection::IAPIConnection(const SFeatures& enabledFeatures)
         int ret = RENDERDOC_GetAPI(MinRenderdocVersion, (void**)&m_rdoc_api);
         assert(ret == 1);
     #endif
+
+        // probably is platform agnostic, for now
+        injectNGFXToProcess(m_ngfx_api);
     }
 }