Struct image::SubImage

pub struct SubImage<I> { /* fields omitted */ }

A View into another image

Methods

impl<I> SubImage<I>

pub fn new(image: I, x: u32, y: u32, width: u32, height: u32) -> SubImage<I>

Construct a new subimage

pub fn change_bounds(&mut self, x: u32, y: u32, width: u32, height: u32)

Change the coordinates of this subimage.

pub fn to_image(
    &self
) -> ImageBuffer<<<I as Deref>::Target as GenericImageView>::Pixel, Vec<<<<I as Deref>::Target as GenericImageView>::Pixel as Pixel>::Subpixel>> where
    I: Deref,
    I::Target: GenericImage + 'static, 

Convert this subimage to an ImageBuffer

Trait Implementations

impl<I> GenericImageView for SubImage<I> where
    I: Deref,
    I::Target: GenericImageView + Sized, 

type Pixel = <<I as Deref>::Target as GenericImageView>::Pixel

The type of pixel.

type InnerImageView = I::Target

Underlying image type. This is mainly used by SubImages in order to always have a reference to the original image. This allows for less indirections and it eases the use of nested SubImages.

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

The width and height of this image.

fn bounds(&self) -> (u32, u32, u32, u32)

The bounding rectangle of this image.

fn get_pixel(&self, x: u32, y: u32) -> Self::Pixel

Returns the pixel located at (x, y)

fn view(
    &self,
    x: u32,
    y: u32,
    width: u32,
    height: u32
) -> SubImage<&Self::InnerImageView>

Returns an subimage that is an immutable view into this image.

fn inner(&self) -> &Self::InnerImageView

Returns a reference to the underlying image.

fn width(&self) -> u32

The width of this image.

fn height(&self) -> u32

The height of this image.

fn in_bounds(&self, x: u32, y: u32) -> bool

Returns true if this x, y coordinate is contained inside the image.

unsafe fn unsafe_get_pixel(&self, x: u32, y: u32) -> Self::Pixel

Returns the pixel located at (x, y)

Important traits for Pixels<'a, I>

impl<'a, I: GenericImageView> Iterator for Pixels<'a, I> type Item = (u32, u32, I::Pixel);

fn pixels(&self) -> Pixels<Self>

Returns an Iterator over the pixels of this image. The iterator yields the coordinates of each pixel along with their value

impl<I> GenericImage for SubImage<I> where
    I: DerefMut,
    I::Target: GenericImage + Sized, 

type InnerImage = I::Target

Underlying image type. This is mainly used by SubImages in order to always have a reference to the original image. This allows for less indirections and it eases the use of nested SubImages.

fn get_pixel_mut(&mut self, x: u32, y: u32) -> &mut Self::Pixel

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

fn put_pixel(&mut self, x: u32, y: u32, pixel: Self::Pixel)

Put a pixel at location (x, y)

fn blend_pixel(&mut self, x: u32, y: u32, pixel: Self::Pixel)

DEPRECATED: This method will be removed. Blend the pixel directly instead.

fn sub_image(
    &mut self,
    x: u32,
    y: u32,
    width: u32,
    height: u32
) -> SubImage<&mut Self::InnerImage>

Returns a subimage that is a view into this image.

fn inner_mut(&mut self) -> &mut Self::InnerImage

Returns a mutable reference to the underlying image.

unsafe fn unsafe_put_pixel(&mut self, x: u32, y: u32, pixel: Self::Pixel)

Puts a pixel at location (x, y)

Important traits for MutPixels<'a, I>

impl<'a, I: GenericImage + 'a> Iterator for MutPixels<'a, I> where
    I::Pixel: 'a,
    <I::Pixel as Pixel>::Subpixel: 'a,  type Item = (u32, u32, &'a mut I::Pixel);

fn pixels_mut(&mut self) -> MutPixels<Self>

Deprecated:

This cannot be implemented safely in Rust. Please use the image buffer directly.

Returns an Iterator over mutable pixels of this image. The iterator yields the coordinates of each pixel along with a mutable reference to them.

fn copy_from<O>(&mut self, other: &O, x: u32, y: u32) -> bool where
    O: GenericImageView<Pixel = Self::Pixel>, 

Copies all of the pixels from another image into this image.