Struct CGImage

Source

pub struct CGImage { /* private fields */ }

Expand description

CGImage wrapper for screenshots

Represents a Core Graphics image returned from screenshot capture.

§Examples

let content = SCShareableContent::get()?;
let display = &content.displays()[0];
let filter = SCContentFilter::create().with_display(display).with_excluding_windows(&[]).build();
let config = SCStreamConfiguration::new()
    .with_width(1920)
    .with_height(1080);

let image = SCScreenshotManager::capture_image(&filter, &config)?;
println!("Screenshot size: {}x{}", image.width(), image.height());

Implementations§

Source §

impl CGImage

Source

pub fn width(&self) -> usize

Get image width in pixels

§Examples

let image = SCScreenshotManager::capture_image(&filter, &config)?;
let width = image.width();
println!("Width: {}", width);

Source

pub fn height(&self) -> usize

Get image height in pixels

Source

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

Source

pub fn rgba_data(&self) -> Result<Vec<u8>, SCError>

Get raw RGBA pixel data

Returns a vector containing RGBA bytes (4 bytes per pixel). The data is in row-major order.

§Errors

Returns an error if the pixel data cannot be extracted

Source

pub fn save_png(&self, path: &str) -> Result<(), SCError>

Save the image to a PNG file

§Arguments

path - The file path to save the PNG to

§Errors

Returns an error if the image cannot be saved

§Examples

let image = SCScreenshotManager::capture_image(&filter, &config)?;
image.save_png("/tmp/screenshot.png")?;

Source

pub fn save(&self, path: &str, format: ImageFormat) -> Result<(), SCError>

Save the image to a file in the specified format

§Arguments

path - The file path to save the image to
format - The output format (PNG, JPEG, TIFF, GIF, BMP, or HEIC)

§Errors

Returns an error if the image cannot be saved

§Examples

let image = SCScreenshotManager::capture_image(&filter, &config)?;

// Save as PNG (lossless)
image.save("/tmp/screenshot.png", ImageFormat::Png)?;

// Save as JPEG with 85% quality
image.save("/tmp/screenshot.jpg", ImageFormat::Jpeg(0.85))?;

// Save as HEIC with 90% quality (smaller file size)
image.save("/tmp/screenshot.heic", ImageFormat::Heic(0.9))?;