github
/
imgui
mirror of https://github.com/ocornut/imgui.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
62 Commits
10 Branches
123 Tags
348 MiB
 
 
 
Tree: 152878571e
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '152878571e'
${ noResults }
ocornut 152878571e
TreeNode/CollapsingHeader ignore clicks when CTRL or SHFIT are held + make default button hover brighter 		10 years ago
examples Tidying up example applications so it looks easier to just grab code 10 years ago
web Update README.md 10 years ago
.gitignore Git ignore imgui.ini files 10 years ago
LICENSE Initial release 10 years ago
README.md Update README.md 10 years ago
imconfig.h Default "local only" clipboard handler on non-Windows platforms 10 years ago
imgui.cpp TreeNode/CollapsingHeader ignore clicks when CTRL or SHFIT are held + make default button hover brighter 10 years ago
imgui.h Added storage for up to 5 mouse buttons for convenience (even though ImGui itself only uses 1) 10 years ago
stb_textedit.h Initial release 10 years ago

README.md

ImGui

ImGui is a bloat-free graphical user interface library for C++. It outputs vertex buffers that you can render in your 3D-pipeline enabled application. It is portable, renderer agnostic and carries minimal amount of dependencies (only 3 files are needed). It is based on an "immediate" graphical user interface paradigm which allows you to build simple user interfaces with ease.

ImGui is designed to enable fast iteration and allow programmers to create "content creation" or "debug" tools (as opposed to tools for the average end-user). It favors simplicity and thus lacks certain features normally found in more high-level libraries, such as string localisation.

ImGui is particularly suited to integration in 3D applications, fullscreen applications, embedded applications, games, or any applications on consoles platforms where operating system features are non-standard.

After ImGui is setup in your engine, you can use it like in this example:

screenshot of sample code alongside its output with ImGui

ImGui outputs vertex buffers and simple command-lists that you can render in your application. Because it doesn't know or touch graphics state directly, you can call ImGui commands anywhere in your code (e.g. in the middle of a running algorithm, or in the middle of your own rendering process). Refer to the sample applications in the examples/ folder for instructions on how to integrate ImGui with your existing codebase.

Gallery

screenshot 1 screenshot 2 screenshot 3 screenshot 4

References

The Immediate Mode GUI paradigm may at first appear unusual to some users. This is mainly because "Retained Mode" GUIs have been so widespread and predominant. The following links can give you a better understanding about how Immediate Mode GUIs works.

Credits

Developed by Omar Cornut. The library was developed with the support of Media Molecule and first used internally on the game Tearaway.

Embeds proggy_clean font by Tristan Grimmer (also MIT license).

Inspiration, feedback, and testing: Casey Muratori, Atman Binstock, Mikko Mononen, Emmanuel Briney, Stefan Kamoda, Matt Willis. Thanks!

License

ImGui is licensed under the MIT License, see LICENSE for more information.