Struct imagequant::Attributes

pub struct Attributes { /* fields omitted */ }

Settings for the conversion proces. Start here.

Methods

impl Attributes

pub fn new() -> Self

New handle for library configuration

See also new_image()

pub fn set_max_colors(&mut self, value: i32) -> liq_error

It's better to use set_quality()

pub fn set_min_posterization(&mut self, value: i32) -> liq_error

Number of least significant bits to ignore.

Useful for generating palettes for VGA, 15-bit textures, or other retro platforms.

pub fn min_posterization(&mut self) -> i32

Returns number of bits of precision truncated

pub fn set_quality(&mut self, min: u32, max: u32) -> liq_error

Range 0-100, roughly like JPEG.

If minimum quality can't be met, quantization will fail.

Default is min 0, max 100.

pub fn quality(&mut self) -> (u32, u32)

Reads values set with set_quality

pub fn set_speed(&mut self, value: i32) -> liq_error

1-10.

Faster speeds generate images of lower quality, but may be useful for real-time generation of images.

pub fn set_last_index_transparent(&mut self, value: bool)

Move transparent color to the last entry in the palette

This is less efficient for PNG, but required by some broken software

pub fn speed(&mut self) -> i32

Return currently set speed/quality trade-off setting

pub fn max_colors(&mut self) -> i32

Return max number of colors set

pub fn new_image<'a, RGBA: Copy>(
    &self,
    bitmap: &'a [RGBA],
    width: usize,
    height: usize,
    gamma: f64
) -> Result<Image<'a>, liq_error>

Describe dimensions of a slice of RGBA pixels

Use 0.0 for gamma if the image is sRGB (most images are).

pub fn new_image_stride<'a, RGBA: Copy>(
    &self,
    bitmap: &'a [RGBA],
    width: usize,
    height: usize,
    stride: usize,
    gamma: f64
) -> Result<Image<'a>, liq_error>

Stride is in pixels. Allows defining regions of larger images or images with padding without copying.

pub fn new_histogram(&self) -> Histogram

Create new histogram

Use to make one palette suitable for many images

pub fn quantize(
    &mut self,
    image: &Image
) -> Result<QuantizationResult, liq_error>

Generate palette for the image

Trait Implementations

impl Send for Attributes

impl Drop for Attributes

fn drop(&mut self)

Executes the destructor for this type.

impl Clone for Attributes

fn clone(&self) -> Attributes

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for Attributes

fn default() -> Attributes

Returns the "default value" for a type.