mirror of
https://github.com/Drezil/imgui.git
synced 2024-11-29 23:06:35 +00:00
122 lines
8.6 KiB
Markdown
122 lines
8.6 KiB
Markdown
ImGui
|
|
=====
|
|
[](https://travis-ci.org/ocornut/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. It is based on an "immediate" graphical user interface paradigm which allows you to build user interfaces with ease.
|
|
|
|
ImGui is designed to enable fast iteration and allow programmers to create "content creation" or "debug" tools (as opposed to UI for the average end-user). It favors simplicity and productivity toward this goal, and thus lacks certain features normally found in more high-level libraries.
|
|
|
|
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.
|
|
|
|
ImGui is self-contained within 4 files that you can easily copy and compile into your application/engine:
|
|
|
|
- imgui.cpp
|
|
- imgui.h
|
|
- imconfig.h (empty by default, user-editable)
|
|
- stb_textedit.h
|
|
|
|
Your code passes mouse/keyboard inputs and settings to ImGui (see example applications for more details). After ImGui is setup, you can use it like in this example:
|
|
|
|
|
|
|
|
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.
|
|
|
|
ImGui allows you create elaborate tools as well as very short-lived ones. On the extreme side of short-liveness: using the Edit&Continue feature of compilers you can add a few widgets to tweaks variables while your application is running, and remove the code a minute later! ImGui is not just for tweaking values. You can use it to trace a running algorithm by just emitting text commands. You can use it along with your own reflection data to browse your dataset live. You can use it to expose the internals of a subsystem in your engine, to create a logger, an inspection tool, a profiler, a debugger, etc.
|
|
|
|
Gallery
|
|
-------
|
|
|
|
|
|
|
|
|
|
|
|
|
|
UTF-8 is supported for text display and input. Here using M+ font to display Japanese:
|
|
|
|
|
|
|
|
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.
|
|
- [Johannes 'johno' Norneby's article](http://www.johno.se/book/imgui.html).
|
|
- [A presentation by Rickard Gustafsson and Johannes Algelind](http://www.cse.chalmers.se/edu/year/2011/course/TDA361/Advanced%20Computer%20Graphics/IMGUI.pdf).
|
|
- [Jari Komppa's tutorial on building an ImGui library](http://iki.fi/sol/imgui/).
|
|
- [Casey Muratori's original video that popularized the concept](https://mollyrocket.com/861).
|
|
|
|
Frequently Asked Question
|
|
-------------------------
|
|
|
|
<b>Where are samples?</b>
|
|
|
|
The bulk of example user code is contained within the ImGui::ShowTestWindow() function. It covers most features of ImGui so you can read the code and call the function itself to see its output. Ready-to-go example applications covering different versions of OpenGL/DirectX are provided in the examples/ folder.
|
|
|
|
<b>How do you use ImGui on a platform that may not have a mouse or keyboard?</b>
|
|
|
|
I recommend using [Synergy](http://synergy-project.org). With the uSynergy.c micro client running on your platform and connecting to your PC, you can seamlessly use your PC input devices from a video game console or a tablet. ImGui allows to increase the hit box of widgets (via the _TouchPadding_ setting) to accomodate a little for the lack of precision of touch inputs, but it is recommended you use a mouse to allow optimising for screen real-estate.
|
|
|
|
<b>I integrated ImGui in my engine and the text or lines are blurry..</b>
|
|
|
|
- Try adjusting ImGui::GetIO().PixelCenterOffset to 0.0f or 0.5f.
|
|
- In your Render function, try translating your projection matrix by (0.5f,0.5f) or (0.375f,0.375f).
|
|
|
|
<b>Can you create elaborate/serious tools with ImGui?</b>
|
|
|
|
Yes. I have written data browsers, debuggers, profilers and all sort of non-trivial tools with the library. There's no reason you cannot, and in my experience the simplicity of the API is very empowering. However note that ImGui is programmer centric and the immediate-mode GUI paradigm might requires a bit of adaptation before you can realize its full potential.
|
|
|
|
<b>Is ImGui fast?</b>
|
|
|
|
Down the fundation of its visual design, ImGui is engineered to be fairly performant both in term of CPU and GPU usage. Running elaborate code and creating elaborate UI will of course have a cost but ImGui aims to minimize it.
|
|
|
|
Mileage may vary but the following screenshot should give you an idea of the cost of running and rendering UI code (In the case of a trivial demo application like this one, your driver/os setup may be a bottleneck and cause higher variation or throttled framerate. Testing performance as part of a real application is recommended).
|
|
|
|
|
|
|
|
This is showing framerate on my 2011 iMac running Windows 7, OpenGL, AMD Radeon HD 6700M. ([click here for the full-size picture](/web/performance_01.png)).
|
|
In contrast, librairies featuring higher-quality rendering and layouting techniques may have a higher resources footprint.
|
|
|
|
<b>Can you reskin the look of ImGui?</b>
|
|
|
|
Yes, you can alter the look of the interface to some degree: changing colors, sizes and padding, font. However, as ImGui is designed and optimised to create debug tools, the amount of skinning you can apply is limited. There is only so much you can stray away from the default look and feel of the interface. The example below uses modified settings to create a very compact UI with different colors:
|
|
|
|
|
|
|
|
<b>Why using C++ (as opposed to C)?</b>
|
|
|
|
ImGui takes advantage of a few C++ features for convenience but nothing in the realm of Boost-insanity/quagmire. In particular, function overloading and default parameters are used to make the API easier to use and code more terse. Doing so I believe the API is sitting on a sweet spot and giving up on those features would make the API more cumbersome. Other features such as namespace, constructors and templates (in the case of the ImVector<> class) are also relied on as a convenience but could be removed.
|
|
|
|
Shall someone wants to use ImGui from another language, it should be possible to wrap ImGui to be used from a raw C API in the future.
|
|
|
|
Donate
|
|
------
|
|
|
|
<b>Can I donate to support the development of ImGui?</b>
|
|
|
|
Yes please! I have setup an [**ImGui Patreon page**](http://www.patreon.com/imgui) if you want to donate and enable me to spend more time improving the library. If your company uses ImGui on a commercial project please consider making a small contribution. One-off donations are also greatly appreciated. I am also available for hire to work on or with ImGui. Thanks!
|
|
|
|
Credits
|
|
-------
|
|
|
|
Developed by [Omar Cornut](http://www.miracleworld.net) and every direct or indirect contributors to the GitHub. The early version of this 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).
|
|
|
|
Embeds [proggy_clean](http://upperbounds.net) font by Tristan Grimmer (MIT license).
|
|
Embeds [M+ fonts](http://mplus-fonts.sourceforge.jp/mplus-outline-fonts/index-en.html) font by Coji Morishita (free software license).
|
|
Embeds [stb_textedit.h](https://github.com/nothings/stb/) by Sean Barrett (public domain).
|
|
|
|
Inspiration, feedback, and testing for early versions: Casey Muratori, Atman Binstock, Mikko Mononen, Emmanuel Briney, Stefan Kamoda, Anton Mikhailov, Matt Willis. And everybody posting feedback, questions and patches on the GitHub.
|
|
|
|
ImGui is financially supported on [**Patreon**](http://www.patreon.com/imgui).
|
|
|
|
Special supporters
|
|
- Jetha Chan
|
|
|
|
Supporters
|
|
- Michel Courtine
|
|
|
|
And other supporters; thanks!
|
|
|
|
License
|
|
-------
|
|
|
|
ImGui is licensed under the MIT License, see LICENSE for more information.
|