Examples: Windows: Added 'misc/debuggers/imgui.natstepfilter' file to all Visual Studio projects. (#3038)

2024-11-14 17:07:01 +00:00 · 2023-03-15 17:09:03 +01:00 · 2023-03-15 17:09:03 +01:00 · 301c956039
commit 301c956039
parent 8b6e021f35
32 changed files with 87 additions and 24 deletions
--- a/docs/CHANGELOG.txt
+++ b/docs/CHANGELOG.txt
@ -40,6 +40,8 @@ Breaking Changes:
 Other changes:

 - Backends: OpenGL3: Fixed GL loader crash when GL_VERSION returns NULL. (#6154, #4445, #3530)
+- Examples: Windows: Added 'misc/debuggers/imgui.natstepfilter' file to all Visual Studio projects,
+  now that VS 2022 17.6 Preview 2 support adding Debug Step Filter spec files into projects.
 - Examples: SDL3: Updated for latest WIP SDL3 branch. (#6243)


--- a/examples/example_allegro5/example_allegro5.vcxproj
+++ b/examples/example_allegro5/example_allegro5.vcxproj
@ -171,6 +171,7 @@
    <ClInclude Include="..\..\backends\imgui_impl_allegro5.h" />
  </ItemGroup>
  <ItemGroup>
+    <None Include="..\..\misc\debuggers\imgui.natstepfilter" />
    <None Include="..\..\misc\debuggers\imgui.natvis" />
    <None Include="..\README.txt" />
  </ItemGroup>
--- a/examples/example_allegro5/example_allegro5.vcxproj.filters
+++ b/examples/example_allegro5/example_allegro5.vcxproj.filters
@ -52,7 +52,10 @@
  <ItemGroup>
    <None Include="..\README.txt" />
    <None Include="..\..\misc\debuggers\imgui.natvis">
-      <Filter>sources</Filter>
+      <Filter>imgui</Filter>
+    </None>
+    <None Include="..\..\misc\debuggers\imgui.natstepfilter">
+      <Filter>imgui</Filter>
    </None>
  </ItemGroup>
 </Project>
--- a/examples/example_glfw_opengl2/example_glfw_opengl2.vcxproj
+++ b/examples/example_glfw_opengl2/example_glfw_opengl2.vcxproj
@ -172,6 +172,7 @@
    <ClInclude Include="..\..\backends\imgui_impl_opengl2.h" />
  </ItemGroup>
  <ItemGroup>
+    <None Include="..\..\misc\debuggers\imgui.natstepfilter" />
    <None Include="..\..\misc\debuggers\imgui.natvis" />
    <None Include="..\README.txt" />
  </ItemGroup>
--- a/examples/example_glfw_opengl2/example_glfw_opengl2.vcxproj.filters
+++ b/examples/example_glfw_opengl2/example_glfw_opengl2.vcxproj.filters
@ -57,5 +57,8 @@
    <None Include="..\..\misc\debuggers\imgui.natvis">
      <Filter>imgui</Filter>
    </None>
+    <None Include="..\..\misc\debuggers\imgui.natstepfilter">
+      <Filter>imgui</Filter>
+    </None>
  </ItemGroup>
 </Project>
--- a/examples/example_glfw_opengl3/example_glfw_opengl3.vcxproj
+++ b/examples/example_glfw_opengl3/example_glfw_opengl3.vcxproj
@ -173,6 +173,7 @@
    <ClInclude Include="..\..\backends\imgui_impl_opengl3_loader.h" />
  </ItemGroup>
  <ItemGroup>
+    <None Include="..\..\misc\debuggers\imgui.natstepfilter" />
    <None Include="..\..\misc\debuggers\imgui.natvis" />
    <None Include="..\README.txt" />
  </ItemGroup>
--- a/examples/example_glfw_opengl3/example_glfw_opengl3.vcxproj.filters
+++ b/examples/example_glfw_opengl3/example_glfw_opengl3.vcxproj.filters
@ -60,5 +60,8 @@
    <None Include="..\..\misc\debuggers\imgui.natvis">
      <Filter>imgui</Filter>
    </None>
+    <None Include="..\..\misc\debuggers\imgui.natstepfilter">
+      <Filter>imgui</Filter>
+    </None>
  </ItemGroup>
 </Project>
--- a/examples/example_glfw_vulkan/example_glfw_vulkan.vcxproj
+++ b/examples/example_glfw_vulkan/example_glfw_vulkan.vcxproj
@ -176,6 +176,7 @@
    <ClInclude Include="..\..\backends\imgui_impl_vulkan.h" />
  </ItemGroup>
  <ItemGroup>
+    <None Include="..\..\misc\debuggers\imgui.natstepfilter" />
    <None Include="..\..\misc\debuggers\imgui.natvis" />
    <None Include="..\README.txt" />
  </ItemGroup>
--- a/examples/example_glfw_vulkan/example_glfw_vulkan.vcxproj.filters
+++ b/examples/example_glfw_vulkan/example_glfw_vulkan.vcxproj.filters
@ -57,5 +57,8 @@
    <None Include="..\..\misc\debuggers\imgui.natvis">
      <Filter>imgui</Filter>
    </None>
+    <None Include="..\..\misc\debuggers\imgui.natstepfilter">
+      <Filter>imgui</Filter>
+    </None>
  </ItemGroup>
 </Project>
--- a/examples/example_glut_opengl2/example_glut_opengl2.vcxproj
+++ b/examples/example_glut_opengl2/example_glut_opengl2.vcxproj
@ -172,6 +172,7 @@
    <ClInclude Include="..\..\backends\imgui_impl_opengl2.h" />
  </ItemGroup>
  <ItemGroup>
+    <None Include="..\..\misc\debuggers\imgui.natstepfilter" />
    <None Include="..\..\misc\debuggers\imgui.natvis" />
    <None Include="..\README.txt" />
  </ItemGroup>
--- a/examples/example_glut_opengl2/example_glut_opengl2.vcxproj.filters
+++ b/examples/example_glut_opengl2/example_glut_opengl2.vcxproj.filters
@ -55,7 +55,10 @@
  <ItemGroup>
    <None Include="..\README.txt" />
    <None Include="..\..\misc\debuggers\imgui.natvis">
-      <Filter>sources</Filter>
+      <Filter>imgui</Filter>
+    </None>
+    <None Include="..\..\misc\debuggers\imgui.natstepfilter">
+      <Filter>imgui</Filter>
    </None>
  </ItemGroup>
 </Project>
--- a/examples/example_sdl2_directx11/example_sdl2_directx11.vcxproj
+++ b/examples/example_sdl2_directx11/example_sdl2_directx11.vcxproj
@ -173,6 +173,7 @@
    <ClInclude Include="..\..\backends\imgui_impl_dx11.h" />
  </ItemGroup>
  <ItemGroup>
+    <None Include="..\..\misc\debuggers\imgui.natstepfilter" />
    <None Include="..\..\misc\debuggers\imgui.natvis" />
    <None Include="..\README.txt" />
  </ItemGroup>
--- a/examples/example_sdl2_directx11/example_sdl2_directx11.vcxproj.filters
+++ b/examples/example_sdl2_directx11/example_sdl2_directx11.vcxproj.filters
@ -56,5 +56,8 @@
    <None Include="..\..\misc\debuggers\imgui.natvis">
      <Filter>imgui</Filter>
    </None>
+    <None Include="..\..\misc\debuggers\imgui.natstepfilter">
+      <Filter>imgui</Filter>
+    </None>
  </ItemGroup>
 </Project>
--- a/examples/example_sdl2_opengl2/example_sdl2_opengl2.vcxproj
+++ b/examples/example_sdl2_opengl2/example_sdl2_opengl2.vcxproj
@ -172,6 +172,7 @@
    <ClInclude Include="..\..\backends\imgui_impl_opengl2.h" />
  </ItemGroup>
  <ItemGroup>
+    <None Include="..\..\misc\debuggers\imgui.natstepfilter" />
    <None Include="..\..\misc\debuggers\imgui.natvis" />
    <None Include="..\README.txt" />
  </ItemGroup>
--- a/examples/example_sdl2_opengl2/example_sdl2_opengl2.vcxproj.filters
+++ b/examples/example_sdl2_opengl2/example_sdl2_opengl2.vcxproj.filters
@ -57,5 +57,8 @@
    <None Include="..\..\misc\debuggers\imgui.natvis">
      <Filter>imgui</Filter>
    </None>
+    <None Include="..\..\misc\debuggers\imgui.natstepfilter">
+      <Filter>imgui</Filter>
+    </None>
  </ItemGroup>
 </Project>
--- a/examples/example_sdl2_opengl3/example_sdl2_opengl3.vcxproj
+++ b/examples/example_sdl2_opengl3/example_sdl2_opengl3.vcxproj
@ -173,6 +173,7 @@
    <ClInclude Include="..\..\backends\imgui_impl_opengl3_loader.h" />
  </ItemGroup>
  <ItemGroup>
+    <None Include="..\..\misc\debuggers\imgui.natstepfilter" />
    <None Include="..\..\misc\debuggers\imgui.natvis" />
    <None Include="..\README.txt" />
  </ItemGroup>
--- a/examples/example_sdl2_opengl3/example_sdl2_opengl3.vcxproj.filters
+++ b/examples/example_sdl2_opengl3/example_sdl2_opengl3.vcxproj.filters
@ -60,5 +60,8 @@
    <None Include="..\..\misc\debuggers\imgui.natvis">
      <Filter>imgui</Filter>
    </None>
+    <None Include="..\..\misc\debuggers\imgui.natstepfilter">
+      <Filter>imgui</Filter>
+    </None>
  </ItemGroup>
 </Project>
--- a/examples/example_sdl2_sdlrenderer/example_sdl2_sdlrenderer.vcxproj
+++ b/examples/example_sdl2_sdlrenderer/example_sdl2_sdlrenderer.vcxproj
@ -172,6 +172,7 @@
    <ClInclude Include="..\..\backends\imgui_impl_sdlrenderer.h" />
  </ItemGroup>
  <ItemGroup>
+    <None Include="..\..\misc\debuggers\imgui.natstepfilter" />
    <None Include="..\..\misc\debuggers\imgui.natvis" />
    <None Include="..\README.txt" />
  </ItemGroup>
--- a/examples/example_sdl2_sdlrenderer/example_sdl2_sdlrenderer.vcxproj.filters
+++ b/examples/example_sdl2_sdlrenderer/example_sdl2_sdlrenderer.vcxproj.filters
@ -57,5 +57,8 @@
    <None Include="..\..\misc\debuggers\imgui.natvis">
      <Filter>imgui</Filter>
    </None>
+    <None Include="..\..\misc\debuggers\imgui.natstepfilter">
+      <Filter>imgui</Filter>
+    </None>
  </ItemGroup>
 </Project>
--- a/examples/example_sdl2_vulkan/example_sdl2_vulkan.vcxproj
+++ b/examples/example_sdl2_vulkan/example_sdl2_vulkan.vcxproj
@ -176,6 +176,7 @@
    <ClInclude Include="..\..\backends\imgui_impl_vulkan.h" />
  </ItemGroup>
  <ItemGroup>
+    <None Include="..\..\misc\debuggers\imgui.natstepfilter" />
    <None Include="..\..\misc\debuggers\imgui.natvis" />
    <None Include="..\README.txt" />
  </ItemGroup>
--- a/examples/example_sdl2_vulkan/example_sdl2_vulkan.vcxproj.filters
+++ b/examples/example_sdl2_vulkan/example_sdl2_vulkan.vcxproj.filters
@ -57,5 +57,8 @@
    <None Include="..\..\misc\debuggers\imgui.natvis">
      <Filter>imgui</Filter>
    </None>
+    <None Include="..\..\misc\debuggers\imgui.natstepfilter">
+      <Filter>imgui</Filter>
+    </None>
  </ItemGroup>
 </Project>
--- a/examples/example_sdl3_opengl3/example_sdl3_opengl3.vcxproj
+++ b/examples/example_sdl3_opengl3/example_sdl3_opengl3.vcxproj
@ -173,6 +173,7 @@
    <ClInclude Include="..\..\backends\imgui_impl_opengl3_loader.h" />
  </ItemGroup>
  <ItemGroup>
+    <None Include="..\..\misc\debuggers\imgui.natstepfilter" />
    <None Include="..\..\misc\debuggers\imgui.natvis" />
    <None Include="..\README.txt" />
  </ItemGroup>
--- a/examples/example_sdl3_opengl3/example_sdl3_opengl3.vcxproj.filters
+++ b/examples/example_sdl3_opengl3/example_sdl3_opengl3.vcxproj.filters
@ -60,5 +60,8 @@
    <None Include="..\..\misc\debuggers\imgui.natvis">
      <Filter>imgui</Filter>
    </None>
+    <None Include="..\..\misc\debuggers\imgui.natstepfilter">
+      <Filter>imgui</Filter>
+    </None>
  </ItemGroup>
 </Project>
--- a/examples/example_win32_directx10/example_win32_directx10.vcxproj
+++ b/examples/example_win32_directx10/example_win32_directx10.vcxproj
@ -162,6 +162,7 @@
    <ClCompile Include="main.cpp" />
  </ItemGroup>
  <ItemGroup>
+    <None Include="..\..\misc\debuggers\imgui.natstepfilter" />
    <None Include="..\..\misc\debuggers\imgui.natvis" />
    <None Include="..\README.txt" />
  </ItemGroup>
--- a/examples/example_win32_directx10/example_win32_directx10.vcxproj.filters
+++ b/examples/example_win32_directx10/example_win32_directx10.vcxproj.filters
@ -56,5 +56,8 @@
    <None Include="..\..\misc\debuggers\imgui.natvis">
      <Filter>imgui</Filter>
    </None>
+    <None Include="..\..\misc\debuggers\imgui.natstepfilter">
+      <Filter>imgui</Filter>
+    </None>
  </ItemGroup>
 </Project>
--- a/examples/example_win32_directx11/example_win32_directx11.vcxproj
+++ b/examples/example_win32_directx11/example_win32_directx11.vcxproj
@ -161,6 +161,7 @@
    <ClCompile Include="main.cpp" />
  </ItemGroup>
  <ItemGroup>
+    <None Include="..\..\misc\debuggers\imgui.natstepfilter" />
    <None Include="..\..\misc\debuggers\imgui.natvis" />
    <None Include="..\README.txt" />
  </ItemGroup>
--- a/examples/example_win32_directx11/example_win32_directx11.vcxproj.filters
+++ b/examples/example_win32_directx11/example_win32_directx11.vcxproj.filters
@ -56,5 +56,8 @@
    <None Include="..\..\misc\debuggers\imgui.natvis">
      <Filter>imgui</Filter>
    </None>
+    <None Include="..\..\misc\debuggers\imgui.natstepfilter">
+      <Filter>imgui</Filter>
+    </None>
  </ItemGroup>
 </Project>
--- a/examples/example_win32_directx12/example_win32_directx12.vcxproj
+++ b/examples/example_win32_directx12/example_win32_directx12.vcxproj
@ -164,6 +164,7 @@
    <ClCompile Include="main.cpp" />
  </ItemGroup>
  <ItemGroup>
+    <None Include="..\..\misc\debuggers\imgui.natstepfilter" />
    <None Include="..\README.txt" />
  </ItemGroup>
  <ItemGroup>
--- a/examples/example_win32_directx12/example_win32_directx12.vcxproj.filters
+++ b/examples/example_win32_directx12/example_win32_directx12.vcxproj.filters
@ -53,6 +53,9 @@
  </ItemGroup>
  <ItemGroup>
    <None Include="..\README.txt" />
+    <None Include="..\..\misc\debuggers\imgui.natstepfilter">
+      <Filter>imgui</Filter>
+    </None>
  </ItemGroup>
  <ItemGroup>
    <Natvis Include="..\..\misc\debuggers\imgui.natvis">
--- a/examples/example_win32_directx9/example_win32_directx9.vcxproj
+++ b/examples/example_win32_directx9/example_win32_directx9.vcxproj
@ -162,6 +162,7 @@
    <ClInclude Include="..\..\backends\imgui_impl_win32.h" />
  </ItemGroup>
  <ItemGroup>
+    <None Include="..\..\misc\debuggers\imgui.natstepfilter" />
    <None Include="..\..\misc\debuggers\imgui.natvis" />
    <None Include="..\README.txt" />
  </ItemGroup>
--- a/examples/example_win32_directx9/example_win32_directx9.vcxproj.filters
+++ b/examples/example_win32_directx9/example_win32_directx9.vcxproj.filters
@ -57,5 +57,8 @@
    <None Include="..\..\misc\debuggers\imgui.natvis">
      <Filter>imgui</Filter>
    </None>
+    <None Include="..\..\misc\debuggers\imgui.natstepfilter">
+      <Filter>imgui</Filter>
+    </None>
  </ItemGroup>
 </Project>
--- a/misc/debuggers/imgui.natstepfilter
+++ b/misc/debuggers/imgui.natstepfilter
@ -3,14 +3,15 @@
 .natstepfilter file for Visual Studio debugger.
 Purpose: instruct debugger to skip some functions when using StepInto (F11)

-To enable:
+Since Visual Studio 2022 version 17.6 Preview 2 (currently available as a "Preview" build on March 14, 2023)
+It is possible to add the .natstepfilter file to your project file and it will automatically be used.
+(https://developercommunity.visualstudio.com/t/allow-natstepfilter-and-natjmc-to-be-included-as-p/561718)
+
+For older Visual Studio version prior to 2022 17.6 Preview 2:
 * copy in %USERPROFILE%\Documents\Visual Studio XXXX\Visualizers (current user)
 * or copy in %VsInstallDirectory%\Common7\Packages\Debugger\Visualizers (all users)
-If you have multiple VS version installed, the version that matters is the one you are using the IDE/debugger of (not the compiling toolset).
-This is supported since Visual Studio 2012.
-
-Unfortunately, unlike .natvis files, it isn't yet possible to include this file in your project :(
-You may upvote this: https://developercommunity.visualstudio.com/t/allow-natstepfilter-and-natjmc-to-be-included-as-p/561718
+If you have multiple VS version installed, the version that matters is the one you are using the IDE/debugger
+of (not the compiling toolset). This is supported since Visual Studio 2012.

 More information at: https://docs.microsoft.com/en-us/visualstudio/debugger/just-my-code?view=vs-2019#BKMK_C___Just_My_Code
 -->