Trait image::GenericImageView
source · pub trait GenericImageView {
type Pixel: Pixel;
// Required methods
fn dimensions(&self) -> (u32, u32);
fn bounds(&self) -> (u32, u32, u32, u32);
fn get_pixel(&self, x: u32, y: u32) -> Self::Pixel;
// Provided methods
fn width(&self) -> u32 { ... }
fn height(&self) -> u32 { ... }
fn in_bounds(&self, x: u32, y: u32) -> bool { ... }
unsafe fn unsafe_get_pixel(&self, x: u32, y: u32) -> Self::Pixel { ... }
fn pixels(&self) -> Pixels<'_, Self> ⓘ
where Self: Sized { ... }
fn view(&self, x: u32, y: u32, width: u32, height: u32) -> SubImage<&Self>
where Self: Sized { ... }
}Expand description
Trait to inspect an image.
use image::{GenericImageView, Rgb, RgbImage};
let buffer = RgbImage::new(10, 10);
let image: &dyn GenericImageView<Pixel=Rgb<u8>> = &buffer;Required Associated Types§
Required Methods§
sourcefn dimensions(&self) -> (u32, u32)
fn dimensions(&self) -> (u32, u32)
The width and height of this image.
Provided Methods§
sourcefn in_bounds(&self, x: u32, y: u32) -> bool
fn in_bounds(&self, x: u32, y: u32) -> bool
Returns true if this x, y coordinate is contained inside the image.
sourceunsafe fn unsafe_get_pixel(&self, x: u32, y: u32) -> Self::Pixel
unsafe fn unsafe_get_pixel(&self, x: u32, y: u32) -> Self::Pixel
sourcefn pixels(&self) -> Pixels<'_, Self> ⓘwhere
Self: Sized,
fn pixels(&self) -> Pixels<'_, Self> ⓘwhere
Self: Sized,
Returns an Iterator over the pixels of this image. The iterator yields the coordinates of each pixel along with their value
sourcefn view(&self, x: u32, y: u32, width: u32, height: u32) -> SubImage<&Self>where
Self: Sized,
fn view(&self, x: u32, y: u32, width: u32, height: u32) -> SubImage<&Self>where
Self: Sized,
Returns a subimage that is an immutable view into this image.
You can use GenericImage::sub_image if you need a mutable view instead.
The coordinates set the position of the top left corner of the view.