1
0
mirror of https://github.com/ocornut/imgui.git synced 2024-11-17 20:37:20 +01:00
imgui/examples
2015-11-29 11:25:15 +00:00
..
allegro5_example Examples: Header comments. 2015-11-29 11:25:15 +00:00
directx9_example Examples: Header comments. 2015-11-29 11:25:15 +00:00
directx11_example Examples: Header comments. 2015-11-29 11:25:15 +00:00
ios_example Examples: Possibly clarified the intent of imgui_impl_* files. 2015-10-13 17:53:43 +02:00
libs Examples: OpenGL3: Fixed gl3w.c for Linux when compiled with C++ compiler (#411) 2015-11-22 17:16:55 +00:00
marmalade_example Examples: Header comments. 2015-11-29 11:25:15 +00:00
opengl3_example Examples: Header comments. 2015-11-29 11:25:15 +00:00
opengl_example Examples: Header comments. 2015-11-29 11:25:15 +00:00
sdl_opengl3_example Examples: Header comments. 2015-11-29 11:25:15 +00:00
sdl_opengl_example Examples: Header comments. 2015-11-29 11:25:15 +00:00
.gitignore Tweak build batch files and readmes 2015-11-16 22:03:13 +01:00
imgui_examples_msvc2010.sln Examples: Added 64-bit projects for MSVC 2015-03-14 10:09:53 +00:00
README.txt Examples: Added README into the Visual Studio solution to people are less likely to miss it. 2015-11-29 11:01:50 +00:00

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' 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 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 2015 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
 - Batch files for Visual Studio 2008+
 - A .sln project file for Visual Studio 2010+ 
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.

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.)

opengl3_example/
    OpenGL example, using GLFW/GL3W + programmable pipeline.
    This uses more modern OpenGL calls and custom shaders. It's more messy.

directx9_example/
    DirectX9 example, Windows only.
	
directx11_example/
    DirectX11 example, Windows only.
    This is quite long and tedious, because: DirectX11.
	
ios_example/
    iOS example.
    Using Synergy to access keyboard/mouse data from server computer.
    Synergy keyboard integration is rather hacky.

sdl_opengl_example/
    SDL2 + OpenGL example.

sdl_opengl_example/
    SDL2 + OpenGL3 example.

allegro5_example/
    Allegro 5 example.
	 
marmalade_example/
    Marmalade example using IwGx