[][src]Struct image::SubImage

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

A View into another image

Methods

impl<I> SubImage<I>[src]

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

Construct a new subimage

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

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, 
[src]

Convert this subimage to an ImageBuffer

Trait Implementations

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

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. Read more

fn width(&self) -> u32[src]

The width of this image.

fn height(&self) -> u32[src]

The height of this image.

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

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

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

Returns the pixel located at (x, y) Read more

Important traits for Pixels<'a, I>
fn pixels(&self) -> Pixels<Self>[src]

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

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

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. Read more

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

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

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

Puts a pixel at location (x, y) Read more

Important traits for MutPixels<'a, I>
fn pixels_mut(&mut self) -> MutPixels<Self>[src]

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. Read more

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

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

Auto Trait Implementations

impl<I> Unpin for SubImage<I> where
    I: Unpin

impl<I> Sync for SubImage<I> where
    I: Sync

impl<I> Send for SubImage<I> where
    I: Send

impl<I> UnwindSafe for SubImage<I> where
    I: UnwindSafe

impl<I> RefUnwindSafe for SubImage<I> where
    I: RefUnwindSafe

Blanket Implementations

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> SetParameter for T[src]

fn set<T>(&mut self, value: T) -> <T as Parameter<Self>>::Result where
    T: Parameter<Self>, 
[src]

Sets value as a parameter of self.