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 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.

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