Struct nannou::image::flat::ViewMut [−][src]
pub struct ViewMut<Buffer, P> where
P: Pixel,
Buffer: AsMut<[<P as Pixel>::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 withself.inner.layout.channels
Implementations
impl<Buffer, P> ViewMut<Buffer, P> where
P: Pixel,
Buffer: AsMut<[<P as Pixel>::Subpixel]>,
[src]
P: Pixel,
Buffer: AsMut<[<P as Pixel>::Subpixel]>,
pub fn into_inner(self) -> FlatSamples<Buffer>
[src]
Take out the sample buffer.
Gives up the normalization invariants on the buffer format.
pub fn flat(&self) -> &FlatSamples<Buffer>
[src]
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
[src]
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
[src]
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]>,
[src]
&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>
[src]
&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]>,
[src]
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]ⓘ
[src]
Return the mutable buffer that holds sample values.
pub fn shrink_to(&mut self, width: u32, height: u32)
[src]
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
P: Clone + Pixel,
Buffer: Clone + AsMut<[<P as Pixel>::Subpixel]>,
[src]
P: Clone + Pixel,
Buffer: Clone + AsMut<[<P as Pixel>::Subpixel]>,
impl<Buffer, P> Debug for ViewMut<Buffer, P> where
P: Debug + Pixel,
Buffer: Debug + AsMut<[<P as Pixel>::Subpixel]>,
[src]
P: Debug + Pixel,
Buffer: Debug + AsMut<[<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]>,
[src]
P: Pixel,
Buffer: AsMut<[<P as Pixel>::Subpixel]> + AsRef<[<P as Pixel>::Subpixel]>,
type InnerImage = ViewMut<Buffer, P>
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
pub fn get_pixel_mut(
&mut self,
x: u32,
y: u32
) -> &mut <ViewMut<Buffer, P> as GenericImageView>::Pixel
[src]
&mut self,
x: u32,
y: u32
) -> &mut <ViewMut<Buffer, P> as GenericImageView>::Pixel
pub fn put_pixel(
&mut self,
x: u32,
y: u32,
pixel: <ViewMut<Buffer, P> as GenericImageView>::Pixel
)
[src]
&mut self,
x: u32,
y: u32,
pixel: <ViewMut<Buffer, P> as GenericImageView>::Pixel
)
pub fn blend_pixel(
&mut self,
x: u32,
y: u32,
pixel: <ViewMut<Buffer, P> as GenericImageView>::Pixel
)
[src]
&mut self,
x: u32,
y: u32,
pixel: <ViewMut<Buffer, P> as GenericImageView>::Pixel
)
pub fn inner_mut(&mut self) -> &mut ViewMut<Buffer, P>
[src]
pub unsafe fn unsafe_put_pixel(&mut self, x: u32, y: u32, pixel: Self::Pixel)
[src]
pub fn copy_from<O>(
&mut self,
other: &O,
x: u32,
y: u32
) -> Result<(), ImageError> where
O: GenericImageView<Pixel = Self::Pixel>,
[src]
&mut self,
other: &O,
x: u32,
y: u32
) -> Result<(), ImageError> where
O: GenericImageView<Pixel = Self::Pixel>,
pub fn copy_within(&mut self, source: Rect, x: u32, y: u32) -> bool
[src]
pub fn sub_image(
&mut self,
x: u32,
y: u32,
width: u32,
height: u32
) -> SubImage<&mut Self::InnerImage>
[src]
&mut self,
x: u32,
y: u32,
width: u32,
height: u32
) -> SubImage<&mut Self::InnerImage>
impl<Buffer, P> GenericImageView for ViewMut<Buffer, P> where
P: Pixel,
Buffer: AsMut<[<P as Pixel>::Subpixel]> + AsRef<[<P as Pixel>::Subpixel]>,
[src]
P: Pixel,
Buffer: AsMut<[<P as Pixel>::Subpixel]> + AsRef<[<P as Pixel>::Subpixel]>,
type Pixel = P
The type of pixel.
type InnerImageView = ViewMut<Buffer, P>
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
pub fn dimensions(&self) -> (u32, u32)
[src]
pub fn bounds(&self) -> (u32, u32, u32, u32)
[src]
pub fn in_bounds(&self, x: u32, y: u32) -> bool
[src]
pub fn get_pixel(
&self,
x: u32,
y: u32
) -> <ViewMut<Buffer, P> as GenericImageView>::Pixel
[src]
&self,
x: u32,
y: u32
) -> <ViewMut<Buffer, P> as GenericImageView>::Pixel
pub fn inner(&self) -> &ViewMut<Buffer, P>
[src]
pub fn width(&self) -> u32
[src]
pub fn height(&self) -> u32
[src]
pub unsafe fn unsafe_get_pixel(&self, x: u32, y: u32) -> Self::Pixel
[src]
pub fn pixels(&self) -> Pixels<'_, Self>ⓘ
[src]
pub fn view(
&self,
x: u32,
y: u32,
width: u32,
height: u32
) -> SubImage<&Self::InnerImageView>
[src]
&self,
x: u32,
y: u32,
width: u32,
height: u32
) -> SubImage<&Self::InnerImageView>
Auto Trait Implementations
impl<Buffer, P> RefUnwindSafe for ViewMut<Buffer, P> where
Buffer: RefUnwindSafe,
P: RefUnwindSafe,
Buffer: RefUnwindSafe,
P: RefUnwindSafe,
impl<Buffer, P> Send for ViewMut<Buffer, P> where
Buffer: Send,
P: Send,
Buffer: Send,
P: Send,
impl<Buffer, P> Sync for ViewMut<Buffer, P> where
Buffer: Sync,
P: Sync,
Buffer: Sync,
P: Sync,
impl<Buffer, P> Unpin for ViewMut<Buffer, P> where
Buffer: Unpin,
P: Unpin,
Buffer: Unpin,
P: Unpin,
impl<Buffer, P> UnwindSafe for ViewMut<Buffer, P> where
Buffer: UnwindSafe,
P: UnwindSafe,
Buffer: UnwindSafe,
P: UnwindSafe,
Blanket Implementations
impl<S, D, Swp, Dwp, T> AdaptInto<D, Swp, Dwp, T> for S where
T: Component + Float,
D: AdaptFrom<S, Swp, Dwp, T>,
Swp: WhitePoint,
Dwp: WhitePoint,
[src]
T: Component + Float,
D: AdaptFrom<S, Swp, Dwp, T>,
Swp: WhitePoint,
Dwp: WhitePoint,
pub fn adapt_into_using<M>(self, method: M) -> D where
M: TransformMatrix<Swp, Dwp, T>,
[src]
M: TransformMatrix<Swp, Dwp, T>,
pub fn adapt_into(self) -> D
[src]
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T
[src]
impl<T, U> ConvertInto<U> for T where
U: ConvertFrom<T>,
[src]
U: ConvertFrom<T>,
pub fn convert_into(self) -> U
[src]
pub fn convert_unclamped_into(self) -> U
[src]
pub fn try_convert_into(self) -> Result<U, OutOfBounds<U>>
[src]
impl<T> Downcast<T> for T
impl<T> From<T> for T
[src]
impl<T> Instrument for T
[src]
pub fn instrument(self, span: Span) -> Instrumented<Self>
[src]
pub fn in_current_span(self) -> Instrumented<Self>
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> Pointable for T
pub const ALIGN: usize
type Init = T
The type for initializers.
pub unsafe fn init(init: <T as Pointable>::Init) -> usize
pub unsafe fn deref<'a>(ptr: usize) -> &'a T
pub unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T
pub unsafe fn drop(ptr: usize)
impl<T> SetParameter for T
pub fn set<T>(&mut self, value: T) -> <T as Parameter<Self>>::Result where
T: Parameter<Self>,
T: Parameter<Self>,
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn clone_into(&self, target: &mut T)
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<T> Upcast<T> for T
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
V: MultiLane<T>,