Struct lodepng::ffi::State

#[repr(C)]
pub struct State {
    pub decoder: DecoderSettings,
    pub encoder: EncoderSettings,
    pub info_raw: ColorMode,
    pub info_png: Info,
    pub error: ErrorCode,
}

The settings, state and information for extended encoding and decoding

Fields

decoder: DecoderSettings

encoder: EncoderSettings

info_raw: ColorMode

specifies the format in which you would like to get the raw pixel buffer

info_png: Info

info of the PNG image obtained after decoding

error: ErrorCode

Implementations

impl State

pub fn new() -> Self

👎 Deprecated:

Use Decoder or Encoder type instead

pub fn set_auto_convert(&mut self, mode: bool)

pub fn set_filter_strategy(
    &mut self,
    mode: FilterStrategy,
    palette_filter_zero: bool
)

pub fn set_custom_zlib(
    &mut self,
    callback: custom_compress_callback,
    context: *const c_void
)

👎 Deprecated:

Use Encoder type instead of State

See `Encoder’

pub fn set_custom_deflate(
    &mut self,
    callback: custom_compress_callback,
    context: *const c_void
)

👎 Deprecated:

Use Encoder type instead of State

See `Encoder’

pub fn info_raw(&self) -> &ColorMode

pub fn info_raw_mut(&mut self) -> &mut ColorMode

pub fn info_png(&self) -> &Info

pub fn info_png_mut(&mut self) -> &mut Info

pub fn color_convert(&mut self, true_or_false: bool)

whether to convert the PNG to the color type you want. Default: yes

pub fn read_text_chunks(&mut self, true_or_false: bool)

if false but remember_unknown_chunks is true, they’re stored in the unknown chunks.

pub fn remember_unknown_chunks(&mut self, true_or_false: bool)

store all bytes from unknown chunks in the Info (off by default, useful for a png editor)

pub fn get_icc(&self) -> Result<Vec<u8>, Error>

Decompress ICC profile from iCCP chunk. Only available if remember_unknown_chunks was set.

pub fn decode<Bytes: AsRef<[u8]>>(
    &mut self,
    input: Bytes
) -> Result<Image, Error>

👎 Deprecated:

Use Decoder type instead of State

Load PNG from buffer using State’s settings

state.info_raw_mut().colortype = ColorType::RGBA;
match state.decode(&slice) {
    Ok(Image::RGBA(with_alpha)) => do_stuff(with_alpha),
    _ => panic!("¯\\_(ツ)_/¯")
}

pub fn decode_file<P: AsRef<Path>>(
    &mut self,
    filepath: P
) -> Result<Image, Error>

👎 Deprecated:

Use Decoder type instead of State

pub fn inspect(&mut self, input: &[u8]) -> Result<(usize, usize), Error>

👎 Deprecated:

Use Decoder type instead of State

Updates info_png. Returns (width, height)

pub fn encode<PixelType: Pod>(
    &mut self,
    image: &[PixelType],
    w: usize,
    h: usize
) -> Result<Vec<u8>, Error>

👎 Deprecated:

Use Encoder type instead of State

pub fn encode_file<PixelType: Pod, P: AsRef<Path>>(
    &mut self,
    filepath: P,
    image: &[PixelType],
    w: usize,
    h: usize
) -> Result<(), Error>

👎 Deprecated:

Use Encoder type instead of State

Trait Implementations

impl Clone for State

fn clone(&self) -> State

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for State

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for State

fn default() -> Self

Returns the “default value” for a type.