Struct crabgrab::capture_stream::CaptureConfig

pub struct CaptureConfig { /* private fields */ }

Configuration settings for a capture stream

Implementations

impl CaptureConfig

pub fn with_window( window: CapturableWindow, pixel_format: CapturePixelFormat ) -> Result<CaptureConfig, CaptureConfigError>

Create a capture configuration for a given capturable window

pub fn with_display( display: CapturableDisplay, pixel_format: CapturePixelFormat ) -> CaptureConfig

Create a capture configuration for a given capturable display

pub fn with_buffer_count(self, buffer_count: usize) -> Self

Configure the buffer count - the number of frames in the capture queue.

Higher numbers mean higher latency, but smoother performance

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

Configure whether the cursor is visible in the capture

pub fn with_output_size(self, output_size: Size) -> Self

Configure the output texture size - by default, this will match the captured content at the time of enumeration

Trait Implementations

impl Clone for CaptureConfig

fn clone(&self) -> CaptureConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CaptureConfig

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

Formats the value using the given formatter.

impl MacosCaptureConfigExt for CaptureConfig

fn with_scale_to_fit(self, scale_to_fit: bool) -> Self

Set whether or not to scale content to the output size

fn with_maximum_fps(self, maximum_fps: Option<f32>) -> Self

Set the maximum capture frame-rate

fn with_metal_device(self, metal_device: Device) -> Self

Set the metal device to use for texture creation

fn with_resolution_type( self, resolution_type: MacosCaptureResolutionType ) -> Self

Set the resolution type of the capture. Does nothing on macos before OS 14.0

impl WgpuCaptureConfigExt for CaptureConfig

fn with_wgpu_device( self, wgpu_device: Arc<dyn AsRef<Device> + Send + Sync + 'static> ) -> Result<Self, String>

Supply a Wgpu device to the config, allowing the generation of Wgpu textures from video frames