imgui/README.md

36 lines
1.7 KiB
Markdown
Raw Normal View History

2014-08-10 16:50:15 -05:00
ImGui
2014-07-21 09:29:48 -05:00
=====
2014-08-10 17:07:54 -05:00
ImGui is a bloat-free graphical user interface library for C/C++. 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.
2014-08-10 16:50:15 -05:00
2014-08-10 17:07:54 -05:00
ImGui is designed to 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.
2014-08-10 16:50:15 -05:00
2014-08-10 17:07:54 -05:00
Usage example:
2014-08-10 16:50:15 -05:00
![screenshot of sample code alongside its output with ImGui](/web/code_sample_01.png?raw=true)
2014-08-10 17:07:54 -05:00
ImGui output vertex buffer and simple command-list that you can render in application. Refer to the sample applications in the examples/ folder for instructions on how to integrate ImGui within your existing codebase.
2014-08-10 16:50:15 -05:00
Gallery
-------
![screenshot 1](/web/test_window_01.png?raw=true)
![screenshot 2](/web/test_window_02.png?raw=true)
![screenshot 3](/web/test_window_03.png?raw=true)
![screenshot 4](/web/test_window_04.png?raw=true)
Credits
-------
Developed by [Omar Cornut](http://www.miracleworld.net). The library was developed with the support of [Media Molecule](http://www.mediamolecule.com) and first used internally on the game [Tearaway](http://tearaway.mediamolecule.com).
2014-08-10 17:15:15 -05:00
Embeds [proggy_clean font](http://www.proggyfonts.net/) by Tristan Grimmer (also MIT license).
2014-08-10 17:14:00 -05:00
2014-08-10 16:50:15 -05:00
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.