pub struct Encoder<W: Write> { /* private fields */ }Expand description
GIF encoder.
Implementations§
source§impl<W: Write> Encoder<W>
impl<W: Write> Encoder<W>
sourcepub fn new(
w: W,
width: u16,
height: u16,
global_palette: &[u8]
) -> Result<Self, EncodingError>
pub fn new( w: W, width: u16, height: u16, global_palette: &[u8] ) -> Result<Self, EncodingError>
Creates a new encoder.
global_palette gives the global color palette in the format [r, g, b, ...],
if no global palette shall be used an empty slice may be supplied.
sourcepub fn set_repeat(&mut self, repeat: Repeat) -> Result<(), EncodingError>
pub fn set_repeat(&mut self, repeat: Repeat) -> Result<(), EncodingError>
Write an extension block that signals a repeat behaviour.
sourcepub fn write_frame(&mut self, frame: &Frame<'_>) -> Result<(), EncodingError>
pub fn write_frame(&mut self, frame: &Frame<'_>) -> Result<(), EncodingError>
Writes a frame to the image.
Note: This function also writes a control extension if necessary.
sourcepub fn write_extension(
&mut self,
extension: ExtensionData
) -> Result<(), EncodingError>
pub fn write_extension( &mut self, extension: ExtensionData ) -> Result<(), EncodingError>
Writes an extension to the image.
It is normally not necessary to call this method manually.
sourcepub fn write_raw_extension(
&mut self,
func: AnyExtension,
data: &[&[u8]]
) -> Result<()>
pub fn write_raw_extension( &mut self, func: AnyExtension, data: &[&[u8]] ) -> Result<()>
Writes a raw extension to the image.
This method can be used to write an unsupported extension to the file. func is the extension
identifier (e.g. Extension::Application as u8). data are the extension payload blocks. If any
contained slice has a lenght > 255 it is automatically divided into sub-blocks.
sourcepub fn write_lzw_pre_encoded_frame(
&mut self,
frame: &Frame<'_>
) -> Result<(), EncodingError>
pub fn write_lzw_pre_encoded_frame( &mut self, frame: &Frame<'_> ) -> Result<(), EncodingError>
Writes a frame to the image, but expects Frame.buffer to contain LZW-encoded data
from Frame::make_lzw_pre_encoded.
Note: This function also writes a control extension if necessary.
sourcepub fn get_mut(&mut self) -> &mut W
pub fn get_mut(&mut self) -> &mut W
Gets a mutable reference to the writer instance used by this encoder.
It is inadvisable to directly write to the underlying writer.
sourcepub fn into_inner(self) -> Result<W>
pub fn into_inner(self) -> Result<W>
Finishes writing, and returns the io::Write instance used by this encoder