Skip to main content

ScreencopyView

Struct ScreencopyView 

Source
pub struct ScreencopyView { /* private fields */ }
Expand description

Shows what an output or a window shows, captured by the compositor, in the box its style’s width and height give it, as an Image shows a picture. It draws nothing until the first frame arrives.

It captures one frame, unless it is live: then each change to the source brings a new frame, and a source that doesn’t change sends none, so it wakes nothing. A source that isn’t there yet, such as an output not plugged in, is waited for. When it goes, the last frame stays.

use crabshell_ui::{CaptureSource, ScreencopyView, Style};

let thumbnail = ScreencopyView::new(CaptureSource::Output(String::from("DP-1")))
    .live(true)
    .style(Style::new().width(192.0).height(108.0));

Implementations§

Source§

impl ScreencopyView

Source

pub fn new(source: impl IntoProp<CaptureSource>) -> ScreencopyView

A view of source: a CaptureSource, or a closure that returns one.

Source

pub fn of(capture: Capture) -> ScreencopyView

A view of capture’s frame, which it shares with every other view of it; the view captures nothing itself, so live and paint_cursors do nothing. It draws nothing while the capture has no frame.

Source

pub fn crop(self, rect: impl IntoProp<Option<Rect>>) -> ScreencopyView

Shows only this part of the frame, in the source’s logical pixels, as an output’s windows are placed, filling the view’s box as fit says. The part is cut to the frame, and one wholly outside it draws nothing. None, the default, shows the whole frame. A view of a source with a crop asks for the source’s whole frame, at its own resolution, so the part stays sharp. A window’s logical pixels are taken at the largest output scale, so with outputs of mixed scales a crop of a window on a smaller-scale one misses its mark.

Source

pub fn shown(self, shown: Signal<bool>) -> ScreencopyView

Writes true to shown once the picture this view shows is on screen: the compositor presented the window’s frame that first drew it, as its frame callback says. It writes false while the view has no picture, from when it takes a new one until that is presented, and while the view is hidden, outside the window or a clipping ancestor, or its window has no surface. Give each view a signal of its own.

Source

pub fn live(self, live: impl IntoProp<bool>) -> ScreencopyView

Whether each change to the source shows, rather than only the first frame. Off by default.

Source

pub fn paint_cursors(self, paint: impl IntoProp<bool>) -> ScreencopyView

Whether the pointer is drawn into the frames. Off by default.

Source

pub fn fit(self, fit: impl IntoProp<Fit>) -> ScreencopyView

Sets how the frame fills the view’s box when their shapes differ.

Source

pub fn style(self, style: impl IntoProp<Style>) -> ScreencopyView

Sets the style, whose width and height give the view its size.

Source

pub fn visible(self, visible: impl IntoProp<bool>) -> Self

Shows or hides the widget. Hidden, it is taken out of the layout, so its space goes to the others, and it isn’t drawn, hit or reached by Tab; it drops the keyboard focus and the pointer. Its bindings and state stay, so it shows again as it was. Shown by default.

Source

pub fn geometry(self, geometry: Signal<Rect>) -> Self

Shares where the widget is: after each layout that moves or resizes it, its laid-out rectangle in the window’s logical pixels, scrolled with any scroll view around it but not moved by a style’s translate, scale or rotate, is written to geometry. A hidden widget writes nothing. An effect that reads it may change the layout: the window is laid out again at once, until nothing moves.

Source

pub fn mapped_geometry(self, geometry: Signal<Rect>) -> Self

Shares where the widget is drawn: the box around it once its own and its ancestors’ translate, scale and rotate have moved it, in the window’s logical pixels, scrolled with any scroll view around it. It is written after each layout that moves it and after each change of a transform or an offset that does, every frame of an animated one. A hidden widget writes nothing. Where the window itself is on its output is unknown: Wayland doesn’t tell a client.

Source

pub fn accessible_name(self, name: impl IntoProp<String>) -> Self

What a screen reader calls the widget, instead of what it shows: a button’s text, a text’s own, or a field’s placeholder. An icon button needs one to be read at all.

Source

pub fn mask_region(self, region: impl IntoProp<Option<Region>>) -> Self

Keeps the widget and everything inside it only within region, given in the widget’s own logical pixels from its top-left corner, with antialiased edges and rounded corners. Nothing shows outside the widget’s box, as with a style’s mask, and both apply when both are set. None, the default, keeps it all.

It changes only what is drawn: the pointer still hits the whole widget, so a click in a hole reaches it. A window’s own mask is what lets clicks through.

A new region repaints the widget’s painted area, its box unless its children overflow it, and never lays the window out, so a region that changes every frame of an animation costs a repaint of that area each frame. A full-screen 1080p picture with a few rounded holes took about 6 to 8 ms a frame at scale 1 and 22 to 25 ms at scale 2 on a 12-core laptop, most of it in the tiles a hole’s edge crosses.

Trait Implementations§

Source§

impl Widget for ScreencopyView

Source§

fn into_element(self: Box<Self>) -> Element

Turns the description, and everything inside it, into the element the window builds nodes from. It runs when the window is created or a list item first appears, before the window’s tree is touched and without recording what it reads, so it only describes.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more