Skip to main content

X11CaptureSourceBuilder

Struct X11CaptureSourceBuilder 

Source
pub struct X11CaptureSourceBuilder { /* private fields */ }
Available on Linux only.
Expand description

A source to capture X11 screen/window content.

This source provides screen capture functionality on Linux systems running X11. It can capture the entire screen or specific areas with cropping options.

Implementations§

Source§

impl X11CaptureSourceBuilder

Source

pub fn set_screen(self, screen: i64) -> Self

Screen/Display to capture

Source

pub fn set_show_cursor(self, show_cursor: bool) -> Self

Whether to show the cursor in the capture

Source

pub fn set_advanced(self, advanced: bool) -> Self

Enable advanced settings

Source

pub fn set_server<T: Into<ObsString> + Sync + Send>(self, server: T) -> Self

X Server to connect to (when using advanced settings)

Source

pub fn set_cut_top(self, cut_top: i64) -> Self

Crop from top (in pixels)

Source

pub fn set_cut_left(self, cut_left: i64) -> Self

Crop from left (in pixels)

Source

pub fn set_cut_right(self, cut_right: i64) -> Self

Crop from right (in pixels)

Source

pub fn set_cut_bot(self, cut_bot: i64) -> Self

Crop from bottom (in pixels)

Trait Implementations§

Source§

impl Debug for X11CaptureSourceBuilder

Source§

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

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

impl ObsObjectBuilder for X11CaptureSourceBuilder

Source§

fn new<T: Into<ObsString> + Send + Sync>( name: T, runtime: ObsRuntime, ) -> Result<Self, ObsError>

Source§

fn runtime(&self) -> &ObsRuntime

Source§

fn get_settings(&self) -> &ObsData

Source§

fn get_settings_updater(&mut self) -> &mut ObsDataUpdater

Source§

fn get_hotkeys(&self) -> &ObsData

Source§

fn get_hotkeys_updater(&mut self) -> &mut ObsDataUpdater

Source§

fn get_name(&self) -> ObsString

Returns the name of the source.
Source§

fn get_id() -> ObsString

Returns the ID of the source.
Source§

fn object_build(self) -> Result<ObjectInfo, ObsError>

Source§

impl ObsSourceBuilder for X11CaptureSourceBuilder

Source§

type T = ObsSourceRef

Source§

fn build(self) -> Result<Self::T, ObsError>
where Self: Sized,

§

fn add_to_scene( self, scene: &mut ObsSceneRef, ) -> Result<ObsSceneItemRef<Self::T>, ObsError>
where Self: Sized,

Both items are returned: the source and the scene item it was added as. You can safely drop these items, they are stored within the scene if you don’t need them.

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