Struct Client 

pub struct Client { /* private fields */ }

A Wayland client that enumerates capturable toplevels and outputs and drives their capture sessions over ext-image-copy-capture.

Implementations

impl Client

pub fn connect() -> Result<Self>

Connect, bind the capture managers, and enumerate windows + outputs.

pub fn toplevels(&self) -> &[Toplevel]

The currently known capturable windows.

pub fn outputs(&self) -> &[Output]

The currently known capturable outputs.

pub fn refresh(&mut self) -> Result<()>

Drain pending Wayland events (new/closed toplevels, etc.) without blocking on a capture, so the source list stays current between capture rounds.

pub fn open_toplevel_session(&mut self, t: &Toplevel) -> Result<SessionId>

Open a persistent capture session for a window. The session and its buffer live until Client::close_session (or the source disappears); re-arm a frame each cycle with [Client::capture].

pub fn open_output_session(&mut self, o: &Output) -> Result<SessionId>

Open a persistent capture session for an output. See Client::open_toplevel_session.

pub fn close_session(&mut self, id: &SessionId)

Tear down a session (e.g. its window closed).

pub fn capture_output_once( &mut self, output: &Output, budget: Duration, ) -> Result<Frame>

One-shot: capture a single frame of output, then tear the session down. Blocks up to budget. For screenshots / timelapse ticks.

pub fn capture_toplevel_once( &mut self, toplevel: &Toplevel, budget: Duration, ) -> Result<Frame>

One-shot: capture a single frame of toplevel, then tear the session down.

pub fn poll( &mut self, budget: Duration, ) -> (Vec<(SessionId, Frame)>, Vec<SessionId>)

Drive all open sessions for up to budget: arm a frame on every idle session, wait for events, and return the frames that became ready (the sources that produced new content). Sessions whose source is static simply keep their frame armed and deliver nothing — which is exactly right, there is nothing new to show.

Also returns the ids of sessions the compositor stopped (e.g. their window closed), so the caller can drop and (if still listed) reopen them.