NotAShelf/chroma
2
1
Fork 0
Code Issues 5 Pull requests Projects Releases Packages Wiki Activity Actions

docs: update dependencies and supported interfaces for wl_shm

Browse source 
Signed-off-by: NotAShelf <raf@notashelf.dev>
Change-Id: I212c3180a950755d0de4ee5134a924846a6a6964
This commit is contained in:
raf 2026-05-18 00:21:36 +03:00
commit 53b44ed270
Signed by: NotAShelf
GPG key ID: 29D95B64378DB4BF
1 changed files with 3 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

12
README.md
View file

@ -13,8 +13,7 @@ comprehensive monitor management. Here's what makes Chroma stand out:
### Core Functionality ### Core Functionality
- **Memory-efficient**: Smart caching and resource management - **Memory-efficient**: Uses `wl_shm` shared-memory buffers
- **Optimized rendering**: VBO dirty flagging and reduced GPU overhead
- **Multi-monitor support**: Automatically detects and manages wallpapers for - **Multi-monitor support**: Automatically detects and manages wallpapers for
all connected displays all connected displays
- **Configurable scaling modes**: Fill, fit, stretch, and center options per - **Configurable scaling modes**: Fill, fit, stretch, and center options per
@ -27,13 +26,10 @@ comprehensive monitor management. Here's what makes Chroma stand out:
thresholds thresholds
- **Multiple image formats**: Supports JPEG, PNG, BMP, TGA, PSD, GIF, HDR, PIC, - **Multiple image formats**: Supports JPEG, PNG, BMP, TGA, PSD, GIF, HDR, PIC,
PPM, PGM PPM, PGM
- **EGL/OpenGL rendering**: Hardware-accelerated wallpaper rendering
- **Simple Configuration file**: Easy setup with TOML config files - **Simple Configuration file**: Easy setup with TOML config files
- **Signal handling**: Graceful shutdown and configuration reload (SIGHUP) - **Signal handling**: Graceful shutdown and configuration reload (SIGHUP)
- **Intelligent downsampling**: Automatically reduces large image resolution to - **Intelligent downsampling**: Automatically reduces large image resolution to
save memory (up to 94% memory savings for 8K images) save memory (up to 94% memory savings for 8K images)
- **Advanced filtering**: Nearest, linear, bilinear, and trilinear filtering
options
## Usage ## Usage
@ -41,8 +37,7 @@ comprehensive monitor management. Here's what makes Chroma stand out:
#### Dependencies #### Dependencies
- **Wayland**: wayland-client, wayland-egl - **Wayland**: wayland-client
- **Graphics**: EGL, OpenGL
- **System**: glibc, libm, libdl - **System**: glibc, libm, libdl
#### Development Dependencies #### Development Dependencies
@ -51,7 +46,6 @@ comprehensive monitor management. Here's what makes Chroma stand out:
- Make - Make
- pkg-config - pkg-config
- Wayland development headers - Wayland development headers
- EGL/OpenGL development headers
See [development section](#development) for more details. This section might get See [development section](#development) for more details. This section might get
outdated at any given moment, so refer to the Nix shell if in doubt. outdated at any given moment, so refer to the Nix shell if in doubt.
@ -202,8 +196,8 @@ Chroma works with any Wayland compositor that supports:
- `wl_compositor` interface - `wl_compositor` interface
- `wl_output` interface - `wl_output` interface
- `wl_shm` interface
- `zwlr_layer_shell_v1` (wlr-layer-shell-unstable-v1) interface - `zwlr_layer_shell_v1` (wlr-layer-shell-unstable-v1) interface
- EGL window surface creation
The wlr-layer-shell protocol is required for creating wallpaper surfaces on the The wlr-layer-shell protocol is required for creating wallpaper surfaces on the
background layer. Tested only on Hyprland, but should work fine with any background layer. Tested only on Hyprland, but should work fine with any