Settings

windows_capture::settings

Struct Settings 

Source 
pub struct Settings<Flags, T: TryIntoCaptureItemWithType> { /* private fields */ }
Expand description

Represents the settings for a screen capture session.

Implementations§

Source§

impl<Flags, T: TryIntoCaptureItemWithType> Settings<Flags, T>

Source

pub const fn new( item: T, cursor_capture_settings: CursorCaptureSettings, draw_border_settings: DrawBorderSettings, secondary_window_settings: SecondaryWindowSettings, minimum_update_interval_settings: MinimumUpdateIntervalSettings, dirty_region_settings: DirtyRegionSettings, color_format: ColorFormat, flags: Flags, ) -> Self

Creates a new Settings configuration.

§Arguments
  • item - The item to be captured (a Window or Monitor).
  • cursor_capture_settings - The desired cursor capture behavior.
  • draw_border_settings - The desired border drawing behavior.
  • secondary_window_settings - The desired behavior for capturing secondary windows.
  • minimum_update_interval_settings - The desired minimum time between frame updates.
  • dirty_region_settings - The desired behavior for handling dirty regions.
  • color_format - The desired pixel format for the captured frames.
  • flags - Custom flags to be passed to the capture implementation’s new function.
Source

pub const fn item(&self) -> &T

Returns a reference to the capture item.

§Returns

A reference to the item to be captured.

Source

pub const fn cursor_capture(&self) -> CursorCaptureSettings

Returns the cursor capture settings.

§Returns

The current CursorCaptureSettings.

Source

pub const fn draw_border(&self) -> DrawBorderSettings

Returns the draw border settings.

§Returns

The current DrawBorderSettings.

Source

pub const fn color_format(&self) -> ColorFormat

Returns the color format.

§Returns

The current ColorFormat.

Source

pub const fn flags(&self) -> &Flags

Returns a reference to the flags.

§Returns

A reference to the user-defined flags.

Trait Implementations§

Source§

impl<Flags: Clone, T: Clone + TryIntoCaptureItemWithType> Clone for Settings<Flags, T>

Source§

fn clone(&self) -> Settings<Flags, T>

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<Flags: Debug, T: Debug + TryIntoCaptureItemWithType> Debug for Settings<Flags, T>

Source§

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

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

impl<Flags: PartialEq, T: PartialEq + TryIntoCaptureItemWithType> PartialEq for Settings<Flags, T>

Source§

fn eq(&self, other: &Settings<Flags, T>) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · 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<Flags: Eq, T: Eq + TryIntoCaptureItemWithType> Eq for Settings<Flags, T>

Source§

impl<Flags, T: TryIntoCaptureItemWithType> StructuralPartialEq for Settings<Flags, T>

Auto Trait Implementations§

§

impl<Flags, T> Freeze for Settings<Flags, T>
where T: Freeze, Flags: Freeze,

§

impl<Flags, T> RefUnwindSafe for Settings<Flags, T>
where T: RefUnwindSafe, Flags: RefUnwindSafe,

§

impl<Flags, T> Send for Settings<Flags, T>
where T: Send, Flags: Send,

§

impl<Flags, T> Sync for Settings<Flags, T>
where T: Sync, Flags: Sync,

§

impl<Flags, T> Unpin for Settings<Flags, T>
where T: Unpin, Flags: Unpin,

§

impl<Flags, T> UnwindSafe for Settings<Flags, T>
where T: UnwindSafe, Flags: UnwindSafe,

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
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.