Struct SCScreenshotConfiguration 

pub struct SCScreenshotConfiguration { /* private fields */ }

Configuration for advanced screenshot capture (macOS 26.0+)

Provides fine-grained control over screenshot output including:

• Output dimensions
• Source and destination rectangles
• Shadow and clipping behavior
• HDR/SDR dynamic range
• File output

Examples

use screencapturekit::screenshot_manager::{SCScreenshotConfiguration, SCScreenshotDynamicRange};

let config = SCScreenshotConfiguration::new()
    .with_width(1920)
    .with_height(1080)
    .with_shows_cursor(true)
    .with_dynamic_range(SCScreenshotDynamicRange::BothSDRAndHDR);

Implementations

impl SCScreenshotConfiguration

pub fn new() -> Self

Create a new screenshot configuration

Panics

Panics if the configuration cannot be created (requires macOS 26.0+)

pub fn with_width(self, width: usize) -> Self

Set the output width in pixels

pub fn with_height(self, height: usize) -> Self

Set the output height in pixels

pub fn with_shows_cursor(self, shows_cursor: bool) -> Self

Set whether to show the cursor

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

Set the source rectangle (subset of capture area)

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

Set the destination rectangle (output area)

pub fn with_ignore_shadows(self, ignore_shadows: bool) -> Self

Set whether to ignore shadows

pub fn with_ignore_clipping(self, ignore_clipping: bool) -> Self

Set whether to ignore clipping

pub fn with_include_child_windows(self, include_child_windows: bool) -> Self

Set whether to include child windows

pub fn with_display_intent( self, display_intent: SCScreenshotDisplayIntent, ) -> Self

Set the display intent

pub fn with_dynamic_range(self, dynamic_range: SCScreenshotDynamicRange) -> Self

Set the dynamic range

pub fn with_file_path(self, path: &str) -> Self

Set the output file URL

Panics

Panics if the path contains null bytes

pub fn with_content_type(self, identifier: &str) -> Self

Set the content type (output format) using UTType identifier

Common identifiers include:

• "public.png" - PNG format
• "public.jpeg" - JPEG format
• "public.heic" - HEIC format
• "public.tiff" - TIFF format

Use supported_content_types() to get available formats.

Panics

Panics if the identifier contains null bytes

pub fn content_type(&self) -> Option<String>

Get the current content type as UTType identifier

pub fn supported_content_types() -> Vec<String>

Get the list of supported content types (UTType identifiers)

Returns a list of UTType identifiers that can be used with with_content_type().

Common types include:

• "public.png" - PNG format
• "public.jpeg" - JPEG format
• "public.heic" - HEIC format

pub const fn as_ptr(&self) -> *const c_void

Trait Implementations

impl Debug for SCScreenshotConfiguration

Available on crate feature macos_26_0 only.

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

Formats the value using the given formatter.

impl Default for SCScreenshotConfiguration

Available on crate feature macos_26_0 only.

fn default() -> Self

Returns the “default value” for a type.

impl Drop for SCScreenshotConfiguration

Available on crate feature macos_26_0 only.

fn drop(&mut self)

Executes the destructor for this type.

impl Send for SCScreenshotConfiguration

Available on crate feature macos_26_0 only.

impl Sync for SCScreenshotConfiguration

Available on crate feature macos_26_0 only.