Struct Screenshot

Source

pub struct Screenshot { /* private fields */ }

Expand description

A PNG screenshot of a window together with the screen area it shows.

Coordinates handed to Computer::click and Computer::drag are pixels in this image; the crate converts them back to screen points with Screenshot::to_screen_point.

Implementations§

Source §

impl Screenshot

Source

pub fn encode( image: RawImage, frame: Rect, max_dimension: Option<u32>, ) -> Result<Self>

Downscales image so neither side exceeds max_dimension, then encodes it as PNG.

frame is the screen area, in points, the image covers.

§Errors

Returns an error if the buffer size does not match the dimensions or encoding fails.

Source

pub fn png(&self) -> &[u8] ⓘ

PNG-encoded bytes.

Examples found in repository ?

examples/inspect.rs (line 34)

13fn main() -> ExitCode {
14    use computer_use::{CaptureOptions, Computer};
15
16    let mut args = std::env::args().skip(1);
17    let Some(app) = args.next() else {
18        eprintln!("usage: inspect <app name | bundle id | pid:N> [screenshot.png]");
19        return ExitCode::FAILURE;
20    };
21    let output = args.next();
22
23    let run = || -> computer_use::Result<()> {
24        let mut computer = Computer::new()?;
25        let permissions = computer.permissions();
26        if !permissions.all_granted() {
27            eprintln!("warning: missing permissions: {permissions:?}");
28        }
29        let started = std::time::Instant::now();
30        let state = computer.get_app_state(&app, &CaptureOptions::default())?;
31        println!("{state}");
32        eprintln!("\ncaptured {} elements in {:?}", state.elements.len(), started.elapsed());
33        if let (Some(path), Some(shot)) = (output, &state.screenshot) {
34            std::fs::write(&path, shot.png())?;
35            eprintln!("saved {}x{} screenshot to {path}", shot.width(), shot.height());
36        }
37        Ok(())
38    };
39    match run() {
40        Ok(()) => ExitCode::SUCCESS,
41        Err(e) => {
42            eprintln!("error: {e}");
43            ExitCode::FAILURE
44        }
45    }
46}

Source

pub fn into_png(self) -> Vec<u8> ⓘ

Consumes the screenshot and returns the PNG bytes.

Source

pub const fn width(&self) -> u32

Width in pixels.

Examples found in repository ?

examples/inspect.rs (line 35)

13fn main() -> ExitCode {
14    use computer_use::{CaptureOptions, Computer};
15
16    let mut args = std::env::args().skip(1);
17    let Some(app) = args.next() else {
18        eprintln!("usage: inspect <app name | bundle id | pid:N> [screenshot.png]");
19        return ExitCode::FAILURE;
20    };
21    let output = args.next();
22
23    let run = || -> computer_use::Result<()> {
24        let mut computer = Computer::new()?;
25        let permissions = computer.permissions();
26        if !permissions.all_granted() {
27            eprintln!("warning: missing permissions: {permissions:?}");
28        }
29        let started = std::time::Instant::now();
30        let state = computer.get_app_state(&app, &CaptureOptions::default())?;
31        println!("{state}");
32        eprintln!("\ncaptured {} elements in {:?}", state.elements.len(), started.elapsed());
33        if let (Some(path), Some(shot)) = (output, &state.screenshot) {
34            std::fs::write(&path, shot.png())?;
35            eprintln!("saved {}x{} screenshot to {path}", shot.width(), shot.height());
36        }
37        Ok(())
38    };
39    match run() {
40        Ok(()) => ExitCode::SUCCESS,
41        Err(e) => {
42            eprintln!("error: {e}");
43            ExitCode::FAILURE
44        }
45    }
46}

Source

pub const fn height(&self) -> u32

Height in pixels.

Examples found in repository ?

examples/inspect.rs (line 35)

13fn main() -> ExitCode {
14    use computer_use::{CaptureOptions, Computer};
15
16    let mut args = std::env::args().skip(1);
17    let Some(app) = args.next() else {
18        eprintln!("usage: inspect <app name | bundle id | pid:N> [screenshot.png]");
19        return ExitCode::FAILURE;
20    };
21    let output = args.next();
22
23    let run = || -> computer_use::Result<()> {
24        let mut computer = Computer::new()?;
25        let permissions = computer.permissions();
26        if !permissions.all_granted() {
27            eprintln!("warning: missing permissions: {permissions:?}");
28        }
29        let started = std::time::Instant::now();
30        let state = computer.get_app_state(&app, &CaptureOptions::default())?;
31        println!("{state}");
32        eprintln!("\ncaptured {} elements in {:?}", state.elements.len(), started.elapsed());
33        if let (Some(path), Some(shot)) = (output, &state.screenshot) {
34            std::fs::write(&path, shot.png())?;
35            eprintln!("saved {}x{} screenshot to {path}", shot.width(), shot.height());
36        }
37        Ok(())
38    };
39    match run() {
40        Ok(()) => ExitCode::SUCCESS,
41        Err(e) => {
42            eprintln!("error: {e}");
43            ExitCode::FAILURE
44        }
45    }
46}