Struct pxsort::Config

pub struct Config {
    pub minimum: u8,
    pub maximum: u8,
    pub function: Heuristic,
    pub reverse: bool,
    pub invert: bool,
    pub vertical: bool,
    pub mask_alpha: bool,
    pub angle: f32,
    pub path: Shape,
    // some fields omitted
}

Sorting configuration.

Includes how to traverse the pixel grid, which regions of the image to skip, and what metric to sort by.

Fields

minimum: u8

Minimum value to sort

maximum: u8

Maximum value to sort

function: Heuristic

Sort heuristic to use

reverse: bool

Reverse the sort direction

invert: bool

Sort outside specified range rather than inside

vertical: bool

Rotate the sort path by 90 degrees

mask_alpha: bool

Don't sort pixels that have zero alpha

angle: f32

Rotate the sort path by a custom angle

path: Shape

Path shape to traverse the image

Methods

impl Config

pub fn sort(&self, img: DynamicImage) -> DynamicImage

Sort pixels according to configured settings and return a new image.

Trait Implementations

impl Default for Config

fn default() -> Self

Returns the "default value" for a type.

impl StructOpt for Config

fn clap<'a, 'b>() -> App<'a, 'b>

Returns the corresponding clap::App.

fn from_clap(matches: &ArgMatches) -> Self

Creates the struct from clap::ArgMatches. It cannot fail with a parameter generated by clap by construction.

fn from_args() -> Self

Gets the struct from the command line arguments. Print the error message and quit the program in case of failure.

fn from_iter<I>(iter: I) -> Self where
    I: IntoIterator,
    <I as IntoIterator>::Item: Into<OsString>,
    <I as IntoIterator>::Item: Clone, 

Gets the struct from any iterator such as a Vec of your making. Print the error message and quit the program in case of failure.

fn from_iter_safe<I>(iter: I) -> Result<Self, Error> where
    I: IntoIterator,
    <I as IntoIterator>::Item: Into<OsString>,
    <I as IntoIterator>::Item: Clone, 

Gets the struct from any iterator such as a Vec of your making.