Struct CaptureOptions 

pub struct CaptureOptions { /* private fields */ }

Configuration options for HTML screenshot capture.

Provides fine-grained control over the screenshot capture process, including image format, quality, viewport settings, and more.

Example

use cdp_html_shot::{CaptureOptions, Viewport, ImageFormat};

let options = CaptureOptions::new()
    .with_format(ImageFormat::Png)
    .with_viewport(Viewport::new(1920, 1080).with_device_scale_factor(2.0))
    .with_full_page(true);

Implementations

impl CaptureOptions

pub fn new() -> Self

Creates a new CaptureOptions with default settings.

pub fn with_format(self, format: ImageFormat) -> Self

Sets the image format for the screenshot.

pub fn with_quality(self, quality: u8) -> Self

Sets the quality for JPEG/WebP (0-100). Ignored for PNG.

pub fn with_viewport(self, viewport: Viewport) -> Self

Sets the viewport configuration for the capture.

This is particularly useful for setting deviceScaleFactor to get higher resolution screenshots.

pub fn with_full_page(self, full_page: bool) -> Self

Sets whether to capture the full scrollable page.

pub fn with_omit_background(self, omit: bool) -> Self

Sets whether to omit the background (transparent for PNG).

pub fn with_clip(self, clip: ClipRegion) -> Self

Sets a clip region for the screenshot.

pub fn raw_png() -> Self

Convenience method: creates options for raw PNG output.

pub fn high_quality_jpeg() -> Self

Convenience method: creates options for high-quality JPEG.

pub fn hidpi() -> Self

Convenience method: creates options for HiDPI (2x) screenshots.

pub fn ultra_hidpi() -> Self

Convenience method: creates options for ultra HiDPI (3x) screenshots.

pub fn with_raw_png(self, raw: bool) -> Self

👎Deprecated since 0.2.0: Use with_format() instead

Specifies whether to capture screenshots as raw PNG (true) or JPEG (false).

Trait Implementations

impl Clone for CaptureOptions

fn clone(&self) -> CaptureOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CaptureOptions

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

Formats the value using the given formatter.

impl Default for CaptureOptions

fn default() -> CaptureOptions

Returns the “default value” for a type.