Skip to main content

AsyncSCShareableContentOptions

Struct AsyncSCShareableContentOptions 

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

Options for async shareable content retrieval

Implementations§

Source§

impl AsyncSCShareableContentOptions

Source

pub fn with_exclude_desktop_windows(self, exclude: bool) -> Self

Exclude desktop windows from the shareable content

Source

pub fn with_on_screen_windows_only(self, on_screen_only: bool) -> Self

Include only on-screen windows in the shareable content

Source

pub fn get(self) -> AsyncShareableContentFuture ⓘ

Asynchronously get the shareable content with these options

Source

pub fn below_window( self, reference_window: &SCWindow, ) -> AsyncShareableContentFuture ⓘ

Asynchronously get shareable content with only windows below a reference window

This returns windows that are stacked below the specified reference window in the window layering order.

§Arguments
  • reference_window - The window to use as the reference point
Source

pub fn above_window( self, reference_window: &SCWindow, ) -> AsyncShareableContentFuture ⓘ

Asynchronously get shareable content with only windows above a reference window

This returns windows that are stacked above the specified reference window in the window layering order.

§Arguments
  • reference_window - The window to use as the reference point

Trait Implementations§

Source§

impl Clone for AsyncSCShareableContentOptions

Source§

fn clone(&self) -> AsyncSCShareableContentOptions

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for AsyncSCShareableContentOptions

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for AsyncSCShareableContentOptions

Source§

fn default() -> AsyncSCShareableContentOptions

Returns the “default value” for a type. Read more
Source§

impl Eq for AsyncSCShareableContentOptions

Source§

impl PartialEq for AsyncSCShareableContentOptions

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for AsyncSCShareableContentOptions

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.