https://github.com/dinau/sdl3_nim
SDL3 wrapper for Nim language
https://github.com/dinau/sdl3_nim
futhark imgui nim opengl sdl-ttf sdl3 sdl3-ttf stb-image ttf vulkan
Last synced: 7 days ago
JSON representation
SDL3 wrapper for Nim language
- Host: GitHub
- URL: https://github.com/dinau/sdl3_nim
- Owner: dinau
- License: mit
- Created: 2024-11-23T06:24:13.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2026-03-31T11:41:30.000Z (26 days ago)
- Last Synced: 2026-03-31T13:31:30.531Z (26 days ago)
- Topics: futhark, imgui, nim, opengl, sdl-ttf, sdl3, sdl3-ttf, stb-image, ttf, vulkan
- Language: C
- Homepage:
- Size: 64.3 MB
- Stars: 13
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
- [sdl3_nim](#sdl3_nim)
- [Install](#install)
- [For Linux OS](#for-linux-os)
- [For Windows11](#for-windows11)
- [Build and run examples](#build-and-run-examples)
- [About auto renaming](#about-auto-renaming)
- [Develeopment](#develeopment)
- [My tools version](#my-tools-version)
- [Other SDL game tutorial platfromer project](#other-sdl-game-tutorial-platfromer-project)
- [Other examples project for Dear ImGui](#other-examples-project-for-dear-imgui)
### sdl3_nim
---
SDL3 wrapper for Nim language with [futhark](https://github.com/PMunch/futhark#installation) converter.
- SDL3: 3.4.2 (2026/03)
- SDL_ttf: 3.2.2
- Windows OS 11
- Linux Debian / Ubuntu families
- Try [ImGuin SDL3 example](https://github.com/dinau/imguin_examples#sdl3-opengl3--renderer---sdlgpu3---vulkan)
#### Install
---
First delete old version
```sh
nimble uninstall sdl3_nim
```
Install
```sh
nimble install sdl3_nim
```
#### For Linux OS
---
- If the package manager of the OS has SDL3 and SDL_ttf packages, install them with the package manager
- Otherwise install them from source code as follows (on Debian / Ubuntu families),
1. Download source code from [SDL3](https://github.com/libsdl-org/SDL/archive/refs/tags/release-3.4.2.zip) and [SDL3_ttf](https://github.com/libsdl-org/SDL_ttf/archive/refs/tags/release-3.2.2.zip)
1. Install build tool **Ninja**
```sh
sudo apt install ninja-build
```
1. Extract SDL3 zip file and
```sh
cd SDL-release-3.4.2
mkdir build
cd build
cmake .. -GNinja -DCMAKE_INSTALL_PREFIX=/usr/local
ninja
sudo ninja install
sudo ldconfig
```
1. Extract SDL3_ttf zip file and
```sh
cd SDL_ttf-release-3.2.2
mkdir build
cd build
cmake .. -GNinja -DCMAKE_INSTALL_PREFIX=/usr/local
ninja
sudo ninja install
sudo ldconfig
```
#### For Windows11
---
Download SDL3.dll from [here](https://github.com/libsdl-org/SDL/releases/), extracts SDL3-3.x.xx-win32-x64.zip
then copy SDL3.dll to your application folder.
#### Build and run examples
---
```sh
git clone https://github.com/dinau/sdl3_nim
```
```sh
cd sdl3_nim
make
```
or
```sh
cd examples/basic
make run
```
[basic.nim](examples/basic/basic.nim)
or
```sh
cd examples/platformer
make run
```
[platformer.nim](examples/platformer/platformer.nim)
or
```sh
cd examples/sdlapp_lines
make run
```
[sdlapp_lines.nim](examples/sdlapp_lines/sdlapp_lines.nim)
Refer to https://github.com/libsdl-org/SDL/tree/main/examples/renderer/03-lines
or
```sh
cd examples/sdlapp
make run
```
[sdlapp.nim](examples/sdlapp/sdlapp.nim)
#### About auto renaming
---
Notice: [Futhark](https://github.com/PMunch/futhark) converter has automatically renamed these symbols.
```nim
Renaming "SDLK_MEDIASELECT" to "SDLK_MEDIASELECT_const" [User]
Renaming "SDLK_a" to "SDLK_a_const" [User]
Renaming "SDLK_b" to "SDLK_b_const" [User]
Renaming "SDLK_c" to "SDLK_c_const" [User]
Renaming "SDLK_d" to "SDLK_d_const" [User]
Renaming "SDLK_e" to "SDLK_e_const" [User]
Renaming "SDLK_f" to "SDLK_f_const" [User]
Renaming "SDLK_g" to "SDLK_g_const" [User]
Renaming "SDLK_h" to "SDLK_h_const" [User]
Renaming "SDLK_i" to "SDLK_i_const" [User]
Renaming "SDLK_j" to "SDLK_j_const" [User]
Renaming "SDLK_k" to "SDLK_k_const" [User]
Renaming "SDLK_l" to "SDLK_l_const" [User]
Renaming "SDLK_m" to "SDLK_m_const" [User]
Renaming "SDLK_n" to "SDLK_n_const" [User]
Renaming "SDLK_o" to "SDLK_o_const" [User]
Renaming "SDLK_p" to "SDLK_p_const" [User]
Renaming "SDLK_q" to "SDLK_q_const" [User]
Renaming "SDLK_r" to "SDLK_r_const" [User]
Renaming "SDLK_s" to "SDLK_s_const" [User]
Renaming "SDLK_t" to "SDLK_t_const" [User]
Renaming "SDLK_u" to "SDLK_u_const" [User]
Renaming "SDLK_v" to "SDLK_v_const" [User]
Renaming "SDLK_w" to "SDLK_w_const" [User]
Renaming "SDLK_x" to "SDLK_x_const" [User]
Renaming "SDLK_y" to "SDLK_y_const" [User]
Renaming "SDLK_z" to "SDLK_z_const" [User]
Renaming "SDL_EventAction" to "SDL_EventAction_typedef" [User]
Renaming "SDL_GLAttr" to "SDL_GLAttr_typedef" [User]
Renaming "SDL_GLContextFlag" to "SDL_GLContextFlag_typedef" [User]
Renaming "SDL_GLContextReleaseFlag" to "SDL_GLContextReleaseFlag_typedef" [User]
Renaming "SDL_GLProfile" to "SDL_GLProfile_typedef" [User]
Renaming "SDL_GL_CONTEXT_RESET_NOTIFICATION" to "SDL_GL_CONTEXT_RESET_NOTIFICATION_enumval" [User]
Renaming "SDL_Log" to "SDL_Log_proc" [User]
Renaming "SDL_Mutex" to "SDL_Mutex_typedef" [User]
Renaming "SDL_PRIX32" to "SDL_PRIX32_const" [User]
Renaming "SDL_PRIX64" to "SDL_PRIX64_const" [User]
Renaming "SDL_Quit" to "SDL_Quit_proc" [User]
Renaming "SDL_SCALEMODE_LINEAR" to "SDL_SCALEMODE_LINEAR_enumval" [User]
Renaming "SDL_SCALEMODE_NEAREST" to "SDL_SCALEMODE_NEAREST_enumval" [User]
Renaming "SDL_SCANCODE_MEDIA_SELECT" to "SDL_SCANCODE_MEDIA_SELECT_enumval" [User]
Renaming "SDL_SensorUpdate" to "SDL_SensorUpdate_const" [User]
Renaming "SDL_ThreadID" to "SDL_ThreadID_typedef" [User]
Renaming "SDL_UserEvent" to "SDL_UserEvent_typedef" [User]
Renaming "SDL_strtok_r" to "SDL_strtok_r_proc" [User]
Renaming "block" to "block_arg" [User]
Renaming "end" to "end_field" in struct_SDL_HapticRamp [User]
Renaming "func" to "func_arg" [User]
Renaming "mod" to "mod_field" in struct_SDL_KeyboardEvent [User]
Renaming "proc" to "proc_arg" [User]
Renaming "ptr" to "ptr_arg" [User]
Renaming "type" to "type_arg" [User]
Renaming "type" to "type_field" in struct_SDL_AsyncIOOutcome [User]
Renaming "type" to "type_field" in struct_SDL_AudioDeviceEvent [User]
Renaming "type" to "type_field" in struct_SDL_CameraDeviceEvent [User]
Renaming "type" to "type_field" in struct_SDL_ClipboardEvent [User]
Renaming "type" to "type_field" in struct_SDL_CommonEvent [User]
Renaming "type" to "type_field" in struct_SDL_DisplayEvent [User]
Renaming "type" to "type_field" in struct_SDL_DropEvent [User]
Renaming "type" to "type_field" in struct_SDL_GPUTextureCreateInfo [User]
Renaming "type" to "type_field" in struct_SDL_GamepadAxisEvent [User]
Renaming "type" to "type_field" in struct_SDL_GamepadButtonEvent [User]
Renaming "type" to "type_field" in struct_SDL_GamepadDeviceEvent [User]
Renaming "type" to "type_field" in struct_SDL_GamepadSensorEvent [User]
Renaming "type" to "type_field" in struct_SDL_GamepadTouchpadEvent [User]
Renaming "type" to "type_field" in struct_SDL_HapticCondition [User]
Renaming "type" to "type_field" in struct_SDL_HapticConstant [User]
Renaming "type" to "type_field" in struct_SDL_HapticCustom [User]
Renaming "type" to "type_field" in struct_SDL_HapticDirection [User]
Renaming "type" to "type_field" in struct_SDL_HapticLeftRight [User]
Renaming "type" to "type_field" in struct_SDL_HapticPeriodic [User]
Renaming "type" to "type_field" in struct_SDL_HapticRamp [User]
Renaming "type" to "type_field" in struct_SDL_JoyAxisEvent [User]
Renaming "type" to "type_field" in struct_SDL_JoyBallEvent [User]
Renaming "type" to "type_field" in struct_SDL_JoyBatteryEvent [User]
Renaming "type" to "type_field" in struct_SDL_JoyButtonEvent [User]
Renaming "type" to "type_field" in struct_SDL_JoyDeviceEvent [User]
Renaming "type" to "type_field" in struct_SDL_JoyHatEvent [User]
Renaming "type" to "type_field" in struct_SDL_KeyboardDeviceEvent [User]
Renaming "type" to "type_field" in struct_SDL_KeyboardEvent [User]
Renaming "type" to "type_field" in struct_SDL_MouseButtonEvent [User]
Renaming "type" to "type_field" in struct_SDL_MouseDeviceEvent [User]
Renaming "type" to "type_field" in struct_SDL_MouseMotionEvent [User]
Renaming "type" to "type_field" in struct_SDL_MouseWheelEvent [User]
Renaming "type" to "type_field" in struct_SDL_PathInfo [User]
Renaming "type" to "type_field" in struct_SDL_PenAxisEvent [User]
Renaming "type" to "type_field" in struct_SDL_PenButtonEvent [User]
Renaming "type" to "type_field" in struct_SDL_PenMotionEvent [User]
Renaming "type" to "type_field" in struct_SDL_PenProximityEvent [User]
Renaming "type" to "type_field" in struct_SDL_PenTouchEvent [User]
Renaming "type" to "type_field" in struct_SDL_PinchFingerEvent [User]
Renaming "type" to "type_field" in struct_SDL_QuitEvent [User]
Renaming "type" to "type_field" in struct_SDL_RenderEvent [User]
Renaming "type" to "type_field" in struct_SDL_SensorEvent [User]
Renaming "type" to "type_field" in struct_SDL_TextEditingCandidatesEvent [User]
Renaming "type" to "type_field" in struct_SDL_TextEditingEvent [User]
Renaming "type" to "type_field" in struct_SDL_TextInputEvent [User]
Renaming "type" to "type_field" in struct_SDL_TouchFingerEvent [User]
Renaming "type" to "type_field" in struct_SDL_UserEvent [User]
Renaming "type" to "type_field" in struct_SDL_VirtualJoystickDesc [User]
Renaming "type" to "type_field" in struct_SDL_VirtualJoystickSensorDesc [User]
Renaming "type" to "type_field" in struct_SDL_WindowEvent [User]
Renaming "type" to "type_field" in union_SDL_Event [User]
Renaming "type" to "type_field" in union_SDL_HapticEffect [User]
```
#### Develeopment
---
Generating SDL3 Nim header files with Futhark.
[The definition file of SDL3](src/sdl3_defs.nim) can be updated by yourself as follows,
1. Replace [src/private/SDL3](src/private/SDL3) with [latest officail SDL3 library](https://github.com/libsdl-org/SDL/releases)
1. [Install Futhark](https://github.com/PMunch/futhark#installation)
1. Generate definition file
```sh
pwd
sdl3_nim
make gen
```
`src/sdl3_defs.nim` updated will be generated.
#### My tools version
---
- Futhark 0.15.0
- nim-2.2.6
- Gcc.exe (Rev2, Built by MSYS2 project) 15.2.0
#### Other SDL game tutorial platfromer project
---
| Language | | 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 / SDL3 | [Zig-Platformer](https://github.com/dinau/zig-platformer) |
#### Other examples project for Dear ImGui
---
| Language | | Project |
| -------------------: | :---: | :----------------------------------------------------------------: |
| **Lua** | Script | [LuaJITImGui](https://github.com/dinau/luajitImGui) |
| **NeLua** | Compiler | [NeLuaImGui](https://github.com/dinau/neluaImGui) / [NeLuaImGui2](https://github.com/dinau/neluaImGui2) |
| **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) |