Struct plot_interface::dependency::image::flat::ViewMut
[−]pub struct ViewMut<Buffer, P> where
P: Pixel,
Buffer: AsMut<[<P as Pixel>::Subpixel]>, { /* 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
impl<Buffer, P> ViewMut<Buffer, P> where
P: Pixel,
Buffer: AsMut<[<P as Pixel>::Subpixel]>,
impl<Buffer, P> ViewMut<Buffer, P> where
P: Pixel,
Buffer: AsMut<[<P as Pixel>::Subpixel]>,
pub 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.
pub 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.
pub 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
.
pub 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.
pub fn get_sample(
&self,
channel: u8,
x: u32,
y: u32
) -> Option<&<P as Pixel>::Subpixel> where
Buffer: AsRef<[<P as Pixel>::Subpixel]>,
pub fn get_sample(
&self,
channel: u8,
x: u32,
y: u32
) -> Option<&<P as Pixel>::Subpixel> where
Buffer: AsRef<[<P as Pixel>::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 as Pixel>::Subpixel>
pub fn get_mut_sample(
&mut self,
channel: u8,
x: u32,
y: u32
) -> Option<&mut <P as Pixel>::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 as Pixel>::Subpixel] where
Buffer: AsRef<[<P as Pixel>::Subpixel]>,
pub fn image_slice(&self) -> &[<P as Pixel>::Subpixel] where
Buffer: AsRef<[<P as Pixel>::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 as Pixel>::Subpixel]
pub fn image_mut_slice(&mut self) -> &mut [<P as Pixel>::Subpixel]
Return the mutable buffer that holds sample values.
pub 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
impl<Buffer, P> Clone for ViewMut<Buffer, P> where
Buffer: Clone + AsMut<[<P as Pixel>::Subpixel]>,
P: Clone + Pixel,
impl<Buffer, P> Clone for ViewMut<Buffer, P> where
Buffer: Clone + AsMut<[<P as Pixel>::Subpixel]>,
P: Clone + Pixel,
impl<Buffer, P> Debug for ViewMut<Buffer, P> where
Buffer: Debug + AsMut<[<P as Pixel>::Subpixel]>,
P: Debug + Pixel,
impl<Buffer, P> Debug for ViewMut<Buffer, P> where
Buffer: Debug + AsMut<[<P as Pixel>::Subpixel]>,
P: Debug + Pixel,
impl<Buffer, P> GenericImage for ViewMut<Buffer, P> where
P: Pixel,
Buffer: AsMut<[<P as Pixel>::Subpixel]> + AsRef<[<P as Pixel>::Subpixel]>,
impl<Buffer, P> GenericImage for ViewMut<Buffer, P> where
P: Pixel,
Buffer: AsMut<[<P as Pixel>::Subpixel]> + AsRef<[<P as Pixel>::Subpixel]>,
fn get_pixel_mut(
&mut self,
x: u32,
y: u32
) -> &mut <ViewMut<Buffer, P> as GenericImageView>::Pixel
fn get_pixel_mut(
&mut self,
x: u32,
y: u32
) -> &mut <ViewMut<Buffer, P> as GenericImageView>::Pixel
Use get_pixel
and put_pixel
instead.
Gets a reference to the mutable pixel at location (x, y)
. Indexed from top left. Read more
fn put_pixel(
&mut self,
x: u32,
y: u32,
pixel: <ViewMut<Buffer, P> as GenericImageView>::Pixel
)
fn put_pixel(
&mut self,
x: u32,
y: u32,
pixel: <ViewMut<Buffer, P> as GenericImageView>::Pixel
)
Put a pixel at location (x, y). Indexed from top left. Read more
fn blend_pixel(
&mut self,
x: u32,
y: u32,
pixel: <ViewMut<Buffer, P> as GenericImageView>::Pixel
)
fn blend_pixel(
&mut self,
x: u32,
y: u32,
pixel: <ViewMut<Buffer, P> as GenericImageView>::Pixel
)
Use iterator pixels_mut
to blend the pixels directly
Put a pixel at location (x, y), taking into account alpha channels
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)
Puts a pixel at location (x, y). Indexed from top left. Read more
fn copy_from<O>(&mut self, other: &O, x: u32, y: u32) -> Result<(), ImageError> where
O: GenericImageView<Pixel = Self::Pixel>,
fn copy_from<O>(&mut self, other: &O, x: u32, y: u32) -> Result<(), ImageError> where
O: GenericImageView<Pixel = Self::Pixel>,
Copies all of the pixels from another image into this image. Read more
impl<Buffer, P> GenericImageView for ViewMut<Buffer, P> where
P: Pixel,
Buffer: AsMut<[<P as Pixel>::Subpixel]> + AsRef<[<P as Pixel>::Subpixel]>,
impl<Buffer, P> GenericImageView for ViewMut<Buffer, P> where
P: Pixel,
Buffer: AsMut<[<P as Pixel>::Subpixel]> + AsRef<[<P as Pixel>::Subpixel]>,
type Pixel = P
type Pixel = P
The type of pixel.
fn dimensions(&self) -> (u32, u32)
fn dimensions(&self) -> (u32, u32)
The width and height of this image.
fn in_bounds(&self, x: u32, y: u32) -> bool
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
) -> <ViewMut<Buffer, P> as GenericImageView>::Pixel
fn get_pixel(
&self,
x: u32,
y: u32
) -> <ViewMut<Buffer, P> as GenericImageView>::Pixel
Returns the pixel located at (x, y). Indexed from top left. Read more
unsafe fn unsafe_get_pixel(&self, x: u32, y: u32) -> Self::Pixel
unsafe fn unsafe_get_pixel(&self, x: u32, y: u32) -> Self::Pixel
Returns the pixel located at (x, y). Indexed from top left. Read more
fn pixels(&self) -> Pixels<'_, Self>ⓘNotable traits for Pixels<'a, I>impl<'a, I> Iterator for Pixels<'a, I> where
I: GenericImageView, type Item = (u32, u32, <I as GenericImageView>::Pixel);
fn pixels(&self) -> Pixels<'_, Self>ⓘNotable traits for Pixels<'a, I>impl<'a, I> Iterator for Pixels<'a, I> where
I: GenericImageView, type Item = (u32, u32, <I as GenericImageView>::Pixel);
I: GenericImageView, type Item = (u32, u32, <I as GenericImageView>::Pixel);
Returns an Iterator over the pixels of this image. The iterator yields the coordinates of each pixel along with their value Read more
Auto Trait Implementations
impl<Buffer, P> RefUnwindSafe for ViewMut<Buffer, P> where
Buffer: RefUnwindSafe,
P: RefUnwindSafe,
impl<Buffer, P> Send for ViewMut<Buffer, P> where
Buffer: Send,
P: Send,
impl<Buffer, P> Sync for ViewMut<Buffer, P> where
Buffer: Sync,
P: Sync,
impl<Buffer, P> Unpin for ViewMut<Buffer, P> where
Buffer: Unpin,
P: Unpin,
impl<Buffer, P> UnwindSafe for ViewMut<Buffer, P> where
Buffer: UnwindSafe,
P: UnwindSafe,
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
impl<T> IntoResult<T> for T
impl<T> IntoResult<T> for T
type Err = Infallible
fn into_result(self) -> Result<T, <T as IntoResult<T>>::Err>
impl<T> Pointable for T
impl<T> Pointable for T
sourceimpl<Target, Original> VectorizedInto<Target> for Original where
Target: VectorizedFrom<Original>,
impl<Target, Original> VectorizedInto<Target> for Original where
Target: VectorizedFrom<Original>,
sourcefn vectorized_into(self) -> Target
fn vectorized_into(self) -> Target
Performs the conversion.