Struct image::SubImage

pub struct SubImage<'a, I: 'a> { /* fields omitted */ }

A View into another image

Methods

impl<'a, I: GenericImage + 'static> SubImage<'a, I> where
    I::Pixel: 'static,
    <I::Pixel as Pixel>::Subpixel: 'static, 

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

Construct a new subimage

pub fn inner_mut(&mut self) -> &mut I

Returns a mutable reference to the wrapped image.

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::Pixel, Vec<<I::Pixel as Pixel>::Subpixel>>

Convert this subimage to an ImageBuffer

Trait Implementations

impl<'a, I: GenericImage + 'static> GenericImage for SubImage<'a, I> where
    I::Pixel: 'static,
    <I::Pixel as Pixel>::Subpixel: 'static, 

type Pixel = I::Pixel

The type of pixel.

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) -> I::Pixel

Returns the pixel located at (x, y)

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

Put a pixel at location (x, y)

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

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

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

Puts a pixel at location (x, y)

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)

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

Puts a pixel at location (x, y)

Important traits for Pixels<'a, I>

impl<'a, I: GenericImage> 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

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>

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: GenericImage<Pixel = Self::Pixel>, 

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

fn sub_image(
    &mut self,
    x: u32,
    y: u32,
    width: u32,
    height: u32
) -> SubImage<Self> where
    Self: 'static,
    <Self::Pixel as Pixel>::Subpixel: 'static,
    Self::Pixel: 'static, 

Returns a subimage that is a view into this image.