Struct VisualOptions 

pub struct VisualOptions {
    pub snapshot_dir: PathBuf,
    pub channel_tolerance: u8,
    pub threshold_percent: f64,
    pub generate_diff_image: bool,
    pub update_baselines: bool,
    pub mask_regions: Vec<MaskRegion>,
    pub platform_baselines: bool,
}

Options for visual regression comparison.

Fields

snapshot_dir: PathBuf

Directory where baseline snapshots are stored.

channel_tolerance: u8

Per-channel tolerance (0-255). Pixels differing by less than this in all channels are considered matching.

threshold_percent: f64

Maximum allowed diff percentage before comparison fails.

generate_diff_image: bool

Whether to generate a diff image on mismatch.

update_baselines: bool

Whether to update baselines instead of comparing.

mask_regions: Vec<MaskRegion>

Rectangular regions to exclude from comparison.

platform_baselines: bool

Store baselines in a platform-specific subdirectory (e.g., tests/snapshots/windows/). Enabled by default.

Implementations

impl VisualOptions

pub fn with_preset(self, preset: ThresholdPreset) -> Self

Apply a threshold preset, overriding channel_tolerance and threshold_percent.

pub fn with_mask(self, region: MaskRegion) -> Self

Add a mask region to exclude from comparison.

Trait Implementations

impl Clone for VisualOptions

fn clone(&self) -> VisualOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for VisualOptions

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

Formats the value using the given formatter.

impl Default for VisualOptions

fn default() -> Self

Returns the “default value” for a type.