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.

Run wayfreeze, click or press escape to exit.

Usage: wayfreeze [OPTIONS]

Options:
      --hide-cursor  Hide cursor when freezing the screen
  -h, --help         Print help
  -V, --version      Print version

Example usage with Grim & Slurp:

wayfreeze & PID=$!; sleep .1; grim -g "$(slurp)" - | wl-copy; kill $PID

Wayfreeze can be installed either by using nixpkgs-unstable or flake.

Add this to your configuration and rebuild your system:

environment.systemPackages = [ pkgs.wayfreeze ];

Add this repository as a flake to your inputs:

wayfreeze.url = "github:jappie3/wayfreeze";

Define the package and then rebuild your system:

environment.systemPackages = [ inputs.wayfreeze.packages.${pkgs.system}.wayfreeze ];

First, make sure you have Rust & Cargo installed. Then clone this repo & run cargo build --release, the compiled binary should be under ./target/release/wayfreeze.

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

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