From d673db30921969eaa6c1424f9b2978a84dbfbf0f Mon Sep 17 00:00:00 2001 From: ocornut Date: Sun, 29 Nov 2015 11:01:50 +0000 Subject: [PATCH] Examples: Added README into the Visual Studio solution to people are less likely to miss it. --- examples/README.txt | 14 ++++++++------ .../directx11_example/directx11_example.vcxproj | 3 +++ .../directx11_example.vcxproj.filters | 3 +++ examples/directx9_example/directx9_example.vcxproj | 3 +++ .../directx9_example.vcxproj.filters | 3 +++ examples/opengl3_example/opengl3_example.vcxproj | 3 +++ .../opengl3_example.vcxproj.filters | 3 +++ examples/opengl_example/opengl_example.vcxproj | 3 +++ .../opengl_example/opengl_example.vcxproj.filters | 3 +++ 9 files changed, 32 insertions(+), 6 deletions(-) diff --git a/examples/README.txt b/examples/README.txt index 2674d6e6c..575dbd090 100644 --- a/examples/README.txt +++ b/examples/README.txt @@ -2,15 +2,17 @@ Those are standalone ready-to-build applications to demonstrate ImGui. Binaries of some of those demos are available at http://www.miracleworld.net/imgui/binaries TL;DR; - Newcomers, read 'Programmer guide' imgui.cpp for notes on how to setup ImGui in your codebase. - Refer to 'opengl_example' to understand how the library is setup, because it is the simplest one. - Copy the imgui_impl_xxx.cpp/.h files you need if you are using one of provided rendering/IO backends. - If using different or your own backend, copy opengl_example/imgui_impl_opengl.cpp/.h to get started. - + - 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. + The other examples requires more boilerplate and are harder to read. + - 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 + your engine, but you can read the other examples as well. ImGui is highly portable and only requires a few things to run: - Providing mouse/keyboard inputs - - Load the font atlas texture into GPU memory + - 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. diff --git a/examples/directx11_example/directx11_example.vcxproj b/examples/directx11_example/directx11_example.vcxproj index d3dcd0ea0..944c8e863 100644 --- a/examples/directx11_example/directx11_example.vcxproj +++ b/examples/directx11_example/directx11_example.vcxproj @@ -150,6 +150,9 @@ + + + diff --git a/examples/directx11_example/directx11_example.vcxproj.filters b/examples/directx11_example/directx11_example.vcxproj.filters index ac905dd3e..5cd0ca415 100644 --- a/examples/directx11_example/directx11_example.vcxproj.filters +++ b/examples/directx11_example/directx11_example.vcxproj.filters @@ -39,4 +39,7 @@ imgui + + + \ No newline at end of file diff --git a/examples/directx9_example/directx9_example.vcxproj b/examples/directx9_example/directx9_example.vcxproj index 737bddb6e..83932c55a 100644 --- a/examples/directx9_example/directx9_example.vcxproj +++ b/examples/directx9_example/directx9_example.vcxproj @@ -150,6 +150,9 @@ + + + diff --git a/examples/directx9_example/directx9_example.vcxproj.filters b/examples/directx9_example/directx9_example.vcxproj.filters index 4952cebc3..5cf028343 100644 --- a/examples/directx9_example/directx9_example.vcxproj.filters +++ b/examples/directx9_example/directx9_example.vcxproj.filters @@ -40,4 +40,7 @@ imgui + + + \ No newline at end of file diff --git a/examples/opengl3_example/opengl3_example.vcxproj b/examples/opengl3_example/opengl3_example.vcxproj index e935ec2be..8d8bec90f 100644 --- a/examples/opengl3_example/opengl3_example.vcxproj +++ b/examples/opengl3_example/opengl3_example.vcxproj @@ -163,6 +163,9 @@ + + + diff --git a/examples/opengl3_example/opengl3_example.vcxproj.filters b/examples/opengl3_example/opengl3_example.vcxproj.filters index d3539e7ff..f19cd16b2 100644 --- a/examples/opengl3_example/opengl3_example.vcxproj.filters +++ b/examples/opengl3_example/opengl3_example.vcxproj.filters @@ -52,4 +52,7 @@ imgui + + + \ No newline at end of file diff --git a/examples/opengl_example/opengl_example.vcxproj b/examples/opengl_example/opengl_example.vcxproj index 6d6ac6b76..4b354b6f5 100644 --- a/examples/opengl_example/opengl_example.vcxproj +++ b/examples/opengl_example/opengl_example.vcxproj @@ -160,6 +160,9 @@ + + + diff --git a/examples/opengl_example/opengl_example.vcxproj.filters b/examples/opengl_example/opengl_example.vcxproj.filters index a6b5f8210..f2282bf69 100644 --- a/examples/opengl_example/opengl_example.vcxproj.filters +++ b/examples/opengl_example/opengl_example.vcxproj.filters @@ -40,4 +40,7 @@ imgui + + + \ No newline at end of file