Struct awmpde::RgbImage

pub struct RgbImage(pub ImageBuffer<Rgb<u8>, Vec<u8>>);

Methods from Deref<Target = ImageBuffer<Rgb<u8>, Vec<u8>>>

pub fn as_raw(&self) -> &Container

Returns the underlying raw buffer

pub fn dimensions(&self) -> (u32, u32)

The width and height of this image.

pub fn width(&self) -> u32

The width of this image.

pub fn height(&self) -> u32

The height of this image.

pub fn pixels(&self) -> Pixels<'_, P>

Returns an iterator over the pixels of this image. The iteration order is x = 0 to width then y = 0 to height

pub fn rows(&self) -> Rows<'_, P>

Returns an iterator over the rows of this image.

Only non-empty rows can be iterated in this manner. In particular the iterator will not yield any item when the width of the image is 0 or a pixel type without any channels is used. This ensures that its length can always be represented by usize.

pub fn enumerate_pixels(&self) -> EnumeratePixels<'_, P>

Enumerates over the pixels of the image. The iterator yields the coordinates of each pixel along with a reference to them. The iteration order is x = 0 to width then y = 0 to height

pub fn enumerate_rows(&self) -> EnumerateRows<'_, P>

Enumerates over the rows of the image. The iterator yields the y-coordinate of each row along with a reference to them.

pub fn get_pixel(&self, x: u32, y: u32) -> &P

Gets a reference to the pixel at location (x, y)

Panics

Panics if (x, y) is out of the bounds (width, height).

pub fn sample_layout(&self) -> SampleLayout

Get the format of the buffer when viewed as a matrix of samples.

pub fn as_flat_samples(&self) -> FlatSamples<&[<P as Pixel>::Subpixel]> where
    Container: AsRef<[<P as Pixel>::Subpixel]>, 

Return a view on the raw sample buffer.

See into_flat_samples for more details.

pub fn as_flat_samples_mut(
    &mut self
) -> FlatSamples<&mut [<P as Pixel>::Subpixel]> where
    Container: AsMut<[<P as Pixel>::Subpixel]>, 

Return a mutable view on the raw sample buffer.

See into_flat_samples for more details.

pub fn pixels_mut(&mut self) -> PixelsMut<'_, P>

Returns an iterator over the mutable pixels of this image.

pub fn rows_mut(&mut self) -> RowsMut<'_, P>

Returns an iterator over the mutable rows of this image.

Only non-empty rows can be iterated in this manner. In particular the iterator will not yield any item when the width of the image is 0 or a pixel type without any channels is used. This ensures that its length can always be represented by usize.

pub fn enumerate_pixels_mut(&mut self) -> EnumeratePixelsMut<'_, P>

Enumerates over the pixels of the image. The iterator yields the coordinates of each pixel along with a mutable reference to them.

pub fn enumerate_rows_mut(&mut self) -> EnumerateRowsMut<'_, P>

Enumerates over the rows of the image. The iterator yields the y-coordinate of each row along with a mutable reference to them.

pub fn get_pixel_mut(&mut self, x: u32, y: u32) -> &mut P

Gets a reference to the mutable pixel at location (x, y)

Panics

Panics if (x, y) is out of the bounds (width, height).

pub fn put_pixel(&mut self, x: u32, y: u32, pixel: P)

Puts a pixel at location (x, y)

Panics

Panics if (x, y) is out of the bounds (width, height).

pub fn save<Q>(&self, path: Q) -> Result<(), ImageError> where
    Q: AsRef<Path>, 

Saves the buffer to a file at the path specified.

The image format is derived from the file extension. Currently only jpeg and png files are supported.

pub fn save_with_format<Q>(
    &self,
    path: Q,
    format: ImageFormat
) -> Result<(), ImageError> where
    Q: AsRef<Path>, 

Saves the buffer to a file at the specified path in the specified format.

See save_buffer_with_format for supported types.

Trait Implementations

impl Debug for RgbImage

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

Formats the value using the given formatter.

impl Deref for RgbImage

type Target = ImageBuffer<Rgb<u8>, Vec<u8>>

The resulting type after dereferencing.

pub fn deref(&self) -> &<RgbImage as Deref>::Target

Dereferences the value.

impl DerefMut for RgbImage

pub fn deref_mut(&mut self) -> &mut <RgbImage as Deref>::Target

Mutably dereferences the value.

impl FromField for RgbImage

type Error = Error

The associated error which can be returned.

type Future = Pin<Box<dyn Future<Output = Result<RgbImage, <RgbImage as FromField>::Error>> + 'static>>

Future that resolves to a Self

pub const MIME: Either<Mime, Name<'static>>

Mime that should be in field

pub fn from_field(field: Field) -> <RgbImage as FromField>::Future