Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ctreffs/swiftimgui
Swift wrapper around Dear imgui for macOS, iOS, Linux and Windows
https://github.com/ctreffs/swiftimgui
cimgui gui imgui library mit-license spm swift swift-package-manager swiftimgui
Last synced: 4 days ago
JSON representation
Swift wrapper around Dear imgui for macOS, iOS, Linux and Windows
- Host: GitHub
- URL: https://github.com/ctreffs/swiftimgui
- Owner: ctreffs
- License: mit
- Created: 2019-10-27T05:20:57.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2024-11-27T04:22:54.000Z (28 days ago)
- Last Synced: 2024-12-14T08:05:13.439Z (11 days ago)
- Topics: cimgui, gui, imgui, library, mit-license, spm, swift, swift-package-manager, swiftimgui
- Language: C++
- Homepage:
- Size: 10.9 MB
- Stars: 154
- Watchers: 6
- Forks: 17
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Swift ImGui
[](https://github.com/ctreffs/SwiftImGui/actions/workflows/ci-macos.yml)
[](https://github.com/ctreffs/SwiftImGui/actions/workflows/ci-linux.yml)
[](https://github.com/ctreffs/SwiftImGui/actions/workflows/ci-windows.yml)
[](https://swiftpackageindex.com/ctreffs/SwiftImGui)
[](https://swiftpackageindex.com/ctreffs/SwiftImGui)
[](LICENSE)
This is a **lightweight**, **auto-generated** and **thin** Swift wrapper around the popular and excellent [**dear imgui**](https://github.com/ocornut/imgui) library.
It provides a **swifty** and especially **typesafe** API. It is easily maintainable and updatable, as well, since it relies heavily on automated code generation.
There are working [demo examples](Sources/Demos/), too, provided as part of the library.
Currently it is based on **v1.86** of ImGui.
## 🚀 Getting Started
These instructions will get your copy of the project up and running on your local machine and provide a code example.
### 📋 Prerequisites
* [Swift Package Manager (SPM)](https://github.com/apple/swift-package-manager)
* [Swiftlint](https://github.com/realm/SwiftLint) for linting - (optional)
### 💻 Installing
Swift ImGui is available for all platforms that support [Swift 5.3](https://swift.org/) and higher and the [Swift Package Manager (SPM)](https://github.com/apple/swift-package-manager).
Extend the following lines in your `Package.swift` file or use it to create a new project.
```swift
// swift-tools-version:5.3
import PackageDescription
let package = Package(
name: "YourPackageName",
dependencies: [
.package(url: "https://github.com/ctreffs/SwiftImGui.git", from: "1.86.0")
],
targets: [
.target(
name: "YourTargetName",
dependencies: ["ImGui"])
]
)
```
## 📝 Code Example
### Minimal
A minimal example is located at [Sources/Demos/Minimal/main.swift](Sources/Demos/Minimal/main.swift).
This is an excerpt:
```swift
import ImGui
IMGUI_CHECKVERSION()
let ctx = ImGuiCreateContext(nil)
let io = ImGuiGetIO()!
/// Build font atlas
var pixels: UnsafeMutablePointer?
var width: Int32 = 0
var height: Int32 = 0
var bytesPerPixel: Int32 = 0
ImFontAtlas_GetTexDataAsRGBA32(io.pointee.Fonts, &pixels, &width, &height, &bytesPerPixel)
for n in 0..<20 {
io.pointee.DisplaySize = ImVec2(x: 1920, y: 1080)
io.pointee.DeltaTime = 1.0 / 60.0
ImGuiNewFrame()
var f: Float = 0.0
ImGuiTextV("Hello, world!")
ImGuiSliderFloat("float", &f, 0.0, 1.0, nil, 1)
ImGuiTextV("Application average %.3f ms/frame (%.1f FPS)", 1000.0 / io.pointee.Framerate, io.pointee.Framerate)
ImGuiShowDemoWindow(nil)
ImGuiRender()
}
ImGuiDestroyContext(ctx)
```
### Metal + OSX
This is another demo displaying ImGui demo window at [Sources/Demos/Metal](Sources/Demos/Metal).
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.
## 🆕 Update SwiftImGui
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.
See [HOWTO.md](docs/HOWTO.md) for steps about how to contribute.
## 💁 Help Needed
This project needs a lot of love.
If you are interested in contributing please feel free to do so!
Things that need to be done among others are:
- [ ] Extend the AutoWrapper to wrap more cimgui functions
- Currently there are **112** 'invalid' functions that will not be wrapped and **974** will be wrapped properly.
- [ ] Some functions are not available via the C interface - see `Sources/AutoWrapper/Exceptions.swift`
- [ ] Find a solution for manual adjustments in cimgui generator template
- [ ] Write some more tests
## 🏷️ Versioning
We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [releases](https://github.com/ctreffs/SwiftImGui/releases) in this repository.
## ✍️ Authors
* [Christian Treffs](https://github.com/ctreffs)
See also the list of [contributors](https://github.com/ctreffs/SwiftImGui/graphs/contributors) who participated in this project.
## 🔏 Licenses
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
* imgui licensed under [MIT License](https://github.com/ocornut/imgui/blob/master/LICENSE.txt)
* CImGui licensed under [MIT License](https://github.com/cimgui/cimgui/blob/master/LICENSE)
## 🙏 Original Code
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).
Support them if you can!
### imgui
##### From [ocornut/imgui/docs/README.md](https://github.com/ocornut/imgui/blob/master/docs/README.md):
> 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).
>
> 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.
>
> 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.
(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.)
- **Businesses:** support continued development via invoiced technical support, maintenance, sponsoring contracts:
_E-mail: contact @ dearimgui dot org_
- **Individuals/hobbyists:** support continued maintenance and development via the monthly Patreon:
[](http://www.patreon.com/imgui)
- **Individuals/hobbyists:** support continued maintenance and development via PayPal:
[](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=WGHNC6MBFLZ2S)
----
### cimgui
##### From [cimgui/cimgui/README.md](https://github.com/cimgui/cimgui/blob/master/README.md)
> 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)
## ☮️ Alternatives
* [mnmly/Swift-imgui](https://github.com/mnmly/Swift-imgui)
* [troughton/SwiftImGui](https://github.com/troughton/SwiftImGui)