Navy.gif/imgui
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Reworked index, moved Useful Widgets to their own section

omar 2020-10-26 15:28:24 +01:00
parent 79c6840189
commit 5f42a7f742
1 changed files with 18 additions and 127 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

145
Home.md

@ -1,6 +1,6 @@
| Index |
:----------------------------------------------------------: |
| [Discussions](#discussions) - [Wiki Pages](#Wiki-pages) - [Tutorials](#Tutorials) - [Useful Widgets & References](#Useful-widgets--references) - [External Articles, Videos, etc.](#external-articles-videos-blog-posts) |
| [Discussions](#discussions) - [Wiki Pages](#Wiki-pages) - [Tutorials](#Tutorials) - [References](#References) - [Articles, Videos, etc.](#articles-videos-blog-posts) |
Welcome to the Dear ImGui wiki! Always in construction - feel free to edit and contribute!
@ -15,7 +15,8 @@ Thank you to every past and present [[Sponsors]] for making this project possibl
## Wiki Pages
- **[[Language bindings, Framework/Engine bindings/backends|Bindings]]**
- [[FAQ (Frequently Asked Questions)|https://github.com/ocornut/imgui/blob/master/docs/FAQ.md]]
- **[[FAQ (Frequently Asked Questions)|https://github.com/ocornut/imgui/blob/master/docs/FAQ.md]]**
- **[[Useful widgets|Useful-widgets]]**
- [[Glossary|Glossary]]
- [[Software using dear imgui|Software-using-dear-imgui]]
- [[User quotes|Quotes]]
@ -24,14 +25,11 @@ Thank you to every past and present [[Sponsors]] for making this project possibl
- [[Tips|Tips]] (for people working _with_ dear imgui)
- [[Developer tips|Developer-Tips]] (for people working _on_ dear imgui)
## Features
- [[Docking|Docking]]
## Tutorials
- [[Fonts Documentation|https://github.com/ocornut/imgui/blob/master/docs/FONTS.md]]
- [[Image Loading and Displaying Examples|Image-Loading-and-Displaying-Examples]]
- [[Docking|Docking]]
## Issues: Some Important Topics
@ -43,128 +41,25 @@ Thank you to every past and present [[Sponsors]] for making this project possibl
- [#1713](https://github.com/ocornut/imgui/pull/1713) CMake project to build Examples (PR) by @podsvirov
- Also see https://github.com/ocornut/imgui/labels for categorized issues.
# Useful Widgets & References
# References
### Text Editors
### Useful Widgets
- ImGuiColorTextEdit: Colorizing text editor for ImGui [[github](https://github.com/BalazsJako/ImGuiColorTextEdit)]
- Zep: An embeddable editor, with optional support for using vim keystrokes. [[github](https://github.com/cmaughan/zep)]
- Scintilla integration [[thread](https://github.com/ocornut/imgui/issues/108)]
See [[Useful widgets|Useful-widgets]] page.
### Node Editors
- imgui-node-editor: https://github.com/thedmd/imgui-node-editor
- rokups/ImNodes: https://github.com/rokups/ImNodes
- Nelarius/imnodes: https://github.com/Nelarius/imnodes
- Many more in this thread: https://github.com/ocornut/imgui/issues/306
### Curves, Animations, Gradients
- Bezier widget (@r-lyeh) https://github.com/ocornut/imgui/issues/786
- ImSequencer (animation sequencer) https://github.com/CedricGuillemet/ImGuizmo
- ImGradient (gradient editor) https://github.com/CedricGuillemet/ImGuizmo
- ImCurveEdit (curve editor) https://github.com/CedricGuillemet/ImGuizmo
- Gradient color generator (@galloscript): https://gist.github.com/galloscript/8a5d179e432e062550972afcd1ecf112
### Plotting, Graph
- ImPlot (@epezent): https://github.com/epezent/implot and [#3173](https://github.com/ocornut/imgui/issues/3173), [#3067](https://github.com/ocornut/imgui/issues/3067)
- imgui-plot (@soulthreads): https://github.com/soulthreads/imgui-plot and [#2747](https://github.com/ocornut/imgui/issues/2747)
- Plotting widget for imgui (@mkalte666): https://github.com/mkalte666/imguiplot
- Flame graph widget: https://github.com/ocornut/imgui/issues/2859
- Plot var helper: [[plot_var_example]]
### File Browsers / File Dialog
- File browser: https://github.com/AirGuanZ/imgui-filebrowser
- File browser: https://github.com/gallickgunner/ImGui-Addons
- File browser: https://github.com/Flix01/imgui/wiki/ImGui-Addons-Branch-Home
- File browser: https://github.com/aiekick/ImGuiFileDialog
- File browser: https://github.com/Limeoats/L2DFileDialog
### Rich text
- Markdown: https://github.com/juliettef/imgui_markdown
- URL/Links: https://gist.github.com/dougbinks/ef0962ef6ebe2cadae76c4e9f0586c69#file-imguiutils-h-L228-L262
### Input Method Editor
- DearImGui-with-IMM32: Microsoft IME Overlay using Dear ImGui: https://github.com/maildrop/DearImGui-with-IMM32
### Misc
- Memory Editor: [imgui_club/imgui_memory_editor/](https://github.com/ocornut/imgui_club/tree/master/imgui_memory_editor)
- ImGuizmo (3d translation/rotation Gizmo) https://github.com/CedricGuillemet/ImGuizmo
- imGuiZMO.quat (3d translation/rotation Gizmo) https://github.com/BrutPitt/imGuIZMO.quat
- Splitters: https://github.com/ocornut/imgui/issues/319
- Slider 2D and Slider 3D: https://github.com/ocornut/imgui/issues/3484
- Spinner + Loading Bar progress indicators: https://github.com/ocornut/imgui/issues/1901
- ImHotKey (Hotkey Editor): https://github.com/CedricGuillemet/ImHotKey
- IP Entry Box (@adam4813) https://github.com/ocornut/imgui/issues/388
- Pie menu test: https://github.com/ocornut/imgui/issues/434
- nnview: a neural network viewer: https://github.com/lighttransport/nnview
- Knobs: https://github.com/ocornut/imgui/issues/942#issuecomment-268369298
- Toggle Button: https://github.com/ocornut/imgui/issues/1537
- ImGui::Auto(): leverage C++17 to serialize any structure into imgui interfaces https://github.com/Csabix/imgui/tree/master/auto
- LayoutWidget #2779 https://github.com/xpenatan/jDear-imgui/tree/master/extensions/imgui-layout-widget
- Issues "useful widgets" Tag: https://github.com/ocornut/imgui/labels/useful%20widgets
### Virtual Reality (VR) / Reprojected UI plane
- ImGuiVR: Demo code for using Imgui with OpenVR [[github](https://github.com/temcgraw/ImguiVR)] [[video](https://www.youtube.com/watch?v=nlwfn4HJw5E)]
- Desktop+ https://github.com/elvissteinjr/DesktopPlus
- BIMXplorer https://www.bimxplorer.com/
- mpFluid CAVE Front End https://github.com/sariug/mpfluid_cave_frontend
### Third party repos
- @flix01's addons: [ImGui-Addons-Branch-Home](https://github.com/Flix01/imgui/wiki/ImGui-Addons-Branch-Home) for instructions and [github repo](https://github.com/Flix01/imgui) for code.
- file dialog, date picker, listview, toolbar etc.
- @leiradel's snippets: https://github.com/leiradel/ImGuiAl/
- @nem0's snippets (in imgui_user.* files) https://github.com/nem0/LumixEngine/tree/master/external/imgui
- @aoterodelaroza's snippets [[github](https://github.com/aoterodelaroza/imgui-goodies)]
- MetricsGui: controls for displaying performance metrics [[github](https://github.com/GameTechDev/MetricsGui)]
### Software Renderer/Rasterizer
- Software Renderer for Dear ImGui [[github](https://github.com/emilk/imgui_software_renderer)] by @emilk
- Fast(er) Software Rasterizer for Dear ImGui [[github](https://github.com/malamanteau/ImFastRast)] by @malamanteau
- ImSoft (softraster for ImGui) [[github](https://github.com/LAK132/ImSoft)] by @LAK132
### Docking extensions
- **Official Docking Branch (October 2018): see [#2109](https://github.com/ocornut/imgui/issues/2109).**
- [old] old docking thread [#351](https://github.com/ocornut/imgui/issues/351)
- [old] @nem0's one (old LumixEngine docking), [github](https://github.com/nem0/LumixEngine/tree/v0.34/external/imgui)
- [old] @paniq's one (based on @nem0's), [github](https://github.com/ocornut/imgui/issues/351#issuecomment-219775521)
- [old] @BentleyBlanks's one (based on @paniq's), [github](https://github.com/BentleyBlanks/imguiDock)
- [old] @thennequin's ImWindow, with OS window managing, [github](https://github.com/thennequin/ImWindow)
- [old] imgui_wm: based on ImWindow, [github](https://github.com/bkaradzic/bgfx/tree/master/3rdparty/ocornut-imgui)
- [old] @edin-purkovic's one, [github](https://github.com/edin-purkovic/ImGuiDock)
- [old] @flix01's one, [github](https://github.com/Flix01/imgui/tree/2015-10-Addons/addons/imguidock)
- [old] @aoterodelaroza's one, [github](https://github.com/aoterodelaroza/imgui-goodies)
### Remoting
- RemoteImGui: send vertices over the network https://github.com/JordiRos/remoteimgui
- imgui-ws: Dear ImGui over WebSockets https://github.com/ggerganov/imgui-ws
- netImGui: Dear ImGui remote access library and application https://github.com/sammyfreg/netImgui
- Android GLES3 stub with RemoteImGui: https://github.com/CedricGuillemet/AndroidAppViewer
### Terminal / Text mode
- ImTui: Immediate Mode Text-based User Interface https://github.com/ggerganov/imtui
- tear imgui: Experiment for a terminal-based renderer for imgui https://github.com/jonvaldes/tear_imgui
### Midi/OSC interfacing
- midi2osc: midi to opensoundcontrol bridge https://github.com/mmalex/midi2osc
- devmidi: A simple MIDI input library that also dovetails into Dear ImGui https://github.com/antonthefirst/devmidi
### Other
### Miscellaneous
- imgui_freetype renderer: [imgui/misc/freetype/](https://github.com/ocornut/imgui/tree/master/misc/freetype) (in main repo)
- ImDuino (ESP32+TFT+ImSoft+ImGui example): https://github.com/LAK132/ImDuino
- Input / IO queue for very low framerate applications: https://gist.github.com/ocornut/8417344f3506790304742b07887adf9f
- [[Screenshot Tool|screenshot_tool]]
- Third-party Docking (prior to official docking branch [#2109](https://github.com/ocornut/imgui/issues/2109))
- [old] @nem0's one (old LumixEngine docking), [github](https://github.com/nem0/LumixEngine/tree/v0.34/external/imgui)
- [old] @paniq's one (based on @nem0's), [github](https://github.com/ocornut/imgui/issues/351#issuecomment-219775521)
- [old] @BentleyBlanks's one (based on @paniq's), [github](https://github.com/BentleyBlanks/imguiDock)
- [old] @thennequin's ImWindow, with OS window managing, [github](https://github.com/thennequin/ImWindow), refactored in bgfx's imgui_wm [github](https://github.com/bkaradzic/bgfx/tree/master/3rdparty/ocornut-imgui)
- [old] @edin-purkovic's one, [github](https://github.com/edin-purkovic/ImGuiDock)
- [old] @flix01's one, [github](https://github.com/Flix01/imgui/tree/2015-10-Addons/addons/imguidock)
- [old] @aoterodelaroza's one, [github](https://github.com/aoterodelaroza/imgui-goodies)
### Building / Packaging Cruft
@ -188,10 +83,6 @@ Thank you to every past and present [[Sponsors]] for making this project possibl
- Starter dear-imgui GLFW/OpenGL 3 based CMake C++ project: https://github.com/urddru/imgui-glfw
- Dear PyGui: A Simple Python GUI framework https://github.com/hoffstadt/DearPyGui
### Rust
- imgui-inspect: An inspector UI using imgui in Rust https://github.com/aclysma/imgui-inspect
### Notable forks
- https://github.com/adobe/imgui
@ -209,7 +100,7 @@ Thank you to every past and present [[Sponsors]] for making this project possibl
- im3d (Immediate mode rendering and 3d gizmos) https://github.com/john-chapman/im3d/projects
- small libraries with minimal dependencies https://github.com/nothings/single_file_libs
## External Articles, Videos, Blog Posts
## Articles, Videos, Blog Posts
### About the IMGUI paradigm
@ -221,7 +112,7 @@ Dear ImGui is one possible implementation of an idea generally described as the
- [Nicolas Guillemot's CppCon'16 flash-talk about Dear ImGui](https://www.youtube.com/watch?v=LSRJ1jZq90k), 2016.
- [Thierry Excoffier's ZMV (Zero Memory Widget)](http://perso.univ-lyon1.fr/thierry.excoffier/ZMW/), 2004.
Another notable uses of IMGUI paradigm include [Unity's own IMGUI widget library](https://docs.unity3d.com/Manual/GUIScriptingGuide.html), often informally referred to as `OnGUI()`, which is used to power the Unity editor and its extensions. This library is unrelated from Dear ImGui (different codebase, design, features and team). The IMGUI library used by Unity has in the past received mixed feedback from its users, presumably because it may have been perceived as a potential candidate for game-facing UI solutions, which it doesn't excel at. However Unity has since provided separate librairies to tackle that case, and their IMGUI library is still very much in use for the Unity Editor and has been its UI backbone for the past 12+ years.
Another notable uses of IMGUI paradigm include [Unity's own IMGUI widget library](https://docs.unity3d.com/Manual/GUIScriptingGuide.html), often informally referred to as `OnGUI()`, which is used to power the Unity editor and its extensions. This library is unrelated from Dear ImGui (different codebase, design, features and team). The IMGUI library used by Unity has in the past received mixed feedback from its users, presumably because it may have been perceived as a potential candidate for game-facing UI solutions, which it doesn't excel at. However Unity has since provided separate libraries to tackle that case, and their IMGUI library is still very much in use for the Unity Editor and has been its UI backbone for the past 12+ years.
### Articles About Dear ImGui