You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Update to 1.86 and update OSX backend (fix keyboard issue) (#7)
* Update to 1.86 and update README/HOWTO
* Update backend (1.86) to support keyboard/gamepad/clipboard events
* Update CI
Co-authored-by: Christian Treffs <ctreffs@gmail.com>
Copy file name to clipboardExpand all lines: README.md
+39-23Lines changed: 39 additions & 23 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,10 +12,13 @@
12
12
</p>
13
13
14
14
This is a **lightweight**, **auto-generated** and **thin** Swift wrapper around the popular and excellent [**dear imgui**](https://github.com/ocornut/imgui) library.
15
-
It provides a **swifty** and -especially - **typesafe** API. It is easily maintainable and updatable, as well, since it relies heavily on automated code generation.
15
+
16
+
It provides a **swifty** and especially **typesafe** API. It is easily maintainable and updatable, as well, since it relies heavily on automated code generation.
16
17
17
18
There are working [demo examples](Sources/Demos/), too, provided as part of the library.
18
19
20
+
Currently it is based on **v1.86** of ImGui.
21
+
19
22
## 🚀 Getting Started
20
23
21
24
These instructions will get your copy of the project up and running on your local machine and provide a code example.
It provides two backend files ([imgui_impl_metal.swift](Sources/Demos/Metal/imgui_impl_metal.swift), [imgui_impl_osx.swift](Sources/Demos/Metal/imgui_impl_metal.swift)). Feel free to include more backends for GLFW, SDL2, etc.
103
+
88
104
## 🆕 Update SwiftImGui
89
105
90
-
SwiftImGui uses a mutli-stage process to update to the latest imgui version. See [HOWTO.md](docs/HOWTO.md) for details.
106
+
SwiftImGui uses a mutli-stage process to update to the latest [cimgui](https://github.com/cimgui/cimgui) and [imgui](https://github.com/ocornut/imgui) versions.
91
107
92
-
## 💁 Help needed
108
+
See [HOWTO.md](docs/HOWTO.md) for steps about how to contribute.
109
+
110
+
## 💁 Help Needed
93
111
94
112
This project needs a lot of love.
95
113
If you are interested in contributing please feel free to do so!
96
114
97
115
Things that need to be done among others are:
98
116
99
-
-[ ] Extend the AutoWrapper to wrap more cimgui functions (currently there are 105 'invalid' functions that will not be wrapped. 927 will be wrapped properly.)
100
-
-[ ] Some functions are not available via the c interface - see `Sources/AutoWrapper/Exceptions.swift`
117
+
-[ ] Extend the AutoWrapper to wrap more cimgui functions
118
+
- Currently there are **112** 'invalid' functions that will not be wrapped and **974** will be wrapped properly.
119
+
-[ ] Some functions are not available via the C interface - see `Sources/AutoWrapper/Exceptions.swift`
101
120
-[ ] Find a solution for manual adjustments in cimgui generator template
102
121
-[ ] Write some more tests
103
122
104
123
## 🏷️ Versioning
105
124
106
-
We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [releases on this repository](https://github.com/ctreffs/SwiftImGui/releases).
125
+
We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [releases](https://github.com/ctreffs/SwiftImGui/releases) in this repository.
107
126
108
127
## ✍️ Authors
109
128
@@ -118,41 +137,38 @@ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file
118
137
* imgui licensed under [MIT License](https://github.com/ocornut/imgui/blob/master/LICENSE.txt)
119
138
* CImGui licensed under [MIT License](https://github.com/cimgui/cimgui/blob/master/LICENSE)
120
139
121
-
## 🙏 Original code
140
+
## 🙏 Original Code
141
+
142
+
SwiftImGui is merely a wrapper around [**imgui**](https://github.com/ocornut/imgui). It also makes use of the excellent C-API wrapper [**cimgui**](https://github.com/cimgui/cimgui).
122
143
123
-
Since SwiftImGui is merely a wrapper around [**imgui**](https://github.com/ocornut/imgui) it obviously depends on it.
124
-
It also makes use of the excellent c-api wrapper [**cimgui**](https://github.com/cimgui/cimgui).
125
144
Support them if you can!
126
145
127
146
### imgui
128
147
129
148
##### From [ocornut/imgui/docs/README.md](https://github.com/ocornut/imgui/blob/master/docs/README.md):
130
149
150
+
> Dear ImGui is a **bloat-free graphical user interface library for C++**. It outputs optimized vertex buffers that you can render anytime in your 3D-pipeline enabled application. It is fast, portable, renderer agnostic and self-contained (no external dependencies).
151
+
>
152
+
> Dear ImGui is designed to **enable fast iterations** and to **empower programmers** to create **content creation tools and visualization / debug tools** (as opposed to UI for the average end-user). It favors simplicity and productivity toward this goal, and lacks certain features normally found in more high-level libraries.
153
+
>
154
+
> Dear ImGui is particularly suited to integration in games engine (for tooling), real-time 3D applications, fullscreen applications, embedded applications, or any applications on consoles platforms where operating system features are non-standard.
155
+
131
156
<sub>(This library is available under a free and permissive license, but needs financial support to sustain its continued improvements. In addition to maintenance and stability there are many desirable features yet to be added. If your company is using dear imgui, please consider reaching out. If you are an individual using dear imgui, please consider supporting the project via Patreon or PayPal.)</sub>
132
157
133
-
Businesses: support continued development via invoiced technical support, maintenance, sponsoring contracts:
158
+
-**Businesses:** support continued development via invoiced technical support, maintenance, sponsoring contracts:
Dear ImGui is a **bloat-free graphical user interface library for C++**. It outputs optimized vertex buffers that you can render anytime in your 3D-pipeline enabled application. It is fast, portable, renderer agnostic and self-contained (no external dependencies).
145
-
146
-
Dear ImGui is designed to **enable fast iterations** and to **empower programmers** to create **content creation tools and visualization / debug tools** (as opposed to UI for the average end-user). It favors simplicity and productivity toward this goal, and lacks certain features normally found in more high-level libraries.
147
-
148
-
Dear ImGui is particularly suited to integration in games engine (for tooling), real-time 3D applications, fullscreen applications, embedded applications, or any applications on consoles platforms where operating system features are non-standard.
149
-
150
-
151
167
### cimgui
152
168
153
169
##### From [cimgui/cimgui/README.md](https://github.com/cimgui/cimgui/blob/master/README.md)
154
170
155
-
CImGui is a thin c-api wrapper programmatically generated for the excellent C++ immediate mode gui Dear ImGui. All imgui.h functions are programmatically wrapped. Generated files are: cimgui.cpp, cimgui.h for C compilation. Also for helping in bindings creation, definitions.lua with function definition information and structs_and_enums.lua. This library is intended as a intermediate layer to be able to use Dear ImGui from other languages that can interface with C (like D - see D-binding)
171
+
> CImGui is a thin C-API wrapper programmatically generated for the excellent C++ immediate mode GUI Dear ImGui. All imgui.h functions are programmatically wrapped. Generated files are: cimgui.cpp, cimgui.h for C compilation. Also for helping in bindings creation, definitions.lua with function definition information and structs_and_enums.lua. This library is intended as a intermediate layer to be able to use Dear ImGui from other languages that can interface with C (like D - see D-binding)
0 commit comments