Cool_Tools/imgui
1
0
Fork 0
mirror of https://github.com/ocornut/imgui.git synced 2024-11-14 11:07:48 +01:00
Code Releases Wiki Activity

Reorganizing main wiki index

omar 2021-02-22 12:26:21 +01:00
parent f19674638e
commit b7dec4ccdc
1 changed files with 79 additions and 40 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

119
Home.md

@ -6,65 +6,104 @@ Welcome to the Dear ImGui wiki! Feel free to edit and contribute!
Thank you to every past and present [[Sponsors]] for making this project possible.
## Discussions
## General documentation
- [Github Forum](https://github.com/ocornut/imgui/issues/) - for feature requests, bug reports, feedback, code snippets, etc. If you are experienced with Dear ImGui, please consider helping people and answering questions there!
- [Discord Forum](https://discordapp.com/channels/613733622192668672/613733622721019908) / [Discord Invite](https://discord.gg/NgJ4SEP) - if you have issues compiling, linking, running or displaying Dear ImGui (render or inputs, portability issues, using the examples, adding fonts). If you are experienced with Dear ImGui, please consider helping people and answering questions there!
- It is better to use GitHub: questions and answers will be available to others and you can search for old questions. It is more likely you will receive a correct and detailed answer on GitHub. However, please read the [Issues Submitting Guidelines](https://github.com/ocornut/imgui/issues/2261) thoroughly before opening a new thread.
## Wiki Pages
- **[[Language bindings, Framework/Engine bindings/backends|Bindings]]**
- **[[FAQ (Frequently Asked Questions)|https://github.com/ocornut/imgui/blob/master/docs/FAQ.md]]**
- **[[Useful widgets gallery|Useful-widgets]]**
- [[FAQ (Frequently Asked Questions)|https://github.com/ocornut/imgui/blob/master/docs/FAQ.md]] (docs/FAQ.md)
- [Homepage Readme](https://github.com/ocornut/imgui/blob/master/docs/README.md) (docs/README.md)
- [[Glossary|Glossary]]
- [[Software using dear imgui|Software-using-dear-imgui]]
- [[Software using Dear ImGui|Software-using-dear-imgui]]
- [[User quotes|Quotes]]
- [[Incoming work|Incoming-work]]
- [[Tips|Tips]] (for people working _with_ dear imgui)
- [[Developer tips|Developer-Tips]] (for people working _on_ dear imgui)
- [Releases / Changelogs](https://github.com/ocornut/imgui/releases) with annotation and pictures.
## Documentation
## Community
- Repo: [docs/FAQ.md](https://github.com/ocornut/imgui/blob/master/docs/FAQ.md): FAQ (Frequently Asked Questions
- Repo: [docs/BACKENDS.md](https://github.com/ocornut/imgui/blob/master/docs/BACKENDS.md): About Backends
- Repo: [docs/EXAMPLES.md](https://github.com/ocornut/imgui/blob/master/docs/EXAMPLES.md): About Examples app
- Repo: [docs/README.md](https://github.com/ocornut/imgui/blob/master/docs/README.md): Main Readme
- Repo: [docs/FONTS.md](https://github.com/ocornut/imgui/blob/master/docs/FONTS.md): Using Fonts
- Repo: [docs/](https://github.com/ocornut/imgui/tree/master/docs): Other files: Changelog, Todo
- Wiki: [[Image Loading and Displaying Examples|Image-Loading-and-Displaying-Examples]]
- Wiki: [[Docking|Docking]]
- Wiki: [[Multi-Viewports|Multi-Viewports]]
- Third-party: @pthom's [imgui_manual](https://pthom.github.io/imgui_manual_online/manual/imgui_manual.html): imgui_demo.cpp with interactive browsing of sources
- [Github Issues](https://github.com/ocornut/imgui/issues/): for feature requests, bug reports, feedback, code snippets, etc. Searching there is recommended as many topics have been discussed and referenced already!
- [Discord Chat](https://discordapp.com/channels/613733622192668672/613733622721019908) / [Invite](https://discord.gg/NgJ4SEP): general chat room. prefer if you have issues getting started.
- [#2261](https://github.com/ocornut/imgui/issues/2261) How to open an Issue or Pull Request
- [[Help wanted|Help-wanted]]
## Issues: Some Important Topics
Prefer using GitHub Issues: questions and answers will be available to others and searchable. It is more likely you will receive a correct and detailed answer on GitHub.
- [#3740](https://github.com/ocornut/imgui/issues/3740) Tables
- [#2109](https://github.com/ocornut/imgui/issues/2109) Docking branch available for testing
- [#1542](https://github.com/ocornut/imgui/issues/1542) Multi-viewports / virtual-viewports feature (in Docking branch)
- [#2117](https://github.com/ocornut/imgui/issues/2117) Linux/Mac compatibility of the multi-viewport branch
- [#3488](https://github.com/ocornut/imgui/issues/3488) Gallery
- [#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.
If you are experienced with Dear ImGui, please consider helping people and answering questions on Issues and Discord!
## Gallery
- [#3793](https://github.com/ocornut/imgui/issues/3793) Gallery: Post your screenshots / code here
- [[Useful widgets gallery|Useful-widgets]]
## Notable branches
- [master](https://github.com/ocornut/imgui/tree/master) branch
- [docking](https://github.com/ocornut/imgui/tree/docking) branch (fully maintained): include [Docking](https://github.com/ocornut/imgui/wiki/docking) + [Multi-Viewports](https://github.com/ocornut/imgui/wiki/multi-viewports) features.
## Demo, Examples
- [About Examples apps](https://github.com/ocornut/imgui/blob/master/docs/EXAMPLES.md) (docs/EXAMPLES.md)
- The [examples/](https://github.com/ocornut/imgui/tree/master/examples) folder contains 21 standalone example application for varieties of platforms and frameworks.
- The [imgui_demo.cpp](https://github.com/ocornut/imgui/tree/master/imgui_demo.cpp) file has a `ImGui::ShowDemoWindow()` function which you can call from any imgui-enabled application to showcase variety of features. The demo function is called from all examples/ apps.
- Third-party: @pthom's [imgui_manual](https://pthom.github.io/imgui_manual_online/manual/imgui_manual.html): web version of imgui_demo with interactive browsing of sources.
## Backends, Bindings
- [About Backends](https://github.com/ocornut/imgui/blob/master/docs/BACKENDS.md) (docs/BACKENDS.md)
- The [backends/](https://github.com/ocornut/imgui/tree/master/backends) folder contains 16 reusable backends for varieties of platforms and frameworks.
- [List of language bindings](https://github.com/ocornut/imgui/wiki/Bindings#language-bindings) (C, C#, D, Go, JavaScript, Lua, Rust and many others)
- [List of engine/framework backends](https://github.com/ocornut/imgui/wiki/Bindings#frameworkengine-bindingsbackends)
## Third-party extensions
- [[List of useful third-party widgets and extensions|Useful-widgets]]
## Images
- Tutorial: [[Image Loading and Displaying Examples|Image-Loading-and-Displaying-Examples]]
## Fonts/Text
- Read: [Using Fonts](https://github.com/ocornut/imgui/blob/master/docs/FONTS.md) (docs/FONTS.md)
- Search in Issues: [font/text](https://github.com/ocornut/imgui/issues?q=label%3Afont%2Ftext+)
- Freetype renderer: [imgui_freetype](https://github.com/ocornut/imgui/tree/master/misc/freetype) (misc/freetype)
## Tables
- [#3740](https://github.com/ocornut/imgui/issues/3740) Tables Topic (1.80+)
- Search in Issues: [tables/columns](https://github.com/ocornut/imgui/issues?q=label%3Atables%2Fcolumns+)
## Docking
- [[About Docking|Docking]]
- Search in Issues: [docking](https://github.com/ocornut/imgui/issues?q=label%3Adocking+)
- [#2109](https://github.com/ocornut/imgui/issues/2109) Main Docking topic
- [List of legacy third-party Docking extensions](https://github.com/ocornut/imgui/wiki/Docking#legacy-third-party-docking-extensions) (prior to official docking: LumixEngine, imguiDock, ImWindow, imgui_wm, etc.)
## Multi-viewports
- [[Multi-Viewports|Multi-Viewports]]
- Search in Issues: [multi-viewports](https://github.com/ocornut/imgui/issues?q=label%3Amulti-viewports+)
- [#1542](https://github.com/ocornut/imgui/issues/1542) Main Multi-viewports topic
- [#2117](https://github.com/ocornut/imgui/issues/2117) Linux/Mac compatibility of multi-viewports
## Inputs
- Search in Issues: [inputs](https://github.com/ocornut/imgui/issues?q=label%3Ainputs)
- Input / IO queue for very low framerate applications: [gist](https://gist.github.com/ocornut/8417344f3506790304742b07887adf9f)
-----
-----
# References
### Useful Widgets
See [[Useful Widgets|Useful-widgets]] page for a gallery of third-party widgets/extensions.
### Releases / Changelog
See [Releases](https://github.com/ocornut/imgui/releases) page for annotated changelog with nice pictures.
### Miscellaneous
- Also see https://github.com/ocornut/imgui/labels for categorized issues.
- imgui_freetype renderer: [imgui/misc/freetype/](https://github.com/ocornut/imgui/tree/master/misc/freetype) (in main repo)
- Input / IO queue for very low framerate applications: https://gist.github.com/ocornut/8417344f3506790304742b07887adf9f
- [List of legacy third-party Docking extensions](https://github.com/ocornut/imgui/wiki/Docking#legacy-third-party-docking-extensions) (LumixEngine, imguiDock, ImWindow, imgui_wm, etc. all prior to official docking branch [#2109](https://github.com/ocornut/imgui/issues/2109))
### Building / Packaging Cruft
- [#1713](https://github.com/ocornut/imgui/pull/1713) CMake project to build Examples (PR) by @podsvirov
- CMake https://github.com/ocornut/imgui/pull/1713 (unmerged PR, please send feedback)
- CMake https://github.com/ocornut/imgui/pull/3027 (unmerged PR, please send feedback)
- CMake https://gist.github.com/rokups/f771217b2d530d170db5cb1e08e9a8f4 (self-contained single-file build script)