English | 简体中文
XCap is a cross-platform screen capture library written in Rust. It supports Linux (X11, Wayland), MacOS, and Windows. XCap supports screenshot and video recording (WIP).
- Cross-platform: Supports Linux (X11, Wayland), MacOS, and Windows.
- Supports multiple screenshot modes: Can take screenshots of the screen and windows.
- Supports video recording: Supports recording of the screen or window (WIP).
Feature | Linux(X11) | Linux(Wayland) | MacOS | Windows(>=Windows 8.1) |
---|---|---|---|---|
Screen Capture | ✅ | ⛔ | ✅ | ✅ |
Window Capture | ✅ | ⛔ | ✅ | ✅ |
Screen Recording | 🛠️ | 🛠️ | 🛠️ | ✅ |
Window Recording | 🛠️ | 🛠️ | 🛠️ | 🛠️ |
- ✅: Feature available
- ⛔: Feature available, but not fully supported in some special scenarios
- 🛠️: To be developed
- Screen Capture
use std::time::Instant;
use xcap::Monitor;
fn normalized(filename: &str) -> String {
filename
.replace("|", "")
.replace("\\", "")
.replace(":", "")
.replace("/", "")
}
fn main() {
let start = Instant::now();
let monitors = Monitor::all().unwrap();
for monitor in monitors {
let image = monitor.capture_image().unwrap();
image
.save(format!("target/monitor-{}.png", normalized(monitor.name())))
.unwrap();
}
println!("运行耗时: {:?}", start.elapsed());
}
- Screen Record
use std::{sync::Arc, thread, time::Duration};
use xcap::Monitor;
fn main() {
let monitor = Monitor::from_point(100, 100).unwrap();
let video_recorder = Arc::new(monitor.video_recorder().unwrap());
let video_recorder_clone = video_recorder.clone();
thread::spawn(move || {
video_recorder_clone
.on_frame(|frame| {
println!("frame: {:?}", frame.width);
Ok(())
})
.unwrap();
});
println!("start");
video_recorder.start().unwrap();
thread::sleep(Duration::from_secs(2));
println!("stop");
video_recorder.stop().unwrap();
thread::sleep(Duration::from_secs(2));
println!("start");
video_recorder.start().unwrap();
thread::sleep(Duration::from_secs(2));
println!("stop");
video_recorder.stop().unwrap();
}
- Window Capture
use std::time::Instant;
use xcap::Window;
fn normalized(filename: &str) -> String {
filename
.replace("|", "")
.replace("\\", "")
.replace(":", "")
.replace("/", "")
}
fn main() {
let start = Instant::now();
let windows = Window::all().unwrap();
let mut i = 0;
for window in windows {
// 最小化的窗口不能截屏
if window.is_minimized() {
continue;
}
println!(
"Window: {:?} {:?} {:?}",
window.title(),
(window.x(), window.y(), window.width(), window.height()),
(window.is_minimized(), window.is_maximized())
);
let image = window.capture_image().unwrap();
image
.save(format!(
"target/window-{}-{}.png",
i,
normalized(window.title())
))
.unwrap();
i += 1;
}
println!("运行耗时: {:?}", start.elapsed());
}
More examples in examples
On Linux, you need to install libxcb
, libxrandr
, and dbus
.
Debian/Ubuntu:
apt-get install libxcb1 libxrandr2 libdbus-1-3
Alpine:
apk add libxcb libxrandr dbus
ArchLinux:
pacman -S libxcb libxrandr dbus
This project is licensed under the Apache License. See the LICENSE file for details.