Struct image::flat::ViewMut

pub struct ViewMut<Buffer, P: Pixel> where
    Buffer: AsMut<[P::Subpixel]>,  { /* fields omitted */ }

A mutable owning version of a flat buffer.

While this wraps a buffer similar to ImageBuffer, this is mostly intended as a utility. The library endorsed normalized representation is still ImageBuffer. Also, the implementation of AsMut<[P::Subpixel]> must always yield the same buffer. Therefore there is no public way to construct this with an owning buffer.

Inner invariants

• For all indices inside bounds, the corresponding index is valid in the buffer
• There is no aliasing of samples
• The samples are packed, i.e. self.inner.layout.sample_stride == 1
• P::channel_count() agrees with self.inner.layout.channels

Implementations

impl<Buffer, P: Pixel> ViewMut<Buffer, P> where
    Buffer: AsMut<[P::Subpixel]>, 

pub fn into_inner(self) -> FlatSamples<Buffer>

Take out the sample buffer.

Gives up the normalization invariants on the buffer format.

pub fn flat(&self) -> &FlatSamples<Buffer>

Get a reference on the sample buffer descriptor.

There is no mutable counterpart as modifying the buffer format, including strides and lengths, could invalidate the accessibility invariants of the View. It is not specified if the inner buffer is the same as the buffer of the image from which this view was created. It might have been truncated as an optimization.

pub fn samples(&self) -> &Buffer

Get a reference on the inner buffer.

There is no mutable counter part since it is not intended to allow you to reassign the buffer or otherwise change its size or properties. However, its contents can be accessed mutable through a slice with image_mut_slice.

pub fn min_length(&self) -> usize

Get the minimum length of a buffer such that all in-bounds samples have valid indices.

See FlatSamples::min_length. This method will always succeed.

pub fn get_sample(&self, channel: u8, x: u32, y: u32) -> Option<&P::Subpixel> where
    Buffer: AsRef<[P::Subpixel]>, 

Get a reference to a selected subpixel.

This method will return None when the sample is out-of-bounds. All errors that could occur due to overflow have been eliminated while construction the View.

pub fn get_mut_sample(
    &mut self,
    channel: u8,
    x: u32,
    y: u32
) -> Option<&mut P::Subpixel>

Get a mutable reference to a selected sample.

This method will return None when the sample is out-of-bounds. All errors that could occur due to overflow have been eliminated while construction the View.

pub fn image_slice(&self) -> &[P::Subpixel] where
    Buffer: AsRef<[P::Subpixel]>, 

Return the portion of the buffer that holds sample values.

While this can not fail–the validity of all coordinates has been validated during the conversion from FlatSamples–the resulting slice may still contain holes.

pub fn image_mut_slice(&mut self) -> &mut [P::Subpixel]

Return the mutable buffer that holds sample values.

pub fn shrink_to(&mut self, width: u32, height: u32)

Shrink the inner image.

The new dimensions will be the minimum of the previous dimensions. Since the set of in-bounds pixels afterwards is a subset of the current ones, this is allowed on a View. Note that you can not change the number of channels as an intrinsic property of P.

Trait Implementations

impl<Buffer: Clone, P: Clone + Pixel> Clone for ViewMut<Buffer, P> where
    Buffer: AsMut<[P::Subpixel]>, 

fn clone(&self) -> ViewMut<Buffer, P>

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<Buffer: Debug, P: Debug + Pixel> Debug for ViewMut<Buffer, P> where
    Buffer: AsMut<[P::Subpixel]>, 

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

Formats the value using the given formatter.

impl<Buffer, P: Pixel> GenericImage for ViewMut<Buffer, P> where
    Buffer: AsMut<[P::Subpixel]> + AsRef<[P::Subpixel]>, 

type InnerImage = Self

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). Indexed from top left.

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

Put a pixel at location (x, y). Indexed from top left.

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

Put a pixel at location (x, y), taking into account alpha channels

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

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). Indexed from top left.

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

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

fn copy_within(&mut self, source: Rect, x: u32, y: u32) -> bool

Copies all of the pixels from one part of this image to another part of this image.

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

Returns a mutable subimage that is a view into this image. If you want an immutable subimage instead, use GenericImageView::view The coordinates set the position of the top left corner of the SubImage.

impl<Buffer, P: Pixel> GenericImageView for ViewMut<Buffer, P> where
    Buffer: AsMut<[P::Subpixel]> + AsRef<[P::Subpixel]>, 

type Pixel = P

The type of pixel.

type InnerImageView = Self

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 in_bounds(&self, x: u32, y: u32) -> bool

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

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

Returns the pixel located at (x, y). Indexed from top left.

fn inner(&self) -> &Self

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.

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

Returns the pixel located at (x, y). Indexed from top left.

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

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