浏览代码

Examples: Possibly clarified the intent of imgui_impl_* files.

ocornut 10 年之前
父节点
当前提交
5d53f37a5d

+ 3 - 0
examples/allegro5_example/imgui_impl_a5.cpp

@@ -1,4 +1,7 @@
 // ImGui Allegro 5 bindings
 // ImGui Allegro 5 bindings
+// You can copy and use unmodified imgui_impl_* files in your project. 
+// If you use this binding you'll need to call 4 functions: ImGui_ImplXXXX_Init(), ImGui_ImplXXXX_NewFrame(), ImGui::Render() and ImGui_ImplXXXX_Shutdown().
+// See main.cpp for an example of using this.
 // https://github.com/ocornut/imgui
 // https://github.com/ocornut/imgui
 // by @birthggd
 // by @birthggd
 
 

+ 3 - 0
examples/allegro5_example/imgui_impl_a5.h

@@ -1,4 +1,7 @@
 // ImGui Allegro 5 bindings
 // ImGui Allegro 5 bindings
+// You can copy and use unmodified imgui_impl_* files in your project. 
+// If you use this binding you'll need to call 4 functions: ImGui_ImplXXXX_Init(), ImGui_ImplXXXX_NewFrame(), ImGui::Render() and ImGui_ImplXXXX_Shutdown().
+// See main.cpp for an example of using this.
 // https://github.com/ocornut/imgui
 // https://github.com/ocornut/imgui
 // by @birthggd
 // by @birthggd
 
 

+ 3 - 0
examples/directx11_example/imgui_impl_dx11.cpp

@@ -1,4 +1,7 @@
 // ImGui Win32 + DirectX11 binding
 // ImGui Win32 + DirectX11 binding
+// You can copy and use unmodified imgui_impl_* files in your project. 
+// If you use this binding you'll need to call 4 functions: ImGui_ImplXXXX_Init(), ImGui_ImplXXXX_NewFrame(), ImGui::Render() and ImGui_ImplXXXX_Shutdown().
+// See main.cpp for an example of using this.
 // https://github.com/ocornut/imgui
 // https://github.com/ocornut/imgui
 
 
 #include <imgui.h>
 #include <imgui.h>

+ 3 - 0
examples/directx11_example/imgui_impl_dx11.h

@@ -1,4 +1,7 @@
 // ImGui Win32 + DirectX11 binding
 // ImGui Win32 + DirectX11 binding
+// You can copy and use unmodified imgui_impl_* files in your project. 
+// If you use this binding you'll need to call 4 functions: ImGui_ImplXXXX_Init(), ImGui_ImplXXXX_NewFrame(), ImGui::Render() and ImGui_ImplXXXX_Shutdown().
+// See main.cpp for an example of using this.
 // https://github.com/ocornut/imgui
 // https://github.com/ocornut/imgui
 
 
 struct ID3D11Device;
 struct ID3D11Device;

+ 3 - 0
examples/directx9_example/imgui_impl_dx9.cpp

@@ -1,4 +1,7 @@
 // ImGui Win32 + DirectX9 binding
 // ImGui Win32 + DirectX9 binding
+// You can copy and use unmodified imgui_impl_* files in your project. 
+// If you use this binding you'll need to call 4 functions: ImGui_ImplXXXX_Init(), ImGui_ImplXXXX_NewFrame(), ImGui::Render() and ImGui_ImplXXXX_Shutdown().
+// See main.cpp for an example of using this.
 // https://github.com/ocornut/imgui
 // https://github.com/ocornut/imgui
 
 
 #include <imgui.h>
 #include <imgui.h>

+ 3 - 0
examples/directx9_example/imgui_impl_dx9.h

@@ -1,4 +1,7 @@
 // ImGui Win32 + DirectX9 binding
 // ImGui Win32 + DirectX9 binding
+// You can copy and use unmodified imgui_impl_* files in your project. 
+// If you use this binding you'll need to call 4 functions: ImGui_ImplXXXX_Init(), ImGui_ImplXXXX_NewFrame(), ImGui::Render() and ImGui_ImplXXXX_Shutdown().
+// See main.cpp for an example of using this.
 // https://github.com/ocornut/imgui
 // https://github.com/ocornut/imgui
 
 
 struct IDirect3DDevice9;
 struct IDirect3DDevice9;

+ 2 - 4
examples/ios_example/README.md

@@ -1,14 +1,14 @@
 # iOS example
 # iOS example
 
 
-----
 ## Introduction
 ## Introduction
 
 
 This example is the default XCode "OpenGL" example code, modified to support ImGui and [Synergy](http://synergy-project.org/). 
 This example is the default XCode "OpenGL" example code, modified to support ImGui and [Synergy](http://synergy-project.org/). 
 
 
+It is a rather complex example because of all of the faff required to get an XCode/iOS application running. Refer to the regular OpenGL examples if you want to learn about integrating ImGui.
+
 Synergy (remote keyboard/mouse) is not required, but it's pretty hard to use ImGui without it. Synergy includes a "uSynergy" library that allows embedding a synergy client, this is what is used here. ImGui supports "TouchPadding", and this is enabled when Synergy is not active.
 Synergy (remote keyboard/mouse) is not required, but it's pretty hard to use ImGui without it. Synergy includes a "uSynergy" library that allows embedding a synergy client, this is what is used here. ImGui supports "TouchPadding", and this is enabled when Synergy is not active.
 
 
 ## How to Use
 ## How to Use
-----
 
 
 0. In Synergy, go to Preferences, and uncheck "Use SSL encryption"
 0. In Synergy, go to Preferences, and uncheck "Use SSL encryption"
 0. Run the example app.
 0. Run the example app.
@@ -16,7 +16,6 @@ Synergy (remote keyboard/mouse) is not required, but it's pretty hard to use ImG
 0. Enter the name or the IP of your synergy host
 0. Enter the name or the IP of your synergy host
 0. If you had previously connected to a server, you may need to kill and re-start the app.
 0. If you had previously connected to a server, you may need to kill and re-start the app.
 
 
-----
 ## Notes and TODOs
 ## Notes and TODOs
 
 
 Things that would be nice but I didn't get around to doing:
 Things that would be nice but I didn't get around to doing:
@@ -26,7 +25,6 @@ Things that would be nice but I didn't get around to doing:
 * Graceful disconnect/reconnect from uSynergy.
 * Graceful disconnect/reconnect from uSynergy.
 * Copy/Paste not well-supported
 * Copy/Paste not well-supported
 
 
-----
 ## C++ on iOS
 ## C++ on iOS
 ImGui is a c++ library. If you want to include it directly, rename your Obj-C file to have the ".mm" extension. 
 ImGui is a c++ library. If you want to include it directly, rename your Obj-C file to have the ".mm" extension. 
 
 

+ 3 - 0
examples/opengl3_example/imgui_impl_glfw_gl3.cpp

@@ -1,4 +1,7 @@
 // ImGui GLFW binding with OpenGL3 + shaders
 // ImGui GLFW binding with OpenGL3 + shaders
+// You can copy and use unmodified imgui_impl_* files in your project. 
+// If you use this binding you'll need to call 4 functions: ImGui_ImplXXXX_Init(), ImGui_ImplXXXX_NewFrame(), ImGui::Render() and ImGui_ImplXXXX_Shutdown().
+// See main.cpp for an example of using this.
 // https://github.com/ocornut/imgui
 // https://github.com/ocornut/imgui
 
 
 #include <imgui.h>
 #include <imgui.h>

+ 3 - 0
examples/opengl3_example/imgui_impl_glfw_gl3.h

@@ -1,4 +1,7 @@
 // ImGui GLFW binding with OpenGL3 + shaders
 // ImGui GLFW binding with OpenGL3 + shaders
+// You can copy and use unmodified imgui_impl_* files in your project. 
+// If you use this binding you'll need to call 4 functions: ImGui_ImplXXXX_Init(), ImGui_ImplXXXX_NewFrame(), ImGui::Render() and ImGui_ImplXXXX_Shutdown().
+// See main.cpp for an example of using this.
 // https://github.com/ocornut/imgui
 // https://github.com/ocornut/imgui
 
 
 struct GLFWwindow;
 struct GLFWwindow;

+ 3 - 0
examples/opengl_example/imgui_impl_glfw.cpp

@@ -1,4 +1,7 @@
 // ImGui GLFW binding with OpenGL
 // ImGui GLFW binding with OpenGL
+// You can copy and use unmodified imgui_impl_* files in your project. 
+// If you use this binding you'll need to call 4 functions: ImGui_ImplXXXX_Init(), ImGui_ImplXXXX_NewFrame(), ImGui::Render() and ImGui_ImplXXXX_Shutdown().
+// See main.cpp for an example of using this.
 // https://github.com/ocornut/imgui
 // https://github.com/ocornut/imgui
 
 
 #include <imgui.h>
 #include <imgui.h>

+ 3 - 0
examples/opengl_example/imgui_impl_glfw.h

@@ -1,4 +1,7 @@
 // ImGui GLFW binding with OpenGL
 // ImGui GLFW binding with OpenGL
+// You can copy and use unmodified imgui_impl_* files in your project. 
+// If you use this binding you'll need to call 4 functions: ImGui_ImplXXXX_Init(), ImGui_ImplXXXX_NewFrame(), ImGui::Render() and ImGui_ImplXXXX_Shutdown(). 
+// See main.cpp for an example of using this.
 // https://github.com/ocornut/imgui
 // https://github.com/ocornut/imgui
 
 
 struct GLFWwindow;
 struct GLFWwindow;

+ 3 - 0
examples/sdl_opengl_example/imgui_impl_sdl.cpp

@@ -1,4 +1,7 @@
 // ImGui SDL2 binding with OpenGL
 // ImGui SDL2 binding with OpenGL
+// You can copy and use unmodified imgui_impl_* files in your project. 
+// If you use this binding you'll need to call 4 functions: ImGui_ImplXXXX_Init(), ImGui_ImplXXXX_NewFrame(), ImGui::Render() and ImGui_ImplXXXX_Shutdown().
+// See main.cpp for an example of using this.
 // https://github.com/ocornut/imgui
 // https://github.com/ocornut/imgui
 
 
 #include <SDL.h>
 #include <SDL.h>

+ 3 - 0
examples/sdl_opengl_example/imgui_impl_sdl.h

@@ -1,4 +1,7 @@
 // ImGui SDL2 binding with OpenGL
 // ImGui SDL2 binding with OpenGL
+// You can copy and use unmodified imgui_impl_* files in your project. 
+// If you use this binding you'll need to call 4 functions: ImGui_ImplXXXX_Init(), ImGui_ImplXXXX_NewFrame(), ImGui::Render() and ImGui_ImplXXXX_Shutdown().
+// See main.cpp for an example of using this.
 // https://github.com/ocornut/imgui
 // https://github.com/ocornut/imgui
 
 
 struct SDL_Window;
 struct SDL_Window;