Struct image::codecs::png::PngEncoder
source · pub struct PngEncoder<W: Write> { /* private fields */ }
Expand description
PNG encoder
Implementations§
source§impl<W: Write> PngEncoder<W>
impl<W: Write> PngEncoder<W>
sourcepub fn new(w: W) -> PngEncoder<W>
pub fn new(w: W) -> PngEncoder<W>
Create a new encoder that writes its output to w
sourcepub fn new_with_quality(
w: W,
compression: CompressionType,
filter: FilterType,
) -> PngEncoder<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.
sourcepub 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
pub fn encode( self, data: &[u8], width: u32, height: u32, color: ColorType, ) -> ImageResult<()>
PngEncoder::write_image
instead. Beware that write_image
has a different endianness conventionEncodes the image data
that has dimensions width
and height
and ColorType
c
.
Expects data in big endian.
Trait Implementations§
source§impl<W: Write> ImageEncoder for PngEncoder<W>
impl<W: Write> ImageEncoder for PngEncoder<W>
source§fn write_image(
self,
buf: &[u8],
width: u32,
height: u32,
color_type: ColorType,
) -> ImageResult<()>
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.
Auto Trait Implementations§
impl<W> Freeze for PngEncoder<W>where
W: Freeze,
impl<W> RefUnwindSafe for PngEncoder<W>where
W: RefUnwindSafe,
impl<W> Send for PngEncoder<W>where
W: Send,
impl<W> Sync for PngEncoder<W>where
W: Sync,
impl<W> Unpin for PngEncoder<W>where
W: Unpin,
impl<W> UnwindSafe for PngEncoder<W>where
W: UnwindSafe,
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more