Add DxDispatch PIX timing capture command line support on windows (#617)

* add timing capture command line support on windows

Author: colebMSFT

DxDispatch/src/dxdispatch/CommandLineArgs.cpp

@@ -437,9 +437,6 @@ CommandLineArgs::CommandLineArgs(int argc, char** argv)
         else if (pixCaptureTypeStr == "timing")
         {
             m_pixCaptureType = PixCaptureType::ProgrammaticTiming;
-#ifndef _GAMING_XBOX
-            throw std::invalid_argument("Programmatic timing captures are not supported");
-#endif
         }
         else if (pixCaptureTypeStr == "manual")
         {

DxDispatch/src/dxdispatch/PixCaptureHelper.cpp

@@ -39,6 +39,10 @@ PixCaptureHelper::PixCaptureHelper(PixCaptureType captureType, std::string_view
     {
         m_gpuCaptureLibrary.reset(PIXLoadLatestWinPixGpuCapturerLibrary());
     }
+    else if (captureType == PixCaptureType::ProgrammaticTiming)
+    {
+        m_timingCaptureLibrary.reset(PIXLoadLatestWinPixTimingCapturerLibrary());
+    }
 #endif
 }
 
@@ -61,7 +65,9 @@ HRESULT PixCaptureHelper::BeginCapturableWork()
     {
         case PixCaptureType::ProgrammaticTiming:
         {
-#ifdef _GAMING_XBOX
+#if defined(PIX_NONE)
+            return E_NOTIMPL;
+#elif defined(_GAMING_XBOX)
             auto captureName = m_captureName + L".pevt";
             PIXCaptureParameters captureParams = {};
             captureParams.TimingCaptureParameters.CaptureGpuTiming = TRUE;
@@ -73,8 +79,26 @@ HRESULT PixCaptureHelper::BeginCapturableWork()
             captureParams.TimingCaptureParameters.MaximumToolingMemorySizeMb = 4096;
             return PIXBeginCapture(PIX_CAPTURE_TIMING, &captureParams);
 #else
-            // There is currently no programmatic API for timing captures on Windows.
-            return E_NOTIMPL;
+            if (!m_timingCaptureLibrary)
+            {
+                throw std::runtime_error("The WinPix Timing capturer library was not found. Ensure that PIX version 2303.02 or later is installed.");
+            }
+            auto captureName = m_captureName + L".wpix";
+
+            PIXCaptureParameters captureParams = {};
+            captureParams.TimingCaptureParameters.FileName = captureName.c_str();
+            captureParams.TimingCaptureParameters.CaptureGpuTiming = TRUE;
+            captureParams.TimingCaptureParameters.CaptureCallstacks = TRUE;
+            captureParams.TimingCaptureParameters.CaptureCpuSamples = TRUE;
+            captureParams.TimingCaptureParameters.CpuSamplesPerSecond = 4000;
+            captureParams.TimingCaptureParameters.CaptureStorage = PIXCaptureParameters::Memory;
+            captureParams.TimingCaptureParameters.MaximumToolingMemorySizeMb = 4096;
+            HRESULT hr = PIXBeginCapture(PIX_CAPTURE_TIMING, &captureParams);
+            if (hr == E_ACCESSDENIED)
+            {
+                throw std::runtime_error("E_ACCESSDENIED while attempting to begin PIX timing capture.  Timing capture requires elevated privileges.");
+            }
+            return hr;
 #endif
         }
 
@@ -95,7 +119,7 @@ HRESULT PixCaptureHelper::BeginCapturableWork()
 
             // PIXBeginCapture can only be used for GPU captures on Windows.
             PIXCaptureParameters captureParams = {};
-            captureParams.TimingCaptureParameters.FileName = captureName.c_str();
+            captureParams.GpuCaptureParameters.FileName = captureName.c_str();
             return PIXBeginCapture(PIX_CAPTURE_GPU, &captureParams);
 #endif
         }
@@ -124,7 +148,9 @@ HRESULT PixCaptureHelper::EndCapturableWork()
     {
         case PixCaptureType::ProgrammaticTiming:
         {
-#if defined(_GAMING_XBOX)
+#if defined(PIX_NONE)
+            return E_NOTIMPL;
+#elif defined(_GAMING_XBOX)
             HRESULT hr;
             do
             {
@@ -137,8 +163,9 @@ HRESULT PixCaptureHelper::EndCapturableWork()
 
             return hr;
 #else
-            // There is currently no programmatic API for timing captures on Windows.
-            return E_NOTIMPL;
+            // PIX on Windows ignores the discard parameter, and will flush internally,
+            // no need for the loop xbox needs above.
+            return PIXEndCapture(/*discard*/FALSE);
 #endif
         }
 

DxDispatch/src/dxdispatch/PixCaptureHelper.h

@@ -35,6 +35,7 @@ class PixCaptureHelper
     Microsoft::WRL::ComPtr<ID3D12CommandQueue> m_commandQueue;
 #if !defined(_GAMING_XBOX) && !defined(PIX_NONE)
     wil::unique_hmodule m_gpuCaptureLibrary;
+    wil::unique_hmodule m_timingCaptureLibrary;
     Microsoft::WRL::ComPtr<ID3D12SharingContract> m_sharingContract;
 #endif
 };