Merge branch 'master' into navigation

2024-12-18 14:16:36 +00:00 · 2018-01-24 19:36:48 +01:00 · 2018-01-24 19:36:48 +01:00 · c8def61f5c
commit c8def61f5c
parent 6f366fff6b 8c57d8cc1e
12 changed files with 80 additions and 16 deletions
--- a/examples/README.txt
+++ b/examples/README.txt
@ -1,10 +1,13 @@
-Those are standalone ready-to-build applications to demonstrate ImGui.
+Those are standalone ready-to-build applications to demonstrate Dear ImGui.
 Binaries of some of those demos: http://www.miracleworld.net/imgui/binaries

-Third party languages and frameworks bindings: https://github.com/ocornut/imgui/wiki/Links
-(languages: C, .net, rust, D, Python, Lua..)
-(frameworks: DX12, Vulkan, Cinder, OpenGLES, openFrameworks, Cocos2d-x, SFML, Flexium, NanoRT, Irrlicht..)
-(extras: RemoteImGui, ImWindow, imgui_wm..)
+Third party languages and frameworks bindings: 
+  https://github.com/ocornut/imgui/wiki/Links
+(languages: C, C#, ChaiScript, D, Go, Haxe, Odin, Python, Rust, Lua, Pascal)
+(frameworks: DX12, OpenGLES, FreeGlut, Cinder, Cocos2d-x, SFML, GML/GameMaker Studio, Irrlicht, Ogre, 
+ OpenSceneGraph, openFrameworks, LOVE, NanoRT, Qt3d, SFML, Unreal Engine 4, etc.)
+(extras: RemoteImGui, ImWindow, imgui_wm, etc.)
+

 TL;DR; 
 - Newcomers, read 'PROGRAMMER GUIDE' in imgui.cpp for notes on how to setup ImGui in your codebase.
@ -19,14 +22,14 @@ TL;DR;
   existing rendering backends, don't feel forced to rewrite them with your own engine API, or you can
   do that later when you already got things to work.

-ImGui is highly portable and only requires a few things to run:
+Dear ImGui is highly portable and only requires a few things to run and render.
 - Providing mouse/keyboard inputs
 - Load the font atlas texture into graphics memory
 - Providing a render function to render indexed textured triangles
 - Optional: clipboard support, mouse cursor supports, Windows IME support, etc.
 So this is essentially what those examples are doing + the obligatory cruft for portability.

-Unfortunately in 2016 it is still tedious to create and maintain portable build files using external 
+Unfortunately in 2018 it is still tedious to create and maintain portable build files using external 
 libraries (the kind we're using here to create a window and render 3D triangles) without relying on 
 third party software. For most examples here I choose to provide:
 - Makefiles for Linux/OSX
@ -36,14 +39,15 @@ Please let me know if they don't work with your setup!
 You can probably just import the imgui_impl_xxx.cpp/.h files into your own codebase or compile those
 directly with a command-line compiler.

-ImGui has zero frame of lag for most behaviors and one frame of lag for some behaviors. 
-At 60 FPS your experience should be pleasant. Consider that OS mouse cursors are typically drawn through 
-a specific hardware accelerated route and may feel smoother than other GPU rendered contents. You may 
-experiment with the io.MouseDrawCursor flag to request ImGui to draw a mouse cursor itself, to visualize 
-the lag between a hardware cursor and a software cursor. It might be beneficial to the user experience
-to switch to a software rendered cursor when an interactive drag is in progress. 
+Dear ImGui has zero to one frame of lag for most behaviors, at 60 FPS your experience should be pleasant.
+Consider that OS mouse cursors are typically drawn through a specific hardware accelerated route and may 
+feel smoother than other GPU rendered contents. You may experiment with the io.MouseDrawCursor flag to
+request ImGui to draw a mouse cursor itself, to visualize the lag between a hardware cursor and a software
+cursor. It might be beneficial to the user experience to switch to a software rendered cursor when an
+interactive drag is in progress. 
 Also note that some setup or GPU drivers may be causing extra lag (possibly by enforcing triple buffering),
-leaving you with no option but sadness/anger (Intel GPU drivers were reported as such).
+leaving you with little option but sadness (Intel GPU drivers were reported as such).
+

 opengl2_example/
    **DO NOT USE THIS CODE IF YOUR CODE/ENGINE IS USING MODERN OPENGL (SHADERS, VBO, VAO, etc.)**
@ -99,4 +103,4 @@ vulkan_example/
 	Vulkan example.
 	This is quite long and tedious, because: Vulkan.

-TODO: Apple, SDL GL/GL3, Allegro, Marmalade, Vulkan examples do not honor the io.WantMoveMouse flag.
+TODO: Apple, SDL GL2/GL3, Allegro, Marmalade, Vulkan examples do not honor the io.WantMoveMouse flag.
--- a/examples/directx10_example/directx10_example.vcxproj
+++ b/examples/directx10_example/directx10_example.vcxproj
@ -153,6 +153,7 @@
    <ClCompile Include="main.cpp" />
  </ItemGroup>
  <ItemGroup>
+    <None Include="..\libs\imgui.natvis" />
    <None Include="..\README.txt" />
  </ItemGroup>
  <Import Project="$(VCTargetsPath)\Microsoft.Cpp.targets" />
--- a/examples/directx10_example/directx10_example.vcxproj.filters
+++ b/examples/directx10_example/directx10_example.vcxproj.filters
@ -41,5 +41,8 @@
  </ItemGroup>
  <ItemGroup>
    <None Include="..\README.txt" />
+    <None Include="..\libs\imgui.natvis">
+      <Filter>sources</Filter>
+    </None>
  </ItemGroup>
 </Project>
--- a/examples/directx11_example/directx11_example.vcxproj
+++ b/examples/directx11_example/directx11_example.vcxproj
@ -153,6 +153,7 @@
    <ClCompile Include="main.cpp" />
  </ItemGroup>
  <ItemGroup>
+    <None Include="..\libs\imgui.natvis" />
    <None Include="..\README.txt" />
  </ItemGroup>
  <Import Project="$(VCTargetsPath)\Microsoft.Cpp.targets" />
--- a/examples/directx11_example/directx11_example.vcxproj.filters
+++ b/examples/directx11_example/directx11_example.vcxproj.filters
@ -41,5 +41,8 @@
  </ItemGroup>
  <ItemGroup>
    <None Include="..\README.txt" />
+    <None Include="..\libs\imgui.natvis">
+      <Filter>sources</Filter>
+    </None>
  </ItemGroup>
 </Project>
--- a/examples/directx9_example/directx9_example.vcxproj
+++ b/examples/directx9_example/directx9_example.vcxproj
@ -153,6 +153,7 @@
    <ClInclude Include="imgui_impl_dx9.h" />
  </ItemGroup>
  <ItemGroup>
+    <None Include="..\libs\imgui.natvis" />
    <None Include="..\README.txt" />
  </ItemGroup>
  <Import Project="$(VCTargetsPath)\Microsoft.Cpp.targets" />
--- a/examples/directx9_example/directx9_example.vcxproj.filters
+++ b/examples/directx9_example/directx9_example.vcxproj.filters
@ -42,5 +42,8 @@
  </ItemGroup>
  <ItemGroup>
    <None Include="..\README.txt" />
+    <None Include="..\libs\imgui.natvis">
+      <Filter>sources</Filter>
+    </None>
  </ItemGroup>
 </Project>
--- a/examples/libs/imgui.natvis
+++ b/examples/libs/imgui.natvis
@ -0,0 +1,40 @@
+<?xml version="1.0" encoding="utf-8"?>
+
+<!-- natvis file for Visual Studio debugger (you can include this in a project file, or install in visual studio folder) -->
+
+<AutoVisualizer xmlns="http://schemas.microsoft.com/vstudio/debugger/natvis/2010">
+
+<Type Name="ImVector&lt;*&gt;">
+  <DisplayString>{{Size={Size} Capacity={Capacity}}}</DisplayString>
+  <Expand>
+    <ArrayItems>
+      <Size>Size</Size>
+      <ValuePointer>Data</ValuePointer>
+    </ArrayItems>
+  </Expand>
+</Type>
+
+<Type Name="ImVec2">
+  <DisplayString>{{x={x,g} y={y,g}}}</DisplayString>
+</Type>
+
+<Type Name="ImVec4">
+  <DisplayString>{{x={x,g} y={y,g} z={z,g} w={w,g}}}</DisplayString>
+</Type>
+
+<Type Name="ImRect">
+  <DisplayString>{{Min=({Min.x,g} {Min.y,g}) Max=({Max.x,g} {Max.y,g}) Size=({Max.x-Min.x,g} {Max.y-Min.y,g})}}</DisplayString>
+  <Expand>
+    <Item Name="Min">Min</Item>
+    <Item Name="Max">Max</Item>
+    <Item Name="[Width]">Max.x - Min.x</Item>
+    <Item Name="[Height]">Max.y - Min.y</Item>
+  </Expand>
+</Type>
+
+<Type Name="ImGuiWindow">
+  <DisplayString Condition="Active||WasActive">{{Name={Name,s}}}</DisplayString>
+  <DisplayString Condition="!(Active||WasActive)">{{Name={Name,s}} Inactive}</DisplayString>
+</Type>
+  
+</AutoVisualizer>
--- a/examples/opengl2_example/opengl2_example.vcxproj
+++ b/examples/opengl2_example/opengl2_example.vcxproj
@ -163,6 +163,7 @@
    <ClInclude Include="imgui_impl_glfw_gl2.h" />
  </ItemGroup>
  <ItemGroup>
+    <None Include="..\libs\imgui.natvis" />
    <None Include="..\README.txt" />
  </ItemGroup>
  <Import Project="$(VCTargetsPath)\Microsoft.Cpp.targets" />
--- a/examples/opengl2_example/opengl2_example.vcxproj.filters
+++ b/examples/opengl2_example/opengl2_example.vcxproj.filters
@ -42,5 +42,8 @@
  </ItemGroup>
  <ItemGroup>
    <None Include="..\README.txt" />
+    <None Include="..\libs\imgui.natvis">
+      <Filter>sources</Filter>
+    </None>
  </ItemGroup>
 </Project>
--- a/examples/opengl3_example/opengl3_example.vcxproj
+++ b/examples/opengl3_example/opengl3_example.vcxproj
@ -166,6 +166,7 @@
    <ClInclude Include="imgui_impl_glfw_gl3.h" />
  </ItemGroup>
  <ItemGroup>
+    <None Include="..\libs\imgui.natvis" />
    <None Include="..\README.txt" />
  </ItemGroup>
  <Import Project="$(VCTargetsPath)\Microsoft.Cpp.targets" />
--- a/examples/opengl3_example/opengl3_example.vcxproj.filters
+++ b/examples/opengl3_example/opengl3_example.vcxproj.filters
@ -54,5 +54,8 @@
  </ItemGroup>
  <ItemGroup>
    <None Include="..\README.txt" />
+    <None Include="..\libs\imgui.natvis">
+      <Filter>sources</Filter>
+    </None>
  </ItemGroup>
 </Project>