https://github.com/dinau/imguin_examples
The examples for ImGuin that ImGui wrapper for Nim language.
https://github.com/dinau/imguin_examples
cimgui example futhark glfw imgui imguifiledialog imguizmo imnodes implot nim opengl sdl2 sdl3
Last synced: 7 months ago
JSON representation
The examples for ImGuin that ImGui wrapper for Nim language.
- Host: GitHub
- URL: https://github.com/dinau/imguin_examples
- Owner: dinau
- License: mit
- Created: 2024-12-30T11:39:06.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-03-14T14:50:05.000Z (11 months ago)
- Last Synced: 2025-03-29T05:24:02.149Z (11 months ago)
- Topics: cimgui, example, futhark, glfw, imgui, imguifiledialog, imguizmo, imnodes, implot, nim, opengl, sdl2, sdl3
- Language: C
- Homepage:
- Size: 17.5 MB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
- [ImGuin examples project](#imguin-examples-project)
- [Usage: Sample program and run](#usage-sample-program-and-run)
- [Prerequisites](#prerequisites)
- [Build examples](#build-examples)
- [Available libraries](#available-libraries)
- [Screen shot (examples)](#screen-shot-examples)
- [glfw_opengl3](#glfw_opengl3)
- [glfw_opengl3_imknobs](#glfw_opengl3_imknobs)
- [glfw_opengl3_filedialog](#glfw_opengl3_filedialog)
- [glfw_opengl3_imgui_toggle](#glfw_opengl3_imgui_toggle)
- [glfw_opengl3_imspinner](#glfw_opengl3_imspinner)
- [glfw_opengl3_iconfont_viewer](#glfw_opengl3_iconfont_viewer)
- [glfw_opengl3_image_load / sdl2_opengl3](#glfw_opengl3_image_load--sdl2_opengl3)
- [sdl2_renderer / sdl3_renderer / sdl3_opengl3 / sdl3_sdlgpu3](#sdl2_renderer---sdl3_renderer---sdl3_opengl3--sdl3_sdlgpu3)
- [glfw_opengl3_image_save](#glfw_opengl3_image_save)
- [glfw_opengl3_jp](#glfw_opengl3_jp)
- [glfw_opengl3_implot](#glfw_opengl3_implot)
- [glfw_opengl3_implot3d](#glfw_opengl3_implot3d)
- [glfw_opengl3_imnodes](#glfw_opengl3_imnodes)
- [glfw_opengl3_imguizmo](#glfw_opengl3_imguizmo)
- [glfw_opengl3_imColorTextEdit](#glfw_opengl3_imcolortextedit)
- [glfw_opengl3_imgui_markdown](#glfw_opengl3_imgui_markdown)
- [My test app movie using imguin](#my-test-app-movie-using-imguin)
- [Cross compilation: Generating Windows application binary(\*.exe) on Linux OS](#cross-compilation-generating-windows-application-binary%5Cexe-on-linux-os)
- [Selection backend compiler](#selection-backend-compiler)
- [TODO](#todo)
- [Compressing binary file](#compressing-binary-file)
- [My tools version](#my-tools-version)
- [Other link](#other-link)
- [Similar project ImGui / CImGui](#similar-project-imgui--cimgui)
- [SDL Game tutorial Platfromer](#sdl-game-tutorial-platfromer)
- [Other link2](#other-link2)
- [Memo](#memo)
## ImGuin examples project
 
Confirmed **ImGuin** verion: **v1.92.0.1** ([Dear ImGui](https://github.com/ocornut/imgui)/[CImGui](https://github.com/cimgui/cimgui) version: 1.92.0) (2025/07)
This project is example project to use Dear ImGui, ImPlot and so on in Nim language.
Wrapper libraies used are here [ImGuin](https://github.com/dinau/imguin) [^notice]
[^notice]: It may be better to use the **mainstream** project [nimgl/imgui](https://github.com/nimgl/imgui) (ImGui v1.85)
,updated project [nimgl-imgui](https://github.com/dinau/nimgl-imgui) (ImGui v1.89.9) ,sub project [nim_implot](https://github.com/dinau/nim_implot) and test project [nimgl_test](https://github.com/dinau/nimgl_test),
or [https://github.com/daniel-j/nimgl-imgui](https://github.com/daniel-j/nimgl-imgui)(ImGui v1.91.1)
### Usage: Sample program and run
---
#### Prerequisites
---
- [Nim-2.0.16](https://nim-lang.org) or later
- Windows10 or later
[MSys2/MinGW installed](https://www.msys2.org/): Command line tools: make, cp, rm, git, ...etc
```sh
pacman -S mingw-w64-x86_64-{gcc,glfw} make
```
- Linux: Debian / Ubuntu families
```sh
$ sudo apt install gcc g++ make git
$ sudo apt install lib{opengl-dev,gl1-mesa-dev,glfw3,glfw3-dev,libsdl2-dev}
```
#### Build examples
---
1. First clone this project,
```sh
git clone https://github.com/dinau/imguin_examples
```
1. Install dependencies libraries,
```sh
cd imguin_examples
nimble refresh
nimble dep
```
1. For instance [glfw_opengl3_base.nim](glfw_opengl3_base/glfw_opengl3_base.nim),
```sh
pwd
imguin_examples/glfw_opengl3_base
make # or make run
```
After build, run `./glfw_opengl3_base(.exe)`
Compilation options depend on `./config.nims` and `./Makefile`.
1. Selecting static link or dynamic link.
If you'd like to build executables with static link (not using `*.dll`),
edit `./linkControl.nim` in respective example folder.
To not depend on any other `*.dll` files,
change to [^glfwStatic]
```nim
const STATIC_LINK_GLFW = true # if true, it doesn't need glfw3.dll
const STATIC_LINK_CC = true # if true, it doesn't need libstd++-6.dll
```
[^glfwStatic]: `STATIC_LINK_GLFW = false` can only be set at Dear ImGui 1.92.0 or later
#### Available libraries
---
Library name / C lang wrapper
- [x] [ImGui](https://github.com/ocornut/imgui) / [CImGui](https://github.com/cimgui/cimgui)
- [x] [ImPlot](https://github.com/epezent/implot) / [CImPlot](https://github.com/cimgui/cimplot)
- [x] [ImNodes](https://github.com/Nelarius/imnodes) / [CImNodes](https://github.com/cimgui/cimnodes)
- [x] [ImGuizmo](https://github.com/CedricGuillemet/ImGuizmo) / [CImGuizmo](https://github.com/cimgui/cimguizmo)
- [x] [ImGui-Knobs](https://github.com/altschuler/imgui-knobs) / [CImGui-Knobs](https://github.com/dinau/imguin/tree/main/src/imguin/private/cimgui-knobs)
- [x] [ImGuiFileDialog](https://github.com/aiekick/ImGuiFileDialog) / [CImGuiFileDialog](https://github.com/dinau/CImGuiFileDialog)
- [x] [ImGui_Toggle](https://github.com/cmdwtf/imgui_toggle) / [CimGui_Toggle](https://github.com/dinau/cimgui_toggle)
- [x] [ImPlot3d](https://github.com/brenocq/implot3d) / [CImPlot3d](https://github.com/cimgui/cimplot3d)
- [x] [ImSpinner](https://github.com/dalerank/imspinner) / [CImSpinner](https://github.com/dinau/cimspinner)
- [x] [ImGuiColorTextEdit](https://github.com/santaclose/ImGuiColorTextEdit) / [cimCTE](https://github.com/cimgui/cimCTE) (2025/03)
- [ ] [ImGui_Markdown](https://github.com/enkisoftware/imgui_markdown) WIP
#### Screen shot (examples)
---
These screen shots are on Windows10.
###### [glfw_opengl3](glfw_opengl3)
---
Basic example with icon fonts
- Build
```sh
pwd
glfw_opengl3
make # or make run
```
or
```sh
nim c glfw_opengl3.nim # or nim c -r glfw_opengl3.nim or nim r glfw_opengl3.nim
```
###### [glfw_opengl3_imknobs](glfw_opengl3_imknobs)
---
[https://github.com/altschuler/imgui-knobs](https://github.com/altschuler/imgui-knobs)
[cimgui-knobs](src/imguin/private/cimgui-knobs) sources have been contributed from [system64MC](https://github.com/system64MC) / [PR](https://github.com/dinau/imguin/commits?author=system64MC) (2024/12). Thank you.
- Build
```sh
pwd
glfw_opengl3_imknobs
make
```
or
```sh
nim c -d:ImKnobsEnable --warning:HoleEnumConv:off glfw_opengl3_imknobs.nim
```
###### [glfw_opengl3_filedialog](glfw_opengl3_filedialog)
---
[ImGuiFileDialog](https://github.com/aiekick/ImGuiFileDialog) / [CImGuiFileDialog](https://github.com/dinau/CImGuiFileDialog)
- Build
```sh
pwd
glfw_opengl3_filedialog
make
```
or
```sh
nim c -d:ImGuiFileDialogEnable glfw_opengl3_filedialog.nim
```
###### [glfw_opengl3_imgui_toggle](glfw_opengl3_imgui_toggle)
---
- Build
```sh
pwd
glfw_opengl3_imgui_toggle
make
```
or
```sh
nim c -d:ImGuiToggle glfw_opengl3_imgui_toggle.nim
```
###### [glfw_opengl3_imspinner](glfw_opengl3_imspinner)
---
- Build
```sh
pwd
glfw_opengl3_imspinner
make
```
or
```sh
nim c -d:ImSpinner glfw_opengl3_imspinner.nim
```
###### [glfw_opengl3_iconfont_viewer](glfw_opengl3_iconfont_viewer)
---
Icon font viewer and magnifying glass
- Build
```sh
pwd
iconFontViewer
make
```
or
```sh
nim c iconFontViewer.nim
```
###### [glfw_opengl3_image_load](glfw_opengl3_image_load) / [sdl2_opengl3](sdl2_opengl3)
---
Image load and magnifying glass
- Build
```sh
pwd
glfw_opengl3_image_load
make
```
or
```sh
nim c glfw_opengl3_image_load.nim
```
- Build sdl2 version
```sh
pwd
sdl2_opengl3
make
```
or
```sh
nim c -d:SDL sdl2_opengl3.nim
```
###### [sdl2_renderer](sdl2_renderer) / [sdl3_renderer](sdl3_renderer) / [sdl3_opengl3](sdl3_opengl3) / [sdl3_sdlgpu3](sdl3_sdlgpu3)
---
SDL renderer backend.
- Build sdl2 version
```sh
pwd
sdl2_renderer
make
```
or
```sh
nim c -d:SDL sdl2_renderer.nim
```
- Build sdl3 version
See [SDL3 installation on Linux OS](https://github.com/dinau/sdl3_nim?tab=readme-ov-file#for-linux-os)
```sh
pwd
sdl3_opengl3
make
```
or
```sh
nim c -d:SDL sdl3_opengl3.nim
```
- Build sdl3 version
```sh
pwd
sdl3_renderer
make
```
or
```sh
nim c -d:SDL sdl3_renderer.nim
```
###### [glfw_opengl3_image_save](glfw_opengl3_image_save)
---
Image load / save and magnifying glass
It can save a screen shot as [ jpg, bmp, png or tga ] file.
- Build
```sh
pwd
glfw_opengl3_image_save
make # or make run
```
or
```sh
nim c glfw_opengl3_image_save.nim
```
###### [glfw_opengl3_jp](glfw_opengl3_jp)
---
Showing UTF-8 text and input text with a local country language.
- Build
```sh
pwd
glfw_opengl3_jp
make # or make run
```
or
```sh
nim c glfw_opengl3_jp.nim
```
###### [glfw_opengl3_implot](glfw_opengl3_implot)
---
Showing ImGui demo with ImPlot demo.
- Build
```sh
pwd
glfw_opengl3_implot
make # or make run
```
or
```sh
nim c -d:ImPlotEnable glfw_opengl3_implot.nim
```
###### [glfw_opengl3_implot3d](glfw_opengl3_implot3d)
---
Showing ImPlot3D demo. WIP
- Build
```sh
pwd
glfw_opengl3_implot3d
make # or make run
```
or
```sh
nim c -d:ImPlotEnable -d:ImPlot3DEnable glfw_opengl3_implot3d.nim
```
###### [glfw_opengl3_imnodes](glfw_opengl3_imnodes)
---
- Build
```sh
pwd
glfw_opengl3_imnodes
make # or make run
```
or
```sh
nim c -d:ImNodesEnable glfw_opengl3_imnodes.nim
```
###### [glfw_opengl3_imguizmo](glfw_opengl3_imguizmo)
---
- Build
```sh
pwd
glfw_opengl3_imguizmo
make # or make run
```
or
```sh
nim c -d:ImGuizmoEnable glfw_opengl3_imguizmo.nim
```
###### [glfw_opengl3_imColorTextEdit](glfw_opengl3_imColorTextEdit)
---
- Build
```sh
pwd
glfw_opengl3_imColorTextEdit
make # or make run
```
or
```sh
nim c -d:ImColorTextEdit glfw_opengl3_imColorTextEdit.nim
###### [glfw_opengl3_imgui_markdown](glfw_opengl3_imgui_markdown)
---
WIP at this moment.
- Build
```sh
pwd
glfw_opengl3_imgui_markdown
make # or make run
```
or
```sh
nim c -d:ImGuiMarkdownEnable glfw_opengl3_imgui_markdown.nim
```
###### My test app movie using imguin
---
[](https://youtu.be/Ea0t7b9Kmq4)
### Cross compilation: Generating Windows application binary(\*.exe) on Linux OS
---
See:
[Cross compilation to Windows, linker error (unrecognized option '-z'](https://forum.nim-lang.org/t/11302#73838)
https://nim-lang.org/docs/nimc.html#crossminuscompilation-for-windows
For example on Linux Mint 22 and so on,
```sh
pwd
examples
cd glfw_opengl3
```
```sh
make win
```
or
```sh
nim c -d:mingw glfw_opengl3
```
or
```sh
nim c --os:windows glfw_opengl3
```
`glfw_opengl3.exe` will be generated in the current folder.
### Selection backend compiler
---
You might be able to use another C/C++ compiler,
`Clang, vcc(Visual Studio C/C++) , zig cc`
by changing variable `TC` in [config.nims.common](config.nims.common).
### TODO
---
- [x] Can it compile with `zig cc` ? Done. But Zig lang. is very unstable at this time.
- [x] Whether can it use `cimgui.dll` ? (Now it can only be static link) Closed. Only be static link.
- [x] Easier compilation for SDL2 app. (2024/09) Done.
- [x] Added: ImNodes/CImNodes (2023/10) Done
- [x] Unfortunately Dear ImGui - 1.89.7 dosn't work well at this moment.(2023/07) Done. (2023/08)
- [x] Whether can it do `nimble install imguin` ? [Done (2023/09) (#Issue 13)](https://github.com/dinau/imguin/issues/13)
- [x] Add Font Awesome (Icon Font) demo. Done (2023/04).
- [x] Can it compile with MSVC (--cc:vcc) ? Done. Except SDL2 demo. (2023/03), TODO (2024/09)
- [x] Can it compile with Clang (--cc:clang) ? Done. (2023/03)
- [x] Add SDL2 example. Done. [sdl2_opengl3](sdl2_opengl3) (2023/03)
- [x] First step has been done. (2023/03)
### Compressing binary file
---
Install `UPX` with MSys console on WindowsOS,
```sh
pacman -S mingw-w64-x86_64-upx
```
For compression exe file,
```sh
pwd
examples
cd glfw_opengl3_implot
make upx
```
```sh
Ultimate Packer for eXecutables
Copyright (C) 1996 - 2024
UPX 4.2.4 Markus Oberhumer, Laszlo Molnar & John Reiser May 9th 2024
File size Ratio Format Name
-------------------- ------ ----------- -----------
7117824 -> 1217024 17.10% win64/pe glfw_opengl3_implot.exe
```
Decompressing,
```sh
make dupx
```
Result in,
| | GCC + UPX : GCC | Clang + UPX : Clang | MSVC(vcc) + UPX : MSVC |
|------------------------:|--------------------------:|-------------------------:|--------------------------:|
| glfw_opengl3.exe | 804 KB : 2360 KB | 720 KB : 2200 KB | 742 KB : 2070 KB |
| glfw_opengl3_implot.exe | **1220 KB** : **7120 KB** | **940KB** : **4200 KB** | **945 KB** : **3810 KB** |
GCC: v14.2.0, Clang: v18.1.8, MSVC: 2022
### My tools version
---
Windows11 (main)
- **Nim Compiler Version 2.2.4**
- **GCC (Rev1, Built by MSYS2 project) 15.1.0**
```sh
pacman -S mingw-w64-ucrt-x86_64-gcc
```
- Clang version 20.1.7
```sh
pacman -S mingw-w64-ucrt-x86_64-clang
```
- Visual Studio C++/C 2022
- git version 2.46.0.windows.1
- Make: GNU Make 4.4.1
- MSys2/MinGW tools
Linux OS: Debain
- **Nim Compiler Version 2.2.4**
- gcc 12.2.0
- make: GNU Make 4.3
- git version 2.39.5
### Other link
---
- File Dialog
- [Cross Platform File Dialog for Dear-ImGui ](https://github.com/gallickgunner/ImGui-Addons)
- [ImGui File Dialogs - CLI and Client Library](https://github.com/time-killer-games/libfiledialogs)
- [A Dear ImGui based File Dialog without any extra dependencies](https://github.com/Julianiolo/ImGuiFD)
- Other
- [Node Editor built using Dear ImGui](https://github.com/thedmd/imgui-node-editor)
- GUI
- [nuklear-nim (Public archived)](https://github.com/zacharycarter/nuklear-nim)
- Graphical
- [Immediate Mode Plotting](https://github.com/epezent/implot)
###### Similar project ImGui / CImGui
---
| Language [^order] | | Project |
| -------------------: | :---: | :----------------------------------------------------------------: |
| **Lua** | Script | [LuaJITImGui](https://github.com/dinau/luajitImGui) |
| **NeLua** | Compiler | [NeLuaImGui](https://github.com/dinau/neluaImGui) |
| **Nim** | Compiler | [ImGuin](https://github.com/dinau/imguin), [Nimgl_test](https://github.com/dinau/nimgl_test), [Nim_implot](https://github.com/dinau/nim_implot) |
| **Python** | Script | [DearPyGui for 32bit WindowsOS Binary](https://github.com/dinau/DearPyGui32/tree/win32) |
| **Ruby** | Script | [igRuby_Examples](https://github.com/dinau/igruby_examples) |
| **Zig**, C lang. | Compiler | [Dear_Bindings_Build](https://github.com/dinau/dear_bindings_build) |
| **Zig** | Compiler | [ImGuinZ](https://github.com/dinau/imguinz) |
###### SDL Game tutorial Platfromer
---
| Language [^order] | | SDL | Project |
| -------------------: | :---: | :---: | :----------------------------------------------------------------: |
| **LuaJIT** | Script | SDL2 | [LuaJIT-Platformer](https://github.com/dinau/luajit-platformer)
| **Nelua** | Compiler | SDL2 | [NeLua-Platformer](https://github.com/dinau/nelua-platformer)
| **Nim** | Compiler | SDL3 / SDL2 | [Nim-Platformer-sdl2](https://github.com/def-/nim-platformer)/ [Nim-Platformer-sdl3](https://github.com/dinau/sdl3_nim/tree/main/examples/platformer) |
| **Ruby** | Script | SDL3 | [Ruby-Platformer](https://github.com/dinau/ruby-platformer) |
| **Zig** | Compiler | SDL3 / SDL2 | [Zig-Platformer](https://github.com/dinau/zig-platformer) |
[^order]: Alphabectial order
###### Other link2
---
- https://github.com/SpartanJ/SOIL2
SOIL2 is a tiny C library used primarily for uploading textures into OpenGL.
###### Memo
---
```sh
error: assignment to 'char **' from incompatible pointer type 'const char * const*' [-Wincompatible-pointer-types]
```
```nim
type ConstCstring {.importc: const char *.} = cstring
```