Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ikskuh/zero-graphics
Application framework based on OpenGL ES 2.0. Runs on desktop machines, Android phones and the web
https://github.com/ikskuh/zero-graphics
android android-sdk desktop-linux game-development graphics sdl sdl2 wasm zig zig-package ziglang
Last synced: 27 days ago
JSON representation
Application framework based on OpenGL ES 2.0. Runs on desktop machines, Android phones and the web
- Host: GitHub
- URL: https://github.com/ikskuh/zero-graphics
- Owner: ikskuh
- License: mit
- Created: 2021-05-17T22:27:59.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2023-02-10T17:16:35.000Z (over 1 year ago)
- Last Synced: 2024-10-10T15:05:41.634Z (about 1 month ago)
- Topics: android, android-sdk, desktop-linux, game-development, graphics, sdl, sdl2, wasm, zig, zig-package, ziglang
- Language: Zig
- Homepage:
- Size: 16 MB
- Stars: 151
- Watchers: 9
- Forks: 17
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-zig - MasterQ32/zero-graphics
README
# Zero Graphics
A very minimal OpenGL ES 2.0 library for Zig. Opens you a window and let's you draw things.
Comes with a pixel-perfect 2D renderer and maybe some day even with a bit of a 3D api.
## Features
- Multi-platform support
- Desktop (Linux, MacOS, Windows, ...)
- WebAssembly
- Android
- Pixel perfect 2D rendering
- Primitives (line, rectangle, triangle, ...)
- Text / TTF fonts
- Textures
- Basic 3D rendering
- Multi-mesh models with flat textures
- Zig-style immediate-mode user interface
- Proper DPI scaling support in renderer
## Project status
### CI
The CI coverage currently looks like this:
| · | Windows | macOS | Linux |
| -------------- | ------- | ----- | ----- |
| Desktop | ✅ | ✅ | ✅ |
| WebAssembly | ✅ | ✅ | ✅ |
| Android | ✅ | ✅ | ✅ |
| `zero-init` | ✅ | ✅ | ✅ |
| `zero-convert` | ✅ | ✅ | ✅ |
Status: [](https://github.com/MasterQ32/zero-graphics/actions/workflows/nightly.yml)
### Previews
Work-in-progress, but works quite well already. There is one [big project](https://github.com/Dunstwolke/core) depending on it and is used as a _real-world application_ driver behind _Zero Graphics_.
## Project Goals
### Basic Framework
- [ ] Support the following platforms
- [x] Wasm
- [x] Create OpenGL ES 2.0 context
- [x] Input Mouse
- [x] Input Keyboard
- [ ] Linux Desktop
- [x] Create OpenGL ES 2.0 context
- [x] Input Mouse
- [ ] Input Keyboard
- [ ] Windows Desktop (not tested, but should work via SDL2)
- [ ] Android
- [x] Create OpenGL ES 2.0 context
- [x] Input Mouse
- [ ] Input Keyboard
- [x] Create an OpenGL ES 2.0 context
- [x] Provide input events
- [x] Single pointer motion (finger or mouse)
- [x] Single click event (finger, mouse)
- [ ] Text input for keyboard (utf-8 encoded)
- [x] Provide window events
- [x] Resize
- [x] Close
- [x] Provide access to the underlying backend
- [ ] Allow creation of single-file applications
- [ ] Single executable for easy distribution
- [ ] Embedded resources
### 2D Rendering library
- [ ] Pixel perfect drawing of
- [x] Lines
- [x] Rectangles
- [ ] Images
- [x] Basic "copy full texture to rectangle"
- [ ] Copy portion of texture ("atlas rendering")
- [x] TTF font rendering via [`stb_ttf`](https://github.com/nothings/stb)
- [x] Image loading via [`zigimg`](https://github.com/zigimg/zigimg)
- [ ] Stack based/nested scissoring
### 3D Rendering library
- [ ] Tool based on Assimp to convert models into loadable format
- [x] static geometry
- [ ] dynamic/animated geometry
- [ ] Blender export script
- [x] Draw static geometry
- [ ] Draw animated geometry
- [ ] Skinning based on skeletons
- [ ] Axis- and camera aligned billboards
- [ ] Basic particles
- [ ] Tiny built-in pipeline with
- [ ] shadow mapping
- [ ] planar reflections
- [ ] water reflections
## Dependencies
### Desktop
- [SDL2](https://www.libsdl.org/)
### Web
- [js glue code](www/zero-graphics.js)
- [root page](www/application.ztt)
### Android
- Android SDK
- Android NDK
- Android Build Tools
- OpenJDK
- some other tools
## Building / Running
This project uses [submodules](https://git-scm.com/book/en/v2/Git-Tools-Submodules), so to get started, clone the repo with submodules recursively:
```sh-session
[user@computer work]$ git clone https://github.com/MasterQ32/zero-graphics --recurse-submodules
```
or, if you already cloned the repository:
```sh-session
[user@computer work]$ git clone https://github.com/MasterQ32/zero-graphics
[user@computer work]$ cd zero-graphics/
[user@computer zero-graphics]$ git submodule update --init --recursive
```
### Desktop PC
Requires `SDL2` to be installed.
```sh-session
[user@computer zero-graphics]$ zig build run
```
A window should open with the application in fullscreen.
The following environment variables can control how zero-graphics behaves:
- `ZEROG_FULLSCREEN` is `y` for forced fullscreen or `n` for forced window mode.
- `ZEROG_RESIZEABLE` is `y` for forced resizable window.
- `ZEROG_DPI` is a number specifying the pixel density.
### Web/Wasm version
Includes a teeny tiny web server for debugging.
```sh-session
[user@computer zero-graphics]$ zig build install run-wasm
```
Now visit http://127.0.0.1:8000/demo_application.htm to see the demo.
### Android
Connect your phone first and install both a JDK as well as the Android SDK with NDK included. The ZeroGraphics build system will tell you if
it couldn't auto-detect the SDK paths.
```sh-session
[user@computer zero-graphics]$ zig build -Denable-android run-app
```
The app should now be installed and started on your phone.
## Documentation
### Getting started
To create a new project, build this repository with `zig build` first. Then use the tool `zero-init` from `zig-out/bin` to initialize a new project:
```sh-session
[felix@denkplatte-v2 ~]$ mkdir game
[felix@denkplatte-v2 ~]$ cd game
[felix@denkplatte-v2 game]$ /path/to/zero-graphics/zig-out/bin/zero-init symlink # initialize via symlink, quickest option. use zero-init -h to see all options
[felix@denkplatte-v2 game]$ ls
src vendor build.zig
[felix@denkplatte-v2 game]$ zig build
[felix@denkplatte-v2 game]$ zig build run
info(sdl): SDL Video Driver: x11
info(sdl): Render resolution: 1280×720
info(sdl): Virtual resolution: 1280×720
info(demo): OpenGL Version: OpenGL ES 3.2 Mesa 21.2.3
info(demo): OpenGL Vendor: AMD
info(demo): OpenGL Renderer: AMD Radeon(TM) Vega 10 Graphics (RAVEN, DRM 3.41.0, 5.13.19_1, LLVM 12.0.1)
info(demo): OpenGL GLSL: OpenGL ES GLSL ES 3.20
info(zero_graphics): [shader compiler] [other] Shader Stats: SGPRS: 16 VGPRS: 8 Code Size: 212 LDS: 0 Scratch: 0 Max Waves: 10 Spilled SGPRs: 0 Spilled VGPRs: 0 PrivMem VGPRs: 0
info(zero_graphics): [shader compiler] [other] Shader Stats: SGPRS: 16 VGPRS: 8 Code Size: 40 LDS: 0 Scratch: 0 Max Waves: 10 Spilled SGPRs: 0 Spilled VGPRs: 0 PrivMem VGPRs: 0
info(zero_graphics): [shader compiler] [other] Shader Stats: SGPRS: 8 VGPRS: 24 Code Size: 52 LDS: 0 Scratch: 0 Max Waves: 10 Spilled SGPRs: 0 Spilled VGPRs: 0 PrivMem VGPRs: 0
info(zero_graphics): [shader compiler] [other] Shader Stats: SGPRS: 8 VGPRS: 24 Code Size: 24 LDS: 0 Scratch: 0 Max Waves: 10 Spilled SGPRs: 0 Spilled VGPRs: 0 PrivMem VGPRs: 0
info(zero_graphics): [shader compiler] [other] Shader Stats: SGPRS: 8 VGPRS: 8 Code Size: 60 LDS: 0 Scratch: 0 Max Waves: 10 Spilled SGPRs: 0 Spilled VGPRs: 0 PrivMem VGPRs: 0
info(zero_graphics): [shader compiler] [other] Shader Stats: SGPRS: 16 VGPRS: 20 Code Size: 392 LDS: 0 Scratch: 0 Max Waves: 10 Spilled SGPRs: 0 Spilled VGPRs: 0 PrivMem VGPRs: 0
```
Check out the file [`src/main.zig`](tools/zero-init/template/src/main.zig) to see your app skeleton. You can also adjust the [`build.zig`](tools/zero-init/template/build.zig) to set your project name.
The functions are roughly called in this order:
The separation between _application init_ and _graphics init_ is relevant for Android apps which will destroy their window when you send it into the background and will recreate it when it is selected again. This means that all GPU content will be lost then and must be restored.
Your application state will not be destroyed, so the rendering can render the same data as before.
### Architecture
`zero-graphics` follows a somewhat unusual architecture for Zig applications.
Your applications is a _package_ that will be consumed by a `zero-graphics` host. This host is implementing the "main loop" and will invoke both `update` and `render` periodically. It will also initialize and open the window and pump events.
This design allows `zero-graphics` to run on several different platforms, including most desktop PCs, Android and even web browsers via WebAssembly.
You can check out the [Sdk.zig](Sdk.zig) file to find out how a application is built.