Struct Encoder

pub struct Encoder { /* private fields */ }

Make an image with custom settings

Implementations

impl Encoder

pub fn new() -> Self

pub fn set_palette(&mut self, palette: &[RGBA]) -> Result<(), Error>

Switch color mode to 8-bit palette and set the colors

pub fn set_auto_convert(&mut self, mode: bool)

If true, convert to output format

pub fn set_filter_strategy( &mut self, mode: FilterStrategy, palette_filter_zero: bool, )

palette_filter_zero controls filtering for low-bitdepth images

pub fn set_predefined_filters(&mut self, filters: impl Into<Box<[u8]>>)

Filters are 0-5, one per row. https://www.w3.org/TR/PNG-Filters.html

pub fn set_text_compression(&mut self, compr: bool)

gzip text metadata

pub fn set_custom_zlib( &mut self, callback: custom_compress_callback, context: *const c_void, )

Compress using another zlib implementation. It’s gzip header + deflate + adler32 checksum.

pub fn set_custom_deflate( &mut self, callback: custom_compress_callback, context: *const c_void, )

Compress using another deflate implementation. It’s just deflate, without headers or checksum.

pub fn info_raw(&self) -> &ColorMode

pub fn info_raw_mut(&mut self) -> &mut ColorMode

Color mode of the source bytes to be encoded

pub fn info_png(&self) -> &Info

pub fn info_png_mut(&mut self) -> &mut Info

Color mode of the file to be created

pub fn encode<PixelType: Pod>( &self, image: &[PixelType], w: usize, h: usize, ) -> Result<Vec<u8>, Error>

Takes any pixel type, but for safety the type has to be marked as “plain old data”

pub fn encode_file<PixelType: Pod, P: AsRef<Path>>( &self, filepath: P, image: &[PixelType], w: usize, h: usize, ) -> Result<(), Error>

Takes any pixel type, but for safety the type has to be marked as “plain old data”

pub fn settings_mut(&mut self) -> &mut EncoderSettings

Trait Implementations

impl Clone for Encoder

fn clone(&self) -> Encoder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Encoder

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

Formats the value using the given formatter.

impl Default for Encoder

fn default() -> Encoder

Returns the “default value” for a type.