rustdesk/libs/scrap
21pages b4aea69bdb codec benchmark
Signed-off-by: 21pages <pages21@163.com>
2023-03-03 22:12:54 +08:00
..
examples codec benchmark 2023-03-03 22:12:54 +08:00
src codec benchmark 2023-03-03 22:12:54 +08:00
.gitignore source code 2021-03-29 15:59:14 +08:00
build.rs fix m1 pro scrap compile error 2022-09-16 22:22:17 +08:00
Cargo.toml refact register_breakdown_handler 2023-02-19 10:19:28 +08:00
README.md scrap readme 2021-07-29 13:33:26 +08:00
vpx_ffi.h source code 2021-03-29 15:59:14 +08:00

Derived from https://github.com/quadrupleslap/scrap

scrap

Scrap records your screen! At least it does if you're on Windows, macOS, or Linux.

Usage

[dependencies]
scrap = "0.5"

Its API is as simple as it gets!

struct Display; /// A screen.
struct Frame; /// An array of the pixels that were on-screen.
struct Capturer; /// A recording instance.

impl Capturer {
    /// Begin recording.
    pub fn new(display: Display) -> io::Result<Capturer>;

    /// Try to get a frame.
    /// Returns WouldBlock if it's not ready yet.
    pub fn frame<'a>(&'a mut self) -> io::Result<Frame<'a>>;

    pub fn width(&self) -> usize;
    pub fn height(&self) -> usize;
}

impl Display {
    /// The primary screen.
    pub fn primary() -> io::Result<Display>;

    /// All the screens.
    pub fn all() -> io::Result<Vec<Display>>;

    pub fn width(&self) -> usize;
    pub fn height(&self) -> usize;
}

impl<'a> ops::Deref for Frame<'a> {
    /// A frame is just an array of bytes.
    type Target = [u8];
}

The Frame Format

  • The frame format is guaranteed to be packed BGRA.
  • The width and height are guaranteed to remain constant.
  • The stride might be greater than the width, and it may also vary between frames.

System Requirements

OS Minimum Requirements
macOS macOS 10.8
Linux XCB + SHM + RandR
Windows DirectX 11.1