pub struct ViewMut<Buffer, P: Pixel> where
    Buffer: AsMut<[P::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 with self.inner.layout.channels

Implementations

Take out the sample buffer.

Gives up the normalization invariants on the buffer format.

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.

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.

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.

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.

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.

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.

Return the mutable buffer that holds sample values.

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

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

Formats the value using the given formatter. Read more

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

Gets a reference to the mutable pixel at location (x, y). Indexed from top left. Read more

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

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

Returns a mutable reference to the underlying image.

Puts a pixel at location (x, y). Indexed from top left. Read more

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

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

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

The type of pixel.

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

The width and height of this image.

The bounding rectangle of this image.

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

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

Returns a reference to the underlying image.

The width of this image.

The height of this image.

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

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

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

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Returns the argument unchanged.

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

The alignment of pointer.

The type for initializers.

Initializes a with the given initializer. Read more

Dereferences the given pointer. Read more

Mutably dereferences the given pointer. Read more

Drops the object pointed to by the given pointer. Read more

The resulting type after obtaining ownership.

Creates owned data from borrowed data, usually by cloning. Read more

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.