Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Jappie3/wayfreeze
Tool to freeze the screen of a wlroots compositor
https://github.com/Jappie3/wayfreeze
hyprland wayland wayland-client
Last synced: 27 days ago
JSON representation
Tool to freeze the screen of a wlroots compositor
- Host: GitHub
- URL: https://github.com/Jappie3/wayfreeze
- Owner: Jappie3
- License: agpl-3.0
- Created: 2024-03-05T07:10:56.000Z (4 months ago)
- Default Branch: master
- Last Pushed: 2024-05-23T09:27:34.000Z (about 1 month ago)
- Last Synced: 2024-05-23T09:28:13.039Z (about 1 month ago)
- Topics: hyprland, wayland, wayland-client
- Language: Rust
- Homepage:
- Size: 46.9 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Lists
- awesome-hyprland - Wayfreeze
README
# Wayfreeze
A small CLI tool to freeze the screen of a wlroots compositor, this can be useful to, for example, take a screenshot. Supports multiple monitors & fractional scaling.
## Usage
Run `wayfreeze`, click or press escape to exit.
```bash
Usage: wayfreeze [OPTIONS]
Options:
--hide-cursor Hide cursor when freezing the screen
-h, --help Print help
-V, --version Print version
```
Example usage with [Grim](https://git.sr.ht/~emersion/grim) & [Slurp](https://github.com/emersion/slurp):
```bash
wayfreeze & PID=$!; sleep .1; grim -g "$(slurp)" - | wl-copy; kill $PID
```
## Installing
Add the flake as an input:
```nix
wayfreeze.url = "github:jappie3/wayfreeze";
```
Install the package:
```nix
environment.systemPackages = [inputs.wayfreeze.packages.${pkgs.system}.wayfreeze];
```
## Technical
The following protocols should be supported by your compositor:
- `wlr-layer-shell-unstable-v1` -> used for creating & rendering a layer surface
- `wlr-screencopy-unstable-v1` -> used for copying the current output to a client buffer
- `wp-fractional-scale-v1` -> to support fractional scaling
- `wp-viewporter` -> for scaling the surface
## Credits
In no particular order, here are some resources that were helpful when creating this tool & learning about the Wayland protocol:
- https://wayland.app/protocols/wayland
- https://github.com/hiasen/wayland-rust-client-experiment/
- https://github.com/Smithay/wayland-window/blob/master/examples/simple_window.rs
- https://github.com/rafaelrc7/wayland-pipewire-idle-inhibit/
- https://levans.fr/rust_wayland_1.html
- https://bugaevc.gitbooks.io/writing-wayland-clients/content/black-square/allocating-a-buffer.html
- https://danyspin97.org/talks/writing-a-wayland-wallpaper-daemon-in-rust
- https://docs.rs/wayland-client/latest/wayland_client
- https://wayland-book.com