1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64
//! # PNG encoder and decoder //! This crate contains a PNG encoder and decoder. It supports reading of single lines or whole frames. //! ## The decoder //! The most important types for decoding purposes are [`Decoder`](struct.Decoder.html) and //! [`Reader`](struct.Reader.html). They both wrap a `std::io::Read`. //! `Decoder` serves as a builder for `Reader`. Calling `Decoder::read_info` reads from the `Read` until the //! image data is reached. //! ### Using the decoder //! use std::fs::File; //! //! // The decoder is a build for reader and can be used to set various decoding options //! // via `Transformations`. The default output transformation is `TRANSFORM_EXPAND //! // | TRANSFORM_STRIP_ALPHA`. //! let decoder = png::Decoder::new(File::open("tests/pngsuite/basi0g01.png").unwrap()); //! let (info, mut reader) = decoder.read_info().unwrap(); //! // Allocate the output buffer. //! let mut buf = vec![0; info.buffer_size()]; //! // Read the next frame. Currently this function should only called once. //! // The default options //! reader.next_frame(&mut buf).unwrap(); //! ## Encoder //! ### Using the encoder //! ```ignore //! // For reading and opening files //! use std::path::Path; //! use std::fs::File; //! use std::io::BufWriter; //! // To use encoder.set() //! use png::HasParameters; //! //! let path = Path::new(r"/path/to/image.png"); //! let file = File::create(path).unwrap(); //! let ref mut w = BufWriter::new(file); //! //! let mut encoder = png::Encoder::new(w, 2, 1); // Width is 2 pixels and height is 1. //! encoder.set(png::ColorType::RGBA).set(png::BitDepth::Eight); //! let mut writer = encoder.write_header().unwrap(); //! //! let data = [255, 0, 0, 255, 0, 0, 0, 255]; // An array containing a RGBA sequence. First pixel is red and second pixel is black. //! writer.write_image_data(&data).unwrap(); // Save //! ``` //! //#![cfg_attr(test, feature(test))] #[macro_use] extern crate bitflags; extern crate num_iter; pub mod chunk; mod crc; mod decoder; #[cfg(feature = "png-encoding")] mod encoder; mod filter; mod traits; mod common; mod utils; pub use common::*; pub use decoder::{Decoder, Reader, OutputInfo, StreamingDecoder, Decoded, DecodingError}; #[cfg(feature = "png-encoding")] pub use encoder::{Encoder, Writer, EncodingError}; pub use traits::{Parameter, HasParameters};