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
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130

#[cfg(target_os = "linux")]
pub(crate) mod wayland;
#[cfg(target_os = "linux")]
use wayland::WaylandCapture;

#[cfg(target_os = "windows")]
pub(crate) mod windows;
#[cfg(target_os = "windows")]
use windows::WindowsCapture;

use crate::{
    Backend, CaptureParameters, CaptureResult, MultiOutputCaptureResult, Output, Region, Result,
};

/// Platform abstraction — static enum, no allocation, no vtable.
pub(crate) enum Platform {
    #[cfg(target_os = "linux")]
    Wayland(WaylandCapture),
    #[cfg(target_os = "windows")]
    Windows(WindowsCapture),
}

/// Generate a match that delegates to all platform variants.
macro_rules! dispatch {
    ($self:expr, $method:ident $(, $arg:expr)*) => {
        match $self {
            #[cfg(target_os = "linux")]
            Platform::Wayland(w) => w.$method($($arg),*),
            #[cfg(target_os = "windows")]
            Platform::Windows(w) => w.$method($($arg),*),
        }
    };
}

impl Platform {
    pub(crate) fn new() -> Result<Self> {
        #[cfg(target_os = "linux")]
        {
            Ok(Platform::Wayland(WaylandCapture::new(Backend::Auto)?))
        }
        #[cfg(target_os = "windows")]
        {
            Ok(Platform::Windows(WindowsCapture::new(Backend::Auto)?))
        }
        #[cfg(not(any(target_os = "linux", target_os = "windows")))]
        {
            Err(crate::Error::UnsupportedProtocol(
                "No platform backend available for this operating system".to_string(),
            ))
        }
    }

    pub(crate) fn new_with_backend(backend: Backend) -> Result<Self> {
        #[cfg(target_os = "linux")]
        {
            Ok(Platform::Wayland(WaylandCapture::new(backend)?))
        }
        #[cfg(target_os = "windows")]
        {
            match backend {
                Backend::Auto => Ok(Platform::Windows(WindowsCapture::new(backend)?)),
                Backend::ExtImageCopyCapture | Backend::WlrScreencopy => {
                    Err(crate::Error::UnsupportedProtocol(
                        "ext-image-copy-capture-v1 and wlr-screencopy are Wayland protocols \
                         not available on Windows"
                            .to_string(),
                    ))
                }
            }
        }
        #[cfg(not(any(target_os = "linux", target_os = "windows")))]
        {
            let _ = backend;
            Err(crate::Error::UnsupportedProtocol(
                "No platform backend available for this operating system".to_string(),
            ))
        }
    }

    pub(crate) fn get_outputs(&mut self) -> Result<Vec<Output>> {
        dispatch!(self, get_outputs)
    }

    pub(crate) fn capture_all(&mut self) -> Result<CaptureResult> {
        dispatch!(self, capture_all)
    }

    pub(crate) fn capture_all_with_scale(&mut self, scale: f64) -> Result<CaptureResult> {
        dispatch!(self, capture_all_with_scale, scale)
    }

    pub(crate) fn capture_output(&mut self, output_name: &str) -> Result<CaptureResult> {
        dispatch!(self, capture_output, output_name)
    }

    pub(crate) fn capture_output_with_scale(
        &mut self,
        output_name: &str,
        scale: f64,
    ) -> Result<CaptureResult> {
        dispatch!(self, capture_output_with_scale, output_name, scale)
    }

    pub(crate) fn capture_region(&mut self, region: Region) -> Result<CaptureResult> {
        dispatch!(self, capture_region, region)
    }

    pub(crate) fn capture_region_with_scale(
        &mut self,
        region: Region,
        scale: f64,
    ) -> Result<CaptureResult> {
        dispatch!(self, capture_region_with_scale, region, scale)
    }

    pub(crate) fn capture_outputs(
        &mut self,
        parameters: Vec<CaptureParameters>,
    ) -> Result<MultiOutputCaptureResult> {
        dispatch!(self, capture_outputs, parameters)
    }

    pub(crate) fn capture_outputs_with_scale(
        &mut self,
        parameters: Vec<CaptureParameters>,
        default_scale: f64,
    ) -> Result<MultiOutputCaptureResult> {
        dispatch!(self, capture_outputs_with_scale, parameters, default_scale)
    }
}