Struct PixelWand 

pub struct PixelWand { /* private fields */ }

A safe wrapper around an ImageMagick PixelWand.

The wand owns the underlying ImageMagick handle and destroys it when dropped.

Implementations

impl PixelWand

pub fn new() -> Self

Creates a new, empty PixelWand.

pub fn clear_exception(&mut self) -> Result<(), MagickError>

Clears any exception currently recorded on the wand.

pub fn get_exception_type(&self) -> ExceptionType

Returns the severity of the most recent exception on the wand.

pub fn get_exception(&self) -> Result<(String, ExceptionType), MagickError>

Returns the most recent exception on the wand as a (message, severity) pair, or an error if no exception message is available.

pub fn is_wand(&self) -> Result<(), MagickError>

Returns Ok(()) if this is a valid wand of the expected type.

impl PixelWand

pub fn is_similar(&self, other: &PixelWand, fuzz: f64) -> bool

Return true if the distance between this pixel’s color and the other’s is within the given fuzz factor.

pub fn get_hsl(&self) -> HSL

Return the pixel’s color as hue, saturation, and lightness values.

pub fn set_hsl(&self, hsl: &HSL)

Set the pixel’s color from hue, saturation, and lightness values.

pub fn fmt_w_prefix(&self, f: &mut Formatter<'_>, prefix: &str) -> Result

Format the wand’s settings for debugging, indenting each line with the given prefix.

pub fn set_color(&mut self, s: &str) -> Result<(), MagickError>

Set the pixel’s color from a color string such as "#ff0000" or "red".

pub fn get_color_as_string(&self) -> Result<String, MagickError>

Wraps ImageMagick’s PixelGetColorAsString function.

pub fn get_color_as_normalized_string(&self) -> Result<String, MagickError>

Wraps ImageMagick’s PixelGetColorAsNormalizedString function.

pub fn get_color_count(&self) -> usize

Wraps ImageMagick’s PixelGetColorCount function.

pub fn set_color_count(&mut self, v: usize)

Wraps ImageMagick’s PixelSetColorCount function.

pub fn get_index(&self) -> Quantum

Wraps ImageMagick’s PixelGetIndex function.

pub fn set_index(&mut self, v: Quantum)

Wraps ImageMagick’s PixelSetIndex function.

pub fn get_fuzz(&self) -> f64

Wraps ImageMagick’s PixelGetFuzz function.

pub fn set_fuzz(&mut self, v: f64)

Wraps ImageMagick’s PixelSetFuzz function.

pub fn fmt_unchecked_settings( &self, f: &mut Formatter<'_>, prefix: &str, ) -> Result

pub fn get_alpha(&self) -> f64

Wraps ImageMagick’s PixelGetAlpha function.

pub fn get_alpha_quantum(&self) -> Quantum

Wraps ImageMagick’s PixelGetAlphaQuantum function.

pub fn set_alpha(&mut self, v: f64)

Wraps ImageMagick’s PixelSetAlpha function.

pub fn set_alpha_quantum(&mut self, v: Quantum)

Wraps ImageMagick’s PixelSetAlphaQuantum function.

pub fn get_black(&self) -> f64

Wraps ImageMagick’s PixelGetBlack function.

pub fn get_black_quantum(&self) -> Quantum

Wraps ImageMagick’s PixelGetBlackQuantum function.

pub fn set_black(&mut self, v: f64)

Wraps ImageMagick’s PixelSetBlack function.

pub fn set_black_quantum(&mut self, v: Quantum)

Wraps ImageMagick’s PixelSetBlackQuantum function.

pub fn get_blue(&self) -> f64

Wraps ImageMagick’s PixelGetBlue function.

pub fn get_blue_quantum(&self) -> Quantum

Wraps ImageMagick’s PixelGetBlueQuantum function.

pub fn set_blue(&mut self, v: f64)

Wraps ImageMagick’s PixelSetBlue function.

pub fn set_blue_quantum(&mut self, v: Quantum)

Wraps ImageMagick’s PixelSetBlueQuantum function.

pub fn get_cyan(&self) -> f64

Wraps ImageMagick’s PixelGetCyan function.

pub fn get_cyan_quantum(&self) -> Quantum

Wraps ImageMagick’s PixelGetCyanQuantum function.

pub fn set_cyan(&mut self, v: f64)

Wraps ImageMagick’s PixelSetCyan function.

pub fn set_cyan_quantum(&mut self, v: Quantum)

Wraps ImageMagick’s PixelSetCyanQuantum function.

pub fn get_green(&self) -> f64

Wraps ImageMagick’s PixelGetGreen function.

pub fn get_green_quantum(&self) -> Quantum

Wraps ImageMagick’s PixelGetGreenQuantum function.

pub fn set_green(&mut self, v: f64)

Wraps ImageMagick’s PixelSetGreen function.

pub fn set_green_quantum(&mut self, v: Quantum)

Wraps ImageMagick’s PixelSetGreenQuantum function.

pub fn get_magenta(&self) -> f64

Wraps ImageMagick’s PixelGetMagenta function.

pub fn get_magenta_quantum(&self) -> Quantum

Wraps ImageMagick’s PixelGetMagentaQuantum function.

pub fn set_magenta(&mut self, v: f64)

Wraps ImageMagick’s PixelSetMagenta function.

pub fn set_magenta_quantum(&mut self, v: Quantum)

Wraps ImageMagick’s PixelSetMagentaQuantum function.

pub fn get_red(&self) -> f64

Wraps ImageMagick’s PixelGetRed function.

pub fn get_red_quantum(&self) -> Quantum

Wraps ImageMagick’s PixelGetRedQuantum function.

pub fn set_red(&mut self, v: f64)

Wraps ImageMagick’s PixelSetRed function.

pub fn set_red_quantum(&mut self, v: Quantum)

Wraps ImageMagick’s PixelSetRedQuantum function.

pub fn get_yellow(&self) -> f64

Wraps ImageMagick’s PixelGetYellow function.

pub fn get_yellow_quantum(&self) -> Quantum

Wraps ImageMagick’s PixelGetYellowQuantum function.

pub fn set_yellow(&mut self, v: f64)

Wraps ImageMagick’s PixelSetYellow function.

pub fn set_yellow_quantum(&mut self, v: Quantum)

Wraps ImageMagick’s PixelSetYellowQuantum function.

pub fn fmt_color_settings(&self, f: &mut Formatter<'_>, prefix: &str) -> Result

Trait Implementations

impl Clone for PixelWand

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 PixelWand

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

Formats the value using the given formatter.

impl Default for PixelWand

fn default() -> Self

Returns the “default value” for a type.

impl Drop for PixelWand

fn drop(&mut self)

Executes the destructor for this type.

impl Send for PixelWand