Trait Image

pub trait Image {
    type Pixel;

    // Required methods
    fn data(&self) -> &[Self::Pixel];
    fn shape(&self) -> Shape;

    // Provided methods
    fn size(&self) -> Size { ... }
    fn width(&self) -> usize { ... }
    fn height(&self) -> usize { ... }
    fn get(&self, row: usize, col: usize) -> Option<&Self::Pixel> { ... }
    fn view(
        &self,
        row_min: usize,
        row_max: usize,
        col_min: usize,
        col_max: usize,
    ) -> ImageRef<'_, Self::Pixel> { ... }
    fn as_ref(&self) -> ImageRef<'_, Self::Pixel> { ... }
    fn iter(&self) -> ImageIter<'_, Self::Pixel>  { ... }
    fn write(self, fmt: ImageWriteFormat, out: impl Write) -> Result<(), Error>
       where Self::Pixel: Color,
             Self: Sized { ... }
    fn write_rgba<W>(&self, out: W) -> Result<(), Error>
       where W: Write,
             Self::Pixel: Color,
             Self: Sized { ... }
    fn write_ppm<W>(&self, out: W) -> Result<(), Error>
       where W: Write,
             Self::Pixel: Color,
             Self: Sized { ... }
    fn write_bmp<W>(&self, out: W) -> Result<(), Error>
       where W: Write,
             Self::Pixel: Color,
             Self: Sized { ... }
}

Trait common to all image types

Required Associated Types

type Pixel

Pixel type

Required Methods

fn data(&self) -> &[Self::Pixel]

Data containing image

fn shape(&self) -> Shape

Shape of the image

Provided Methods

fn size(&self) -> Size

Image size

fn width(&self) -> usize

Image width

fn height(&self) -> usize

Image height

fn get(&self, row: usize, col: usize) -> Option<&Self::Pixel>

Get pixel at the specified row and column

fn view( &self, row_min: usize, row_max: usize, col_min: usize, col_max: usize, ) -> ImageRef<'_, Self::Pixel>

Create sub-image bounded by constraints, _max values are not inclusive.

fn as_ref(&self) -> ImageRef<'_, Self::Pixel>

Create immutable view to the image of the concrete type of ImageRef

fn iter(&self) -> ImageIter<'_, Self::Pixel>

Iterate over pixels

fn write(self, fmt: ImageWriteFormat, out: impl Write) -> Result<(), Error>

where Self::Pixel: Color, Self: Sized,

fn write_rgba<W>(&self, out: W) -> Result<(), Error>

where W: Write, Self::Pixel: Color, Self: Sized,

Write raw (height, width, RGBA…) data

fn write_ppm<W>(&self, out: W) -> Result<(), Error>

where W: Write, Self::Pixel: Color, Self: Sized,

Write image in PPM format

fn write_bmp<W>(&self, out: W) -> Result<(), Error>

where W: Write, Self::Pixel: Color, Self: Sized,

Write image in BMP format

Implementations on Foreign Types

impl<I> Image for &I

where I: Image + ?Sized,

type Pixel = <I as Image>::Pixel

fn shape(&self) -> Shape

fn data(&self) -> &[Self::Pixel]

impl<I> Image for &mut I

where I: Image + ?Sized,

type Pixel = <I as Image>::Pixel

fn shape(&self) -> Shape

fn data(&self) -> &[Self::Pixel]

impl<P> Image for Arc<dyn Image<Pixel = P>>

type Pixel = P

fn shape(&self) -> Shape

fn data(&self) -> &[Self::Pixel]

Implementors

impl<C> Image for Layer<C>

type Pixel = C

impl<P> Image for ImageMutRef<'_, P>

type Pixel = P

impl<P> Image for ImageOwned<P>

type Pixel = P

impl<P> Image for ImageRef<'_, P>

type Pixel = P