Struct ComputerScreenshot 

pub struct ComputerScreenshot {
    pub region: Option<Vec<i32>>,
    pub app: Option<String>,
    pub pid: Option<u32>,
    pub selector: Option<String>,
    pub nth: Option<usize>,
    pub annotate: bool,
    pub max_width: Option<u32>,
    pub timeout_ms: Option<u64>,
    pub surface: Option<SurfaceKind>,
}

Input for computer_screenshot.

Fields

region: Option<Vec<i32>>

Capture only this region of the display, as [x, y, width, height] in display pixels (origin top-left). Mutually exclusive with element capture (app/pid + selector).

app: Option<String>

Application name (exact match) for element capture: shoot only the pixels under the element matched by selector. Requires selector.

pid: Option<u32>

Application process ID for element capture. Requires selector.

selector: Option<String>

Optional CSS-like selector for element capture, e.g. "window[name='Main'] > group". Requires app or pid.

With annotate: true this changes meaning: it selects which elements get annotated boxes (default "*" — every element of the app), and the legend maps each tag to a round-trippable selector. Comma alternations ("button, link") are rejected in both modes.

nth: Option<usize>

1-based match index when selector matches multiple elements (default 1). Not applicable to annotated captures — the legend covers every match; narrow selector instead.

annotate: bool

Draw a labeled box on every matching element and return a legend mapping each tag (B7) back to a selector (*:nth(7)) that computer_act accepts directly — visual grounding without pixel coordinates. Requires app or pid (annotation groups must be application-scoped) and is mutually exclusive with region. Default false.

max_width: Option<u32>

Maximum delivered image width in pixels (default 1568). Larger captures are downscaled preserving aspect ratio; coordinates always refer to the delivered image.

timeout_ms: Option<u64>

How long to wait for the app to appear (element capture only), in milliseconds. Default 3000.

surface: Option<SurfaceKind>

Target an OS SHELL SURFACE instead of an application (mutually exclusive with app/pid; requires selector): shoot the pixels under the matched element of the menu bar, Dock/taskbar/panel, tray status items, the desktop, or a flyout open right now. With annotate: true the legend covers the surface’s elements the same way it covers an app’s.

Trait Implementations

impl Clone for ComputerScreenshot

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ComputerScreenshot

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

Formats the value using the given formatter.

impl Default for ComputerScreenshot

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ComputerScreenshot

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for ComputerScreenshot

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.