From 3c384c2f105a787cc0aebeca0bd1af073d9ffa4e Mon Sep 17 00:00:00 2001 From: ocornut Date: Thu, 25 Aug 2016 10:18:09 +0200 Subject: [PATCH] Examples: Renaming opengl_example/ to opengl2_example/ for clarity (1/2 because git) --- examples/README.txt | 23 ++++++++++--------- examples/imgui_examples_msvc2010.sln | 2 +- .../Makefile | 2 +- .../build_win32.bat | 0 .../imgui_impl_glfw.cpp | 0 .../imgui_impl_glfw.h | 0 .../main.cpp | 0 .../opengl_example.vcxproj | 0 .../opengl_example.vcxproj.filters | 0 .../README.md | 0 .../imgui_impl_sdl.cpp | 0 .../imgui_impl_sdl.h | 0 .../main.cpp | 0 imgui.cpp | 2 +- 14 files changed, 15 insertions(+), 14 deletions(-) rename examples/{opengl_example => opengl2_example}/Makefile (98%) rename examples/{opengl_example => opengl2_example}/build_win32.bat (100%) rename examples/{opengl_example => opengl2_example}/imgui_impl_glfw.cpp (100%) rename examples/{opengl_example => opengl2_example}/imgui_impl_glfw.h (100%) rename examples/{opengl_example => opengl2_example}/main.cpp (100%) rename examples/{opengl_example => opengl2_example}/opengl_example.vcxproj (100%) rename examples/{opengl_example => opengl2_example}/opengl_example.vcxproj.filters (100%) rename examples/{sdl_opengl_example => sdl_opengl2_example}/README.md (100%) rename examples/{sdl_opengl_example => sdl_opengl2_example}/imgui_impl_sdl.cpp (100%) rename examples/{sdl_opengl_example => sdl_opengl2_example}/imgui_impl_sdl.h (100%) rename examples/{sdl_opengl_example => sdl_opengl2_example}/main.cpp (100%) diff --git a/examples/README.txt b/examples/README.txt index df2e86dab..5a1c8df40 100644 --- a/examples/README.txt +++ b/examples/README.txt @@ -8,11 +8,13 @@ Third party languages and frameworks bindings: https://github.com/ocornut/imgui/ TL;DR; - Newcomers, read 'PROGRAMMER GUIDE' in imgui.cpp for notes on how to setup ImGui in your codebase. - - Refer to 'opengl_example' to understand how the library is setup, it is the simplest one. + - Refer to 'opengl2_example' to LEARN how the library is setup, it is the simplest one. The other examples requires more boilerplate and are harder to read. + - If you are using OpenGL in your application, probably use an opengl3_xxx backend. + Mixing old fixed pipeline OpenGL2 and programmable pipeline OpenGL3+ isn't well supported by drivers. - If you are using of the backend provided here, so you can copy the imgui_impl_xxx.cpp/h files to your project and use them unmodified. - - If you have your own engine, you probably want to start from 'opengl_example' and adapt it to + - If you have your own engine, you probably want to start from one of the OpenGL example and adapt it to your engine, but you can read the other examples as well. ImGui is highly portable and only requires a few things to run: @@ -41,15 +43,14 @@ 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). -opengl_example/ - OpenGL example, using GLFW + fixed pipeline. - This is simple and should work for all OpenGL enabled applications. - Prefer following this example to learn how ImGui works! - (You can use this code in a GL3/GL4 context but make sure you disable the programmable pipeline - by calling "glUseProgram(0)" before ImGui::Render.) +opengl2_example/ + GLFW + OpenGL example (old fixed pipeline). + This is simple to read. Prefer following this example to learn how ImGui works! + (You might be able to use this code in a GL3/GL4 context but make sure you disable the programmable + pipeline by calling "glUseProgram(0)" before ImGui::Render.) opengl3_example/ - OpenGL example, using GLFW/GL3W + programmable pipeline. + GLFW + OpenGL example (programmable pipeline, binding modern functions with GL3W). This uses more modern OpenGL calls and custom shaders. It's more messy. directx9_example/ @@ -68,8 +69,8 @@ apple_example/ On iOS, Using Synergy to access keyboard/mouse data from server computer. Synergy keyboard integration is rather hacky. -sdl_opengl_example/ - SDL2 + OpenGL example. +sdl_opengl2_example/ + SDL2 + OpenGL example (old fixed pipeline). sdl_opengl3_example/ SDL2 + OpenGL3 example. diff --git a/examples/imgui_examples_msvc2010.sln b/examples/imgui_examples_msvc2010.sln index b7e6a2522..16f0d60b5 100644 --- a/examples/imgui_examples_msvc2010.sln +++ b/examples/imgui_examples_msvc2010.sln @@ -1,7 +1,7 @@  Microsoft Visual Studio Solution File, Format Version 11.00 # Visual Studio 2010 -Project("{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}") = "opengl_example", "opengl_example\opengl_example.vcxproj", "{9CDA7840-B7A5-496D-A527-E95571496D18}" +Project("{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}") = "opengl2_example", "opengl_example\opengl2_example.vcxproj", "{9CDA7840-B7A5-496D-A527-E95571496D18}" EndProject Project("{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}") = "directx9_example", "directx9_example\directx9_example.vcxproj", "{4165A294-21F2-44CA-9B38-E3F935ABADF5}" EndProject diff --git a/examples/opengl_example/Makefile b/examples/opengl2_example/Makefile similarity index 98% rename from examples/opengl_example/Makefile rename to examples/opengl2_example/Makefile index 91d1b1422..bd79d1ba4 100644 --- a/examples/opengl_example/Makefile +++ b/examples/opengl2_example/Makefile @@ -10,7 +10,7 @@ #CXX = g++ -EXE = opengl_example +EXE = opengl2_example OBJS = main.o imgui_impl_glfw.o OBJS += ../../imgui.o ../../imgui_demo.o ../../imgui_draw.o diff --git a/examples/opengl_example/build_win32.bat b/examples/opengl2_example/build_win32.bat similarity index 100% rename from examples/opengl_example/build_win32.bat rename to examples/opengl2_example/build_win32.bat diff --git a/examples/opengl_example/imgui_impl_glfw.cpp b/examples/opengl2_example/imgui_impl_glfw.cpp similarity index 100% rename from examples/opengl_example/imgui_impl_glfw.cpp rename to examples/opengl2_example/imgui_impl_glfw.cpp diff --git a/examples/opengl_example/imgui_impl_glfw.h b/examples/opengl2_example/imgui_impl_glfw.h similarity index 100% rename from examples/opengl_example/imgui_impl_glfw.h rename to examples/opengl2_example/imgui_impl_glfw.h diff --git a/examples/opengl_example/main.cpp b/examples/opengl2_example/main.cpp similarity index 100% rename from examples/opengl_example/main.cpp rename to examples/opengl2_example/main.cpp diff --git a/examples/opengl_example/opengl_example.vcxproj b/examples/opengl2_example/opengl_example.vcxproj similarity index 100% rename from examples/opengl_example/opengl_example.vcxproj rename to examples/opengl2_example/opengl_example.vcxproj diff --git a/examples/opengl_example/opengl_example.vcxproj.filters b/examples/opengl2_example/opengl_example.vcxproj.filters similarity index 100% rename from examples/opengl_example/opengl_example.vcxproj.filters rename to examples/opengl2_example/opengl_example.vcxproj.filters diff --git a/examples/sdl_opengl_example/README.md b/examples/sdl_opengl2_example/README.md similarity index 100% rename from examples/sdl_opengl_example/README.md rename to examples/sdl_opengl2_example/README.md diff --git a/examples/sdl_opengl_example/imgui_impl_sdl.cpp b/examples/sdl_opengl2_example/imgui_impl_sdl.cpp similarity index 100% rename from examples/sdl_opengl_example/imgui_impl_sdl.cpp rename to examples/sdl_opengl2_example/imgui_impl_sdl.cpp diff --git a/examples/sdl_opengl_example/imgui_impl_sdl.h b/examples/sdl_opengl2_example/imgui_impl_sdl.h similarity index 100% rename from examples/sdl_opengl_example/imgui_impl_sdl.h rename to examples/sdl_opengl2_example/imgui_impl_sdl.h diff --git a/examples/sdl_opengl_example/main.cpp b/examples/sdl_opengl2_example/main.cpp similarity index 100% rename from examples/sdl_opengl_example/main.cpp rename to examples/sdl_opengl2_example/main.cpp diff --git a/imgui.cpp b/imgui.cpp index a8cddc646..a52903e29 100644 --- a/imgui.cpp +++ b/imgui.cpp @@ -80,7 +80,7 @@ - read the FAQ below this section! - your code creates the UI, if your code doesn't run the UI is gone! == very dynamic UI, no construction/destructions steps, less data retention on your side, no state duplication, less sync, less bugs. - call and read ImGui::ShowTestWindow() for demo code demonstrating most features. - - see examples/ folder for standalone sample applications. Prefer reading examples/opengl_example/ first as it is the simplest. + - see examples/ folder for standalone sample applications. Prefer reading examples/opengl2_example/ first as it is the simplest. you may be able to grab and copy a ready made imgui_impl_*** file from the examples/. - customization: PushStyleColor()/PushStyleVar() or the style editor to tweak the look of the interface (e.g. if you want a more compact UI or a different color scheme).