aquamarine/README.md

30 lines
930 B
Markdown
Raw Permalink Normal View History

2024-06-18 11:38:26 +02:00
## Aquamarine
Aquamarine is a very light linux rendering backend library. It provides basic abstractions
for an application to render on a Wayland session (in a window) or a native DRM session.
It is agnostic of the rendering API (Vulkan/OpenGL) and designed to be lightweight, performant, and
minimal.
2024-07-01 20:42:25 +02:00
Aquamarine provides no bindings for other languages. It is C++-only.
2024-06-18 11:38:26 +02:00
## Stability
Aquamarine depends on the ABI stability of the stdlib implementation of your compiler. Sover bumps will be done only for aquamarine ABI breaks, not stdlib.
## Building
```sh
cmake --no-warn-unused-cli -DCMAKE_BUILD_TYPE:STRING=Release -DCMAKE_INSTALL_PREFIX:PATH=/usr -S . -B ./build
cmake --build ./build --config Release --target all -j`nproc 2>/dev/null || getconf _NPROCESSORS_CONF`
```
## TODOs
2024-06-19 23:08:35 +02:00
- [x] Wayland backend
2024-07-01 20:42:25 +02:00
- [x] DRM backend (DRM / KMS / libinput)
- [x] Virtual backend (aka. Headless)
2024-06-18 11:38:26 +02:00
- [ ] Hardware plane support