[−][src]Struct rin::graphics::image::pnm::PNMEncoder
Encodes images to any of the pnm
image formats.
Methods
impl<W> PNMEncoder<W> where
W: Write,
[src]
impl<W> PNMEncoder<W> where
W: Write,
pub fn new(writer: W) -> PNMEncoder<W>
[src]
pub fn new(writer: W) -> PNMEncoder<W>
Create new PNMEncoder from the writer
.
The encoded images will have some pnm
format. If more control over the image type is
required, use either one of with_subtype
or with_header
. For more information on the
behaviour, see with_dynamic_header
.
pub fn with_subtype(self, subtype: PNMSubtype) -> PNMEncoder<W>
[src]
pub fn with_subtype(self, subtype: PNMSubtype) -> PNMEncoder<W>
Encode a specific pnm subtype image.
The magic number and encoding type will be chosen as provided while the rest of the header data will be generated dynamically. Trying to encode incompatible images (e.g. encoding an RGB image as Graymap) will result in an error.
This will overwrite the effect of earlier calls to with_header
and with_dynamic_header
.
pub fn with_header(self, header: PNMHeader) -> PNMEncoder<W>
[src]
pub fn with_header(self, header: PNMHeader) -> PNMEncoder<W>
Enforce the use of a chosen header.
While this option gives the most control over the actual written data, the encoding process will error in case the header data and image parameters do not agree. It is the users obligation to ensure that the width and height are set accordingly, for example.
Choose this option if you want a lossless decoding/encoding round trip.
This will overwrite the effect of earlier calls to with_subtype
and with_dynamic_header
.
pub fn with_dynamic_header(self) -> PNMEncoder<W>
[src]
pub fn with_dynamic_header(self) -> PNMEncoder<W>
Create the header dynamically for each image.
This is the default option upon creation of the encoder. With this, most images should be encodable but the specific format chosen is out of the users control. The pnm subtype is chosen arbitrarily by the library.
This will overwrite the effect of earlier calls to with_subtype
and with_header
.
pub fn encode<'s, S>(
&mut self,
image: S,
width: u32,
height: u32,
color: ColorType
) -> Result<(), Error> where
S: Into<FlatSamples<'s>>,
[src]
pub fn encode<'s, S>(
&mut self,
image: S,
width: u32,
height: u32,
color: ColorType
) -> Result<(), Error> where
S: Into<FlatSamples<'s>>,
Encode an image whose samples are represented as u8
.
Some pnm
subtypes are incompatible with some color options, a chosen header most
certainly with any deviation from the original decoded image.
Auto Trait Implementations
impl<W> Send for PNMEncoder<W> where
W: Send,
impl<W> Send for PNMEncoder<W> where
W: Send,
impl<W> Sync for PNMEncoder<W> where
W: Sync,
impl<W> Sync for PNMEncoder<W> where
W: Sync,
Blanket Implementations
impl<T, U> Into for T where
U: From<T>,
[src]
impl<T, U> Into for T where
U: From<T>,
impl<T> From for T
[src]
impl<T> From for T
impl<T, U> TryFrom for T where
T: From<U>,
[src]
impl<T, U> TryFrom for T where
T: From<U>,
type Error = !
try_from
)The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
impl<T> Borrow for T where
T: ?Sized,
[src]
impl<T> Borrow for T where
T: ?Sized,
impl<T> Any for T where
T: 'static + ?Sized,
[src]
impl<T> Any for T where
T: 'static + ?Sized,
fn get_type_id(&self) -> TypeId
[src]
fn get_type_id(&self) -> TypeId
impl<T, U> TryInto for T where
U: TryFrom<T>,
[src]
impl<T, U> TryInto for T where
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
try_from
)The type returned in the event of a conversion error.
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
impl<T> BorrowMut for T where
T: ?Sized,
[src]
impl<T> BorrowMut for T where
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
fn borrow_mut(&mut self) -> &mut T
impl<T> Any for T where
T: Any,
[src]
impl<T> Any for T where
T: Any,
fn get_type_id(&self) -> TypeId
[src]
fn get_type_id(&self) -> TypeId
impl<T> SetParameter for T
[src]
impl<T> SetParameter for T
fn set<T>(&mut self, value: T) -> <T as Parameter<Self>>::Result where
T: Parameter<Self>,
[src]
fn set<T>(&mut self, value: T) -> <T as Parameter<Self>>::Result where
T: Parameter<Self>,
Sets value
as a parameter of self
.
impl<V> IntoVec for V
[src]
impl<V> IntoVec for V
impl<V> IntoPnt for V
[src]
impl<V> IntoPnt for V
impl<SS, SP> SupersetOf for SP where
SS: SubsetOf<SP>,
[src]
impl<SS, SP> SupersetOf for SP where
SS: SubsetOf<SP>,
fn to_subset(&self) -> Option<SS>
[src]
fn to_subset(&self) -> Option<SS>
fn is_in_subset(&self) -> bool
[src]
fn is_in_subset(&self) -> bool
unsafe fn to_subset_unchecked(&self) -> SS
[src]
unsafe fn to_subset_unchecked(&self) -> SS
fn from_subset(element: &SS) -> SP
[src]
fn from_subset(element: &SS) -> SP
impl<T> Same for T
[src]
impl<T> Same for T
type Output = T
Should always be Self