Struct image::codecs::png::PngEncoder

pub struct PngEncoder<W: Write> {
    w: W,
    compression: CompressionType,
    filter: FilterType,
}

PNG encoder

Fields

w: W

compression: CompressionType

filter: FilterType

Implementations

impl<W: Write> PngEncoder<W>

pub fn new(w: W) -> PngEncoder<W>

Create a new encoder that writes its output to w

pub fn new_with_quality( w: W, compression: CompressionType, filter: FilterType, ) -> PngEncoder<W>

Create a new encoder that writes its output to w with CompressionType compression and FilterType filter.

It is best to view the options as a hint to the implementation on the smallest or fastest option for encoding a particular image. That is, using options that map directly to a PNG image parameter will use this parameter where possible. But variants that have no direct mapping may be interpreted differently in minor versions. The exact output is expressly not part of the SemVer stability guarantee.

Note that it is not optimal to use a single filter type, so an adaptive filter type is selected as the default. The filter which best minimizes file size may change with the type of compression used.

pub fn encode( self, data: &[u8], width: u32, height: u32, color: ColorType, ) -> ImageResult<()>

👎Deprecated: Use PngEncoder::write_image instead. Beware that write_image has a different endianness convention

Encodes the image data that has dimensions width and height and ColorType c.

Expects data in big endian.

fn encode_inner( self, data: &[u8], width: u32, height: u32, color: ColorType, ) -> ImageResult<()>

Trait Implementations

impl<W: Write> ImageEncoder for PngEncoder<W>

fn write_image( self, buf: &[u8], width: u32, height: u32, color_type: ColorType, ) -> ImageResult<()>

Write a PNG image with the specified width, height, and color type.

For color types with 16-bit per channel or larger, the contents of buf should be in native endian. PngEncoder will automatically convert to big endian as required by the underlying PNG format.