Struct png::Adam7Info

pub struct Adam7Info {
    pub(crate) pass: u8,
    pub(crate) line: u32,
    pub(crate) width: u32,
}

Describes which stage of the Adam7 algorithm applies to a decoded row.

See also Reader.next_interlaced_row.

Fields

pass: u8

line: u32

width: u32

Implementations

impl Adam7Info

pub fn new(pass: u8, line: u32, width: u32) -> Self

Creates a new Adam7Info. May panic if the arguments are out of range (e.g. if pass is 0 or greater than 8).

• pass corresponds to a pass of the the Adam7 algorithm
• line is the number of a line within a pass (starting with 0). For example, in an image of height 8, line can be beteween 0..4 in the 7th pass (those 4 interlaced rows correspond to 2nd, 4th, 6th, and 8th row of the full image).
• width describes how many pixels are in an interlaced row. For example, in the 7th pass, the width is be the same as full image width, but in in the 1st pass, the width is be 1/8th of the image width (rounded up as necessary).

Note that in typical usage, Adam7Infos are returned by [Reader.next_interlaced_row] and there is no need to create them by calling Adam7Info::new. Adam7Info::new is nevertheless exposed as a public API, because it helps to provide self-contained example usage of expand_interlaced_row.

Trait Implementations

impl Clone for Adam7Info

fn clone(&self) -> Adam7Info

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Adam7Info

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

Formats the value using the given formatter.

impl PartialEq for Adam7Info

fn eq(&self, other: &Adam7Info) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for Adam7Info

impl Eq for Adam7Info

impl StructuralPartialEq for Adam7Info