Struct lodepng::ffi::Info

#[repr(C)]
pub struct Info {
    pub interlace_method: u8,
    pub color: ColorMode,
    pub background_defined: bool,
    pub background_r: u16,
    pub background_g: u16,
    pub background_b: u16,
    pub time_defined: bool,
    pub time: Time,
    pub phys_defined: bool,
    pub phys_x: c_uint,
    pub phys_y: c_uint,
    pub phys_unit: u8,
    /* private fields */
}

Information about the PNG image, except pixels, width and height

Fields

interlace_method: u8

interlace method of the original file

color: ColorMode

color type and bits, palette and transparency of the PNG file

background_defined: bool

suggested background color chunk (bKGD) This color uses the same color mode as the PNG (except alpha channel), which can be 1-bit to 16-bit.

For greyscale PNGs, r, g and b will all 3 be set to the same. When encoding the encoder writes the red one. For palette PNGs: When decoding, the RGB value will be stored, not a palette index. But when encoding, specify the index of the palette in background_r, the other two are then ignored.

The decoder does not use this background color to edit the color of pixels.

background_r: u16

red component of suggested background color

background_g: u16

green component of suggested background color

background_b: u16

blue component of suggested background color

time_defined: bool

set to 1 to make the encoder generate a tIME chunk

time: Time

time chunk (tIME)

phys_defined: bool

if 0, there is no pHYs chunk and the values below are undefined, if 1 else there is one

phys_x: c_uint

pixels per unit in x direction

phys_y: c_uint

pixels per unit in y direction

phys_unit: u8

may be 0 (unknown unit) or 1 (metre)

Implementations

impl Info

pub fn new() -> Self

pub fn text_keys(&self) -> TextKeysIter<'_>

pub fn text_keys_cstr(&self) -> TextKeysIter<'_>

👎 Deprecated:

use text_keys

pub fn itext_keys(&self) -> ITextKeysIter<'_>

pub fn clear_text(&mut self)

use this to clear the texts again after you filled them in

pub fn add_text(&mut self, key: &str, str: &str) -> Result<(), Error>

push back both texts at once

pub fn clear_itext(&mut self)

use this to clear the itexts again after you filled them in

pub fn add_itext(
    &mut self,
    key: &str,
    langtag: &str,
    transkey: &str,
    text: &str
) -> Result<(), Error>

push back the 4 texts of 1 chunk at once

pub fn append_chunk(
    &mut self,
    position: ChunkPosition,
    chunk: ChunkRef<'_>
) -> Result<(), Error>

Add literal PNG-data chunk unmodified to the unknown chunks

pub fn create_chunk<C: AsRef<[u8]>>(
    &mut self,
    position: ChunkPosition,
    chtype: C,
    data: &[u8]
) -> Result<(), Error>

Add custom chunk data to the file (if writing one)

pub fn get<NameBytes: AsRef<[u8]>>(
    &self,
    index: NameBytes
) -> Option<ChunkRef<'_>>

Uses linear search to find a given chunk. You can use b"PLTE" syntax.

pub fn unknown_chunks(&self, position: ChunkPosition) -> ChunksIterFragile<'_>

👎 Deprecated:

use try_unknown_chunks

pub fn try_unknown_chunks(&self, position: ChunkPosition) -> ChunksIter<'_>

Iterate over chunks that aren’t part of image data. Only available if remember_unknown_chunks was set.

Trait Implementations

impl Clone for Info

fn clone(&self) -> Info

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Info

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

Formats the value using the given formatter.

impl Default for Info

fn default() -> Self

Returns the “default value” for a type.