Struct SCContentFilter 

pub struct SCContentFilter(/* private fields */);

Content filter for ScreenCaptureKit streams

Defines what content to capture (displays, windows, or applications).

Examples

use screencapturekit::shareable_content::SCShareableContent;
use screencapturekit::stream::content_filter::SCContentFilter;

let content = SCShareableContent::get()?;
let display = &content.displays()[0];

// Capture entire display
let filter = SCContentFilter::create()
    .with_display(display)
    .with_excluding_windows(&[])
    .build();

// Or capture a specific window
let window = &content.windows()[0];
let filter = SCContentFilter::create()
    .with_window(window)
    .build();

Implementations

impl SCContentFilter

pub fn create() -> SCContentFilterBuilder

Creates a content filter builder

Examples

use screencapturekit::prelude::*;

let content = SCShareableContent::get()?;
let display = &content.displays()[0];

let filter = SCContentFilter::create()
    .with_display(display)
    .with_excluding_windows(&[])
    .build();

pub fn set_content_rect(self, rect: CGRect) -> Self

Sets the content rectangle for this filter (macOS 14.2+)

Specifies the rectangle within the content filter to capture.

pub fn content_rect(&self) -> CGRect

Gets the content rectangle for this filter (macOS 14.2+)

pub fn style(&self) -> SCShareableContentStyle

Get the content style (macOS 14.0+)

Returns the type of content being captured (window, display, application, or none).

pub fn stream_type(&self) -> SCStreamType

Get the stream type (macOS 14.0+)

Returns whether this filter captures a window or a display.

pub fn point_pixel_scale(&self) -> f32

Get the point-to-pixel scale factor (macOS 14.0+)

Returns the scaling factor used to convert points to pixels. Typically 2.0 for Retina displays.

pub fn set_include_menu_bar(&mut self, include: bool)

Include the menu bar in capture (macOS 14.2+)

When set to true, the menu bar is included in display capture. This property has no effect for window filters.

pub fn include_menu_bar(&self) -> bool

Check if menu bar is included in capture (macOS 14.2+)

pub fn included_displays(&self) -> Vec<SCDisplay>

Get included displays (macOS 15.2+)

Returns the displays currently included in this filter.

pub fn included_windows(&self) -> Vec<SCWindow>

Get included windows (macOS 15.2+)

Returns the windows currently included in this filter.

pub fn included_applications(&self) -> Vec<SCRunningApplication>

Get included applications (macOS 15.2+)

Returns the applications currently included in this filter.

Trait Implementations

impl Clone for SCContentFilter

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SCContentFilter

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

Formats the value using the given formatter.

impl Display for SCContentFilter

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

Formats the value using the given formatter.

impl Drop for SCContentFilter

fn drop(&mut self)

Executes the destructor for this type.

impl Hash for SCContentFilter

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for SCContentFilter

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Eq for SCContentFilter

impl Send for SCContentFilter

impl Sync for SCContentFilter