Struct CodecOptions 

pub struct CodecOptions {
    pub color_channel_step_increment: usize,
    pub skip_alpha_channel: bool,
    pub concealer: Concealer,
    pub skip_last_row_and_column: bool,
}

Fields

color_channel_step_increment: usize

determines the step with when iterating over the color channels. For example 2 would move from (R)GBA to RG(B)A. Depending on if the alpha channel is skipped (skip_alpha_channel) it would either not count alpha at all or it does.

For example 2 with alpha skipped would move from RG(B)A to R(G)BA on the next pixel because alpha does not count. Where as when alpha is not skipped it would would move from RG(B)A to (R)GBA on the next pixel.

Note this number influences the capacity directly.

skip_alpha_channel: bool

If true no alpha channel would be used for encoding, this reduces then the capacity by one bit per pixel

concealer: Concealer

the concealer strategy, decides on where in a color channel things are going to be stored.

skip_last_row_and_column: bool

This limits all iterations to skip the least column and row, in fact it reduces width and height of the image by 1

Implementations

impl CodecOptions

pub fn get_color_channel_step_increment(&self) -> usize

pub fn get_skip_alpha_channel(&self) -> bool

Trait Implementations

impl Debug for CodecOptions

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

Formats the value using the given formatter.

impl Default for CodecOptions

fn default() -> Self

The good old golden options