captis 0.6.1

A Screen capturing library built for Linux, Windows and MacOS.
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

#[cfg(target_os = "windows")]
mod windows;

#[cfg(target_os = "windows")]
pub use windows::WindowsError;

#[cfg(target_os = "windows")]
pub type Error = WindowsError;

#[cfg(target_os = "windows")]
pub type CoordinateType = i32;

#[cfg(target_os = "windows")]
pub type ProportionType = i32;

#[cfg(target_os = "linux")]
mod linux;

#[cfg(target_os = "linux")]
pub use x11rb;

#[cfg(target_os = "linux")]
pub type Error = x11rb::errors::ConnectionError;

#[cfg(target_os = "linux")]
pub type CoordinateType = i16;

#[cfg(target_os = "linux")]
pub type ProportionType = u16;

#[cfg(target_os = "macos")]
mod macos;

#[cfg(target_os = "macos")]
pub use macos::MacOSError;

#[cfg(target_os = "macos")]
pub type Error = MacOSError;

#[cfg(target_os = "macos")]
pub type CoordinateType = f64;

#[cfg(target_os = "macos")]
pub type ProportionType = f64;

pub use image::RgbImage;

#[derive(Debug, Copy, Clone)]
#[repr(C)]
pub(crate) struct Bgr {
    b: u8,
    g: u8,
    r: u8,
    _padding: u8,
}

pub trait Capturer {
    /// Returns a single image from the selected display.
    fn capture(&self, index: usize) -> Result<RgbImage, Error>;
    /// Captures a single image from the primary display.
    fn capture_primary(&self) -> Result<RgbImage, Error>;
    /// Captures a single image from all the displays available and returns them.
    fn capture_all(&self) -> Result<Vec<RgbImage>, Error>;
    /// Returns a reference to the currently available displays.
    fn displays(&self) -> &[Display];
    /// Refreshes the current displays.
    fn refresh_displays(&mut self) -> Result<(), Error>;
}

#[derive(Debug, Copy, Clone)]
pub struct Display {
    top: CoordinateType,
    left: CoordinateType,
    width: ProportionType,
    height: ProportionType,
}

impl Display {
    pub fn width(&self) -> ProportionType {
        self.width
    }
    pub fn height(&self) -> ProportionType {
        self.height
    }
}

#[cfg(target_os = "windows")]
pub fn init_capturer() -> Result<impl Capturer, Error> {
    use windows::*;
    Ok(WindowsCapturer::new()?)
}

#[cfg(target_os = "linux")]
pub fn init_capturer() -> Result<impl Capturer, Error> {
    use linux::*;
    Ok(X11Capturer::new()?)
}

#[cfg(target_os = "macos")]
pub fn init_capturer() -> Result<impl Capturer, Error> {
    use macos::*;
    Ok(MacOSCapturer::new()?)
}