grim-rs 0.2.0

Rust implementation of grim screenshot utility for Wayland and Windows
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98

# grim-rs


[![Crates.io Version](https://img.shields.io/crates/v/grim-rs.svg)](https://crates.io/crates/grim-rs)

> [!IMPORTANT]
> [`CHANGELOG`](CHANGELOG.md) · [`API`](doc/api.md) · [`MIGRATION`](MIGRATION.md) · [`Examples`](doc/library_examples.md)

> if you like this project, then the best way to express gratitude is to give it a star ⭐, it doesn't cost you anything, but I understand that I'm moving the project in the right direction.

___

Rust implementation of `grim` screenshot utility for Wayland compositors and Windows (DXGI Desktop Duplication).

## Features


- Pure Rust implementation
- Cross-platform: same API on Linux (Wayland) and Windows (DXGI)
- Native capture via `ext-image-copy-capture-v1`, `zwlr_screencopy_manager_v1`, or DXGI
- Multi-output capture and compositing
- Adaptive image scaling (Nearest / Triangle / CatmullRom / Lanczos3)
- PNG / JPEG output
- Cursor overlay support
- No external runtime screenshot tools required

## Usage


### As a Library


```bash
cargo add grim-rs
```

```toml
[dependencies]
grim-rs = "0.2"
```

**MSRV:** Rust 1.68+

```rust,no_run
use grim_rs::Grim;

fn main() -> grim_rs::Result<()> {
    let mut grim = Grim::new()?;
    let result = grim.capture_all()?;
    grim.save_png(result.data(), result.width(), result.height(), "screenshot.png")?;
    Ok(())
}
```

### Command Line


```bash
# Quick start

cargo run --bin grim-rs

# Capture specific region

cargo run --bin grim-rs -- -g "100,100 800x600" region.png

# Install and run direct binary

cargo install grim-rs
grim-rs -o DP-1 -c monitor.png
```

Full CLI reference: [`doc/cli.md`](doc/cli.md)

## Architecture


![grim-rs architecture](doc/assets/architecture.svg)

### Processing Pipeline


![grim-rs pipeline](doc/assets/pipeline.svg)

## Supported Platforms


**Linux (Wayland):** Hyprland, Sway, River, Wayfire, Niri, any wlroots-based compositor

**Windows:** Windows 8+ with DXGI Desktop Duplication support

## Limitations


- **Linux**: Requires compositor with `ext-image-copy-capture-v1` or `zwlr_screencopy_manager_v1`
- **Windows**: `Grim::new_ext()` and `Grim::new_wlr()` return `Error::UnsupportedProtocol` (Wayland-only); protected content (DRM) cannot be captured

## Building


```bash
cargo build --release
```

## Contributing


See [CONTRIBUTING.md](CONTRIBUTING.md).

## License


MIT License - see [LICENSE](./LICENSE) file for details.