Struct CaptureRequest 

#[non_exhaustive]
pub struct CaptureRequest {
    pub include_tree: bool,
    pub include_screenshot: bool,
    pub max_nodes: usize,
    pub max_depth: usize,
    pub window: Option<u64>,
    pub include_menu_bar: bool,
}

Parameters for Backend::capture.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

include_tree: bool

Walk the accessibility tree.

include_screenshot: bool

Capture window pixels.

max_nodes: usize

Maximum raw nodes to visit.

max_depth: usize

Maximum depth to visit.

window: Option<u64>

Capture the window with this WindowInfo::id instead of the focused or main window. Backends that cannot honor it must fail rather than capture another window.

include_menu_bar: bool

Also walk the app’s menu bar when it lives outside the window (macOS). Its nodes follow the window’s, with parent: None on the menu bar itself. Counts toward max_nodes.

Implementations

impl CaptureRequest

pub const fn new( include_tree: bool, include_screenshot: bool, max_nodes: usize, max_depth: usize, ) -> Self

Creates a request.

pub const fn with_window(self, window: Option<u64>) -> Self

Sets window.

pub const fn with_menu_bar(self, yes: bool) -> Self

Sets include_menu_bar.

Trait Implementations

impl Clone for CaptureRequest

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for CaptureRequest

impl Debug for CaptureRequest

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Eq for CaptureRequest

impl PartialEq for CaptureRequest

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for CaptureRequest