pub struct ViewMut<Buffer, P: Pixel>{ /* private fields */ }
Expand description
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 withself.inner.layout.channels
Implementations§
source§impl<Buffer, P: Pixel> ViewMut<Buffer, P>
impl<Buffer, P: Pixel> ViewMut<Buffer, P>
sourcepub fn into_inner(self) -> FlatSamples<Buffer>
pub fn into_inner(self) -> FlatSamples<Buffer>
Take out the sample buffer.
Gives up the normalization invariants on the buffer format.
sourcepub fn flat(&self) -> &FlatSamples<Buffer>
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.
sourcepub fn samples(&self) -> &Buffer
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
.
sourcepub fn min_length(&self) -> usize
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.
sourcepub fn get_sample(&self, channel: u8, x: u32, y: u32) -> Option<&P::Subpixel>
pub fn get_sample(&self, channel: u8, x: u32, y: u32) -> Option<&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
.
sourcepub fn get_mut_sample(
&mut self,
channel: u8,
x: u32,
y: u32
) -> Option<&mut P::Subpixel>
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
.
sourcepub fn image_slice(&self) -> &[P::Subpixel]
pub fn image_slice(&self) -> &[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.
sourcepub fn image_mut_slice(&mut self) -> &mut [P::Subpixel]
pub fn image_mut_slice(&mut self) -> &mut [P::Subpixel]
Return the mutable buffer that holds sample values.
sourcepub fn shrink_to(&mut self, width: u32, height: u32)
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§
source§impl<Buffer, P: Pixel> GenericImage for ViewMut<Buffer, P>
impl<Buffer, P: Pixel> GenericImage for ViewMut<Buffer, P>
source§fn get_pixel_mut(&mut self, x: u32, y: u32) -> &mut Self::Pixel
fn get_pixel_mut(&mut self, x: u32, y: u32) -> &mut Self::Pixel
get_pixel
and put_pixel
instead.(x, y)
. Indexed from top left. Read moresource§fn put_pixel(&mut self, x: u32, y: u32, pixel: Self::Pixel)
fn put_pixel(&mut self, x: u32, y: u32, pixel: Self::Pixel)
source§fn blend_pixel(&mut self, x: u32, y: u32, pixel: Self::Pixel)
fn blend_pixel(&mut self, x: u32, y: u32, pixel: Self::Pixel)
pixels_mut
to blend the pixels directlysource§unsafe fn unsafe_put_pixel(&mut self, x: u32, y: u32, pixel: Self::Pixel)
unsafe fn unsafe_put_pixel(&mut self, x: u32, y: u32, pixel: Self::Pixel)
source§fn copy_from<O>(&mut self, other: &O, x: u32, y: u32) -> ImageResult<()>where
O: GenericImageView<Pixel = Self::Pixel>,
fn copy_from<O>(&mut self, other: &O, x: u32, y: u32) -> ImageResult<()>where
O: GenericImageView<Pixel = Self::Pixel>,
source§fn copy_within(&mut self, source: Rect, x: u32, y: u32) -> bool
fn copy_within(&mut self, source: Rect, x: u32, y: u32) -> bool
source§fn sub_image(
&mut self,
x: u32,
y: u32,
width: u32,
height: u32
) -> SubImage<&mut Self>where
Self: Sized,
fn sub_image(
&mut self,
x: u32,
y: u32,
width: u32,
height: u32
) -> SubImage<&mut Self>where
Self: Sized,
GenericImageView::view
The coordinates set the position of the top left corner of the SubImage
.source§impl<Buffer, P: Pixel> GenericImageView for ViewMut<Buffer, P>
impl<Buffer, P: Pixel> GenericImageView for ViewMut<Buffer, P>
source§fn dimensions(&self) -> (u32, u32)
fn dimensions(&self) -> (u32, u32)
source§fn get_pixel(&self, x: u32, y: u32) -> Self::Pixel
fn get_pixel(&self, x: u32, y: u32) -> Self::Pixel
source§fn in_bounds(&self, x: u32, y: u32) -> bool
fn in_bounds(&self, x: u32, y: u32) -> bool
source§unsafe fn unsafe_get_pixel(&self, x: u32, y: u32) -> Self::Pixel
unsafe fn unsafe_get_pixel(&self, x: u32, y: u32) -> Self::Pixel
source§fn pixels(&self) -> Pixels<'_, Self> ⓘwhere
Self: Sized,
fn pixels(&self) -> Pixels<'_, Self> ⓘwhere
Self: Sized,
source§fn 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,
GenericImage::sub_image
if you need a mutable view instead.
The coordinates set the position of the top left corner of the view.