| <!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="A mutable owning version of a flat buffer."><meta name="keywords" content="rust, rustlang, rust-lang, ViewMut"><title>ViewMut in image::flat - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../../normalize.css"><link rel="stylesheet" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../ayu.css" disabled><link rel="stylesheet" href="../../dark.css" disabled><link rel="stylesheet" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc struct"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">☰</button><a class="sidebar-logo" href="../../image/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../image/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2 class="location"><a href="#">ViewMut</a></h2><div class="sidebar-elems"><section><h3><a href="#implementations">Methods</a></h3><ul class="block"><li><a href="#method.flat">flat</a></li><li><a href="#method.get_mut_sample">get_mut_sample</a></li><li><a href="#method.get_sample">get_sample</a></li><li><a href="#method.image_mut_slice">image_mut_slice</a></li><li><a href="#method.image_slice">image_slice</a></li><li><a href="#method.into_inner">into_inner</a></li><li><a href="#method.min_length">min_length</a></li><li><a href="#method.samples">samples</a></li><li><a href="#method.shrink_to">shrink_to</a></li></ul><h3><a href="#trait-implementations">Trait Implementations</a></h3><ul class="block"><li><a href="#impl-Clone-for-ViewMut%3CBuffer%2C%20P%3E">Clone</a></li><li><a href="#impl-Debug-for-ViewMut%3CBuffer%2C%20P%3E">Debug</a></li><li><a href="#impl-GenericImage-for-ViewMut%3CBuffer%2C%20P%3E">GenericImage</a></li><li><a href="#impl-GenericImageView-for-ViewMut%3CBuffer%2C%20P%3E">GenericImageView</a></li></ul><h3><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul class="block"><li><a href="#impl-RefUnwindSafe-for-ViewMut%3CBuffer%2C%20P%3E">RefUnwindSafe</a></li><li><a href="#impl-Send-for-ViewMut%3CBuffer%2C%20P%3E">Send</a></li><li><a href="#impl-Sync-for-ViewMut%3CBuffer%2C%20P%3E">Sync</a></li><li><a href="#impl-Unpin-for-ViewMut%3CBuffer%2C%20P%3E">Unpin</a></li><li><a href="#impl-UnwindSafe-for-ViewMut%3CBuffer%2C%20P%3E">UnwindSafe</a></li></ul><h3><a href="#blanket-implementations">Blanket Implementations</a></h3><ul class="block"><li><a href="#impl-Any-for-ViewMut%3CBuffer%2C%20P%3E">Any</a></li><li><a href="#impl-Borrow%3CT%3E-for-ViewMut%3CBuffer%2C%20P%3E">Borrow<T></a></li><li><a href="#impl-BorrowMut%3CT%3E-for-ViewMut%3CBuffer%2C%20P%3E">BorrowMut<T></a></li><li><a href="#impl-From%3CT%3E-for-ViewMut%3CBuffer%2C%20P%3E">From<T></a></li><li><a href="#impl-Into%3CU%3E-for-ViewMut%3CBuffer%2C%20P%3E">Into<U></a></li><li><a href="#impl-ToOwned-for-ViewMut%3CBuffer%2C%20P%3E">ToOwned</a></li><li><a href="#impl-TryFrom%3CU%3E-for-ViewMut%3CBuffer%2C%20P%3E">TryFrom<U></a></li><li><a href="#impl-TryInto%3CU%3E-for-ViewMut%3CBuffer%2C%20P%3E">TryInto<U></a></li></ul></section><h2><a href="index.html">In image::flat</a></h2></div></nav><main><div class="width-limiter"><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn">Struct <a href="../index.html">image</a>::<wbr><a href="index.html">flat</a>::<wbr><a class="struct" href="#">ViewMut</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../../clipboard.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="srclink" href="../../src/image/flat.rs.html#952-958">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><div class="item-decl"><pre class="rust struct"><code>pub struct ViewMut<Buffer, P: <a class="trait" href="../trait.Pixel.html" title="trait image::Pixel">Pixel</a>><span class="where fmt-newline">where<br> Buffer: AsMut<[P::<a class="associatedtype" href="../trait.Pixel.html#associatedtype.Subpixel" title="type image::Pixel::Subpixel">Subpixel</a>]>,</span>{ /* private fields */ }</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>A mutable owning version of a flat buffer.</p> |
| <p>While this wraps a buffer similar to <code>ImageBuffer</code>, this is mostly intended as a utility. The |
| library endorsed normalized representation is still <code>ImageBuffer</code>. Also, the implementation of |
| <code>AsMut<[P::Subpixel]></code> must always yield the same buffer. Therefore there is no public way to |
| construct this with an owning buffer.</p> |
| <h2 id="inner-invariants"><a href="#inner-invariants">Inner invariants</a></h2> |
| <ul> |
| <li>For all indices inside bounds, the corresponding index is valid in the buffer</li> |
| <li>There is no aliasing of samples</li> |
| <li>The samples are packed, i.e. <code>self.inner.layout.sample_stride == 1</code></li> |
| <li><code>P::channel_count()</code> agrees with <code>self.inner.layout.channels</code></li> |
| </ul> |
| </div></details><h2 id="implementations" class="small-section-header">Implementations<a href="#implementations" class="anchor"></a></h2><div id="implementations-list"><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-ViewMut%3CBuffer%2C%20P%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/image/flat.rs.html#1161-1251">source</a><a href="#impl-ViewMut%3CBuffer%2C%20P%3E" class="anchor"></a><h3 class="code-header">impl<Buffer, P: <a class="trait" href="../trait.Pixel.html" title="trait image::Pixel">Pixel</a>> <a class="struct" href="struct.ViewMut.html" title="struct image::flat::ViewMut">ViewMut</a><Buffer, P><span class="where fmt-newline">where<br> Buffer: AsMut<[P::<a class="associatedtype" href="../trait.Pixel.html#associatedtype.Subpixel" title="type image::Pixel::Subpixel">Subpixel</a>]>,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.into_inner" class="method has-srclink"><a class="srclink rightside" href="../../src/image/flat.rs.html#1168-1170">source</a><h4 class="code-header">pub fn <a href="#method.into_inner" class="fnname">into_inner</a>(self) -> <a class="struct" href="struct.FlatSamples.html" title="struct image::flat::FlatSamples">FlatSamples</a><Buffer></h4></section></summary><div class="docblock"><p>Take out the sample buffer.</p> |
| <p>Gives up the normalization invariants on the buffer format.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.flat" class="method has-srclink"><a class="srclink rightside" href="../../src/image/flat.rs.html#1178-1180">source</a><h4 class="code-header">pub fn <a href="#method.flat" class="fnname">flat</a>(&self) -> &<a class="struct" href="struct.FlatSamples.html" title="struct image::flat::FlatSamples">FlatSamples</a><Buffer></h4></section></summary><div class="docblock"><p>Get a reference on the sample buffer descriptor.</p> |
| <p>There is no mutable counterpart as modifying the buffer format, including strides and |
| lengths, could invalidate the accessibility invariants of the <code>View</code>. 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.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.samples" class="method has-srclink"><a class="srclink rightside" href="../../src/image/flat.rs.html#1187-1189">source</a><h4 class="code-header">pub fn <a href="#method.samples" class="fnname">samples</a>(&self) -> &Buffer</h4></section></summary><div class="docblock"><p>Get a reference on the inner buffer.</p> |
| <p>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 <code>image_mut_slice</code>.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.min_length" class="method has-srclink"><a class="srclink rightside" href="../../src/image/flat.rs.html#1194-1196">source</a><h4 class="code-header">pub fn <a href="#method.min_length" class="fnname">min_length</a>(&self) -> usize</h4></section></summary><div class="docblock"><p>Get the minimum length of a buffer such that all in-bounds samples have valid indices.</p> |
| <p>See <code>FlatSamples::min_length</code>. This method will always succeed.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.get_sample" class="method has-srclink"><a class="srclink rightside" href="../../src/image/flat.rs.html#1202-1212">source</a><h4 class="code-header">pub fn <a href="#method.get_sample" class="fnname">get_sample</a>(&self, channel: u8, x: u32, y: u32) -> Option<&P::<a class="associatedtype" href="../trait.Pixel.html#associatedtype.Subpixel" title="type image::Pixel::Subpixel">Subpixel</a>><span class="where fmt-newline">where<br> Buffer: AsRef<[P::<a class="associatedtype" href="../trait.Pixel.html#associatedtype.Subpixel" title="type image::Pixel::Subpixel">Subpixel</a>]>,</span></h4></section></summary><div class="docblock"><p>Get a reference to a selected subpixel.</p> |
| <p>This method will return <code>None</code> when the sample is out-of-bounds. All errors that could |
| occur due to overflow have been eliminated while construction the <code>View</code>.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.get_mut_sample" class="method has-srclink"><a class="srclink rightside" href="../../src/image/flat.rs.html#1218-1226">source</a><h4 class="code-header">pub fn <a href="#method.get_mut_sample" class="fnname">get_mut_sample</a>(<br> &mut self,<br> channel: u8,<br> x: u32,<br> y: u32<br>) -> Option<&mut P::<a class="associatedtype" href="../trait.Pixel.html#associatedtype.Subpixel" title="type image::Pixel::Subpixel">Subpixel</a>></h4></section></summary><div class="docblock"><p>Get a mutable reference to a selected sample.</p> |
| <p>This method will return <code>None</code> when the sample is out-of-bounds. All errors that could |
| occur due to overflow have been eliminated while construction the <code>View</code>.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.image_slice" class="method has-srclink"><a class="srclink rightside" href="../../src/image/flat.rs.html#1232-1234">source</a><h4 class="code-header">pub fn <a href="#method.image_slice" class="fnname">image_slice</a>(&self) -> &[P::<a class="associatedtype" href="../trait.Pixel.html#associatedtype.Subpixel" title="type image::Pixel::Subpixel">Subpixel</a>]<span class="where fmt-newline">where<br> Buffer: AsRef<[P::<a class="associatedtype" href="../trait.Pixel.html#associatedtype.Subpixel" title="type image::Pixel::Subpixel">Subpixel</a>]>,</span></h4></section></summary><div class="docblock"><p>Return the portion of the buffer that holds sample values.</p> |
| <p>While this can not fail–the validity of all coordinates has been validated during the |
| conversion from <code>FlatSamples</code>–the resulting slice may still contain holes.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.image_mut_slice" class="method has-srclink"><a class="srclink rightside" href="../../src/image/flat.rs.html#1237-1240">source</a><h4 class="code-header">pub fn <a href="#method.image_mut_slice" class="fnname">image_mut_slice</a>(&mut self) -> &mut [P::<a class="associatedtype" href="../trait.Pixel.html#associatedtype.Subpixel" title="type image::Pixel::Subpixel">Subpixel</a>]</h4></section></summary><div class="docblock"><p>Return the mutable buffer that holds sample values.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.shrink_to" class="method has-srclink"><a class="srclink rightside" href="../../src/image/flat.rs.html#1247-1250">source</a><h4 class="code-header">pub fn <a href="#method.shrink_to" class="fnname">shrink_to</a>(&mut self, width: u32, height: u32)</h4></section></summary><div class="docblock"><p>Shrink the inner image.</p> |
| <p>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 <code>View</code>. |
| Note that you can not change the number of channels as an intrinsic property of <code>P</code>.</p> |
| </div></details></div></details></div><h2 id="trait-implementations" class="small-section-header">Trait Implementations<a href="#trait-implementations" class="anchor"></a></h2><div id="trait-implementations-list"><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Clone-for-ViewMut%3CBuffer%2C%20P%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/image/flat.rs.html#951">source</a><a href="#impl-Clone-for-ViewMut%3CBuffer%2C%20P%3E" class="anchor"></a><h3 class="code-header">impl<Buffer: Clone, P: Clone + <a class="trait" href="../trait.Pixel.html" title="trait image::Pixel">Pixel</a>> Clone for <a class="struct" href="struct.ViewMut.html" title="struct image::flat::ViewMut">ViewMut</a><Buffer, P><span class="where fmt-newline">where<br> Buffer: AsMut<[P::<a class="associatedtype" href="../trait.Pixel.html#associatedtype.Subpixel" title="type image::Pixel::Subpixel">Subpixel</a>]>,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.clone" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/image/flat.rs.html#951">source</a><a href="#method.clone" class="anchor"></a><h4 class="code-header">fn <a class="fnname">clone</a>(&self) -> <a class="struct" href="struct.ViewMut.html" title="struct image::flat::ViewMut">ViewMut</a><Buffer, P></h4></section></summary><div class='docblock'>Returns a copy of the value. <a>Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.clone_from" class="method trait-impl has-srclink"><span class="since rightside" title="Stable since Rust version 1.0.0">1.0.0</span><a href="#method.clone_from" class="anchor"></a><h4 class="code-header">const fn <a class="fnname">clone_from</a>(&mut self, source: &Self)</h4></section></summary><div class='docblock'>Performs copy-assignment from <code>source</code>. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Debug-for-ViewMut%3CBuffer%2C%20P%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/image/flat.rs.html#951">source</a><a href="#impl-Debug-for-ViewMut%3CBuffer%2C%20P%3E" class="anchor"></a><h3 class="code-header">impl<Buffer: Debug, P: Debug + <a class="trait" href="../trait.Pixel.html" title="trait image::Pixel">Pixel</a>> Debug for <a class="struct" href="struct.ViewMut.html" title="struct image::flat::ViewMut">ViewMut</a><Buffer, P><span class="where fmt-newline">where<br> Buffer: AsMut<[P::<a class="associatedtype" href="../trait.Pixel.html#associatedtype.Subpixel" title="type image::Pixel::Subpixel">Subpixel</a>]>,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.fmt" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/image/flat.rs.html#951">source</a><a href="#method.fmt" class="anchor"></a><h4 class="code-header">fn <a class="fnname">fmt</a>(&self, f: &mut Formatter<'_>) -> Result</h4></section></summary><div class='docblock'>Formats the value using the given formatter. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-GenericImage-for-ViewMut%3CBuffer%2C%20P%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/image/flat.rs.html#1402-1429">source</a><a href="#impl-GenericImage-for-ViewMut%3CBuffer%2C%20P%3E" class="anchor"></a><h3 class="code-header">impl<Buffer, P: <a class="trait" href="../trait.Pixel.html" title="trait image::Pixel">Pixel</a>> <a class="trait" href="../trait.GenericImage.html" title="trait image::GenericImage">GenericImage</a> for <a class="struct" href="struct.ViewMut.html" title="struct image::flat::ViewMut">ViewMut</a><Buffer, P><span class="where fmt-newline">where<br> Buffer: AsMut<[P::<a class="associatedtype" href="../trait.Pixel.html#associatedtype.Subpixel" title="type image::Pixel::Subpixel">Subpixel</a>]> + AsRef<[P::<a class="associatedtype" href="../trait.Pixel.html#associatedtype.Subpixel" title="type image::Pixel::Subpixel">Subpixel</a>]>,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.InnerImage" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.InnerImage" class="anchor"></a><h4 class="code-header">type <a href="../trait.GenericImage.html#associatedtype.InnerImage" class="associatedtype">InnerImage</a> = <a class="struct" href="struct.ViewMut.html" title="struct image::flat::ViewMut">ViewMut</a><Buffer, P></h4></section></summary><div class='docblock'>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. <a href="../trait.GenericImage.html#associatedtype.InnerImage">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.get_pixel_mut" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/image/flat.rs.html#1407-1416">source</a><a href="#method.get_pixel_mut" class="anchor"></a><h4 class="code-header">fn <a href="../trait.GenericImage.html#tymethod.get_pixel_mut" class="fnname">get_pixel_mut</a>(&mut self, x: u32, y: u32) -> &mut Self::<a class="associatedtype" href="../trait.GenericImageView.html#associatedtype.Pixel" title="type image::GenericImageView::Pixel">Pixel</a></h4></section></summary><div class='docblock'>Gets a reference to the mutable pixel at location <code>(x, y)</code>. Indexed from top left. <a href="../trait.GenericImage.html#tymethod.get_pixel_mut">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.put_pixel" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/image/flat.rs.html#1418-1420">source</a><a href="#method.put_pixel" class="anchor"></a><h4 class="code-header">fn <a href="../trait.GenericImage.html#tymethod.put_pixel" class="fnname">put_pixel</a>(&mut self, x: u32, y: u32, pixel: Self::<a class="associatedtype" href="../trait.GenericImageView.html#associatedtype.Pixel" title="type image::GenericImageView::Pixel">Pixel</a>)</h4></section></summary><div class='docblock'>Put a pixel at location (x, y). Indexed from top left. <a href="../trait.GenericImage.html#tymethod.put_pixel">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.blend_pixel" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/image/flat.rs.html#1422-1424">source</a><a href="#method.blend_pixel" class="anchor"></a><h4 class="code-header">fn <a href="../trait.GenericImage.html#tymethod.blend_pixel" class="fnname">blend_pixel</a>(&mut self, x: u32, y: u32, pixel: Self::<a class="associatedtype" href="../trait.GenericImageView.html#associatedtype.Pixel" title="type image::GenericImageView::Pixel">Pixel</a>)</h4></section></summary><div class='docblock'>Put a pixel at location (x, y), taking into account alpha channels <a href="../trait.GenericImage.html#tymethod.blend_pixel">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.inner_mut" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/image/flat.rs.html#1426-1428">source</a><a href="#method.inner_mut" class="anchor"></a><h4 class="code-header">fn <a href="../trait.GenericImage.html#tymethod.inner_mut" class="fnname">inner_mut</a>(&mut self) -> &mut Self</h4></section></summary><div class='docblock'>Returns a mutable reference to the underlying image.</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.unsafe_put_pixel" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/image/image.rs.html#834-836">source</a><a href="#method.unsafe_put_pixel" class="anchor"></a><h4 class="code-header">unsafe fn <a href="../trait.GenericImage.html#method.unsafe_put_pixel" class="fnname">unsafe_put_pixel</a>(&mut self, x: u32, y: u32, pixel: Self::<a class="associatedtype" href="../trait.GenericImageView.html#associatedtype.Pixel" title="type image::GenericImageView::Pixel">Pixel</a>)</h4></section></summary><div class='docblock'>Puts a pixel at location (x, y). Indexed from top left. <a href="../trait.GenericImage.html#method.unsafe_put_pixel">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.copy_from" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/image/image.rs.html#858-877">source</a><a href="#method.copy_from" class="anchor"></a><h4 class="code-header">fn <a href="../trait.GenericImage.html#method.copy_from" class="fnname">copy_from</a><O>(&mut self, other: &O, x: u32, y: u32) -> <a class="type" href="../error/type.ImageResult.html" title="type image::error::ImageResult">ImageResult</a><()><span class="where fmt-newline">where<br> O: <a class="trait" href="../trait.GenericImageView.html" title="trait image::GenericImageView">GenericImageView</a><Pixel = Self::<a class="associatedtype" href="../trait.GenericImageView.html#associatedtype.Pixel" title="type image::GenericImageView::Pixel">Pixel</a>>,</span></h4></section></summary><div class='docblock'>Copies all of the pixels from another image into this image. <a href="../trait.GenericImage.html#method.copy_from">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.copy_within" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/image/image.rs.html#886-919">source</a><a href="#method.copy_within" class="anchor"></a><h4 class="code-header">fn <a href="../trait.GenericImage.html#method.copy_within" class="fnname">copy_within</a>(&mut self, source: <a class="struct" href="../math/struct.Rect.html" title="struct image::math::Rect">Rect</a>, x: u32, y: u32) -> bool</h4></section></summary><div class='docblock'>Copies all of the pixels from one part of this image to another part of this image. <a href="../trait.GenericImage.html#method.copy_within">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.sub_image" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/image/image.rs.html#927-935">source</a><a href="#method.sub_image" class="anchor"></a><h4 class="code-header">fn <a href="../trait.GenericImage.html#method.sub_image" class="fnname">sub_image</a>(<br> &mut self,<br> x: u32,<br> y: u32,<br> width: u32,<br> height: u32<br>) -> <a class="struct" href="../struct.SubImage.html" title="struct image::SubImage">SubImage</a><&mut Self::<a class="associatedtype" href="../trait.GenericImage.html#associatedtype.InnerImage" title="type image::GenericImage::InnerImage">InnerImage</a>></h4></section></summary><div class='docblock'>Returns a mutable subimage that is a view into this image. |
| If you want an immutable subimage instead, use <a href="../trait.GenericImageView.html#method.view" title="GenericImageView::view"><code>GenericImageView::view</code></a> |
| The coordinates set the position of the top left corner of the SubImage. <a href="../trait.GenericImage.html#method.sub_image">Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-GenericImageView-for-ViewMut%3CBuffer%2C%20P%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/image/flat.rs.html#1357-1400">source</a><a href="#impl-GenericImageView-for-ViewMut%3CBuffer%2C%20P%3E" class="anchor"></a><h3 class="code-header">impl<Buffer, P: <a class="trait" href="../trait.Pixel.html" title="trait image::Pixel">Pixel</a>> <a class="trait" href="../trait.GenericImageView.html" title="trait image::GenericImageView">GenericImageView</a> for <a class="struct" href="struct.ViewMut.html" title="struct image::flat::ViewMut">ViewMut</a><Buffer, P><span class="where fmt-newline">where<br> Buffer: AsMut<[P::<a class="associatedtype" href="../trait.Pixel.html#associatedtype.Subpixel" title="type image::Pixel::Subpixel">Subpixel</a>]> + AsRef<[P::<a class="associatedtype" href="../trait.Pixel.html#associatedtype.Subpixel" title="type image::Pixel::Subpixel">Subpixel</a>]>,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Pixel" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Pixel" class="anchor"></a><h4 class="code-header">type <a href="../trait.GenericImageView.html#associatedtype.Pixel" class="associatedtype">Pixel</a> = P</h4></section></summary><div class='docblock'>The type of pixel.</div></details><details class="rustdoc-toggle" open><summary><section id="associatedtype.InnerImageView" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.InnerImageView" class="anchor"></a><h4 class="code-header">type <a href="../trait.GenericImageView.html#associatedtype.InnerImageView" class="associatedtype">InnerImageView</a> = <a class="struct" href="struct.ViewMut.html" title="struct image::flat::ViewMut">ViewMut</a><Buffer, P></h4></section></summary><div class='docblock'>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. <a href="../trait.GenericImageView.html#associatedtype.InnerImageView">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.dimensions" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/image/flat.rs.html#1365-1367">source</a><a href="#method.dimensions" class="anchor"></a><h4 class="code-header">fn <a href="../trait.GenericImageView.html#tymethod.dimensions" class="fnname">dimensions</a>(&self) -> (u32, u32)</h4></section></summary><div class='docblock'>The width and height of this image.</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.bounds" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/image/flat.rs.html#1369-1372">source</a><a href="#method.bounds" class="anchor"></a><h4 class="code-header">fn <a href="../trait.GenericImageView.html#tymethod.bounds" class="fnname">bounds</a>(&self) -> (u32, u32, u32, u32)</h4></section></summary><div class='docblock'>The bounding rectangle of this image.</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.in_bounds" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/image/flat.rs.html#1374-1377">source</a><a href="#method.in_bounds" class="anchor"></a><h4 class="code-header">fn <a href="../trait.GenericImageView.html#method.in_bounds" class="fnname">in_bounds</a>(&self, x: u32, y: u32) -> bool</h4></section></summary><div class='docblock'>Returns true if this x, y coordinate is contained inside the image.</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.get_pixel" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/image/flat.rs.html#1379-1395">source</a><a href="#method.get_pixel" class="anchor"></a><h4 class="code-header">fn <a href="../trait.GenericImageView.html#tymethod.get_pixel" class="fnname">get_pixel</a>(&self, x: u32, y: u32) -> Self::<a class="associatedtype" href="../trait.GenericImageView.html#associatedtype.Pixel" title="type image::GenericImageView::Pixel">Pixel</a></h4></section></summary><div class='docblock'>Returns the pixel located at (x, y). Indexed from top left. <a href="../trait.GenericImageView.html#tymethod.get_pixel">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.inner" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/image/flat.rs.html#1397-1399">source</a><a href="#method.inner" class="anchor"></a><h4 class="code-header">fn <a href="../trait.GenericImageView.html#tymethod.inner" class="fnname">inner</a>(&self) -> &Self</h4></section></summary><div class='docblock'>Returns a reference to the underlying image.</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.width" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/image/image.rs.html#738-741">source</a><a href="#method.width" class="anchor"></a><h4 class="code-header">fn <a href="../trait.GenericImageView.html#method.width" class="fnname">width</a>(&self) -> u32</h4></section></summary><div class='docblock'>The width of this image.</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.height" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/image/image.rs.html#744-747">source</a><a href="#method.height" class="anchor"></a><h4 class="code-header">fn <a href="../trait.GenericImageView.html#method.height" class="fnname">height</a>(&self) -> u32</h4></section></summary><div class='docblock'>The height of this image.</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.unsafe_get_pixel" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/image/image.rs.html#775-777">source</a><a href="#method.unsafe_get_pixel" class="anchor"></a><h4 class="code-header">unsafe fn <a href="../trait.GenericImageView.html#method.unsafe_get_pixel" class="fnname">unsafe_get_pixel</a>(&self, x: u32, y: u32) -> Self::<a class="associatedtype" href="../trait.GenericImageView.html#associatedtype.Pixel" title="type image::GenericImageView::Pixel">Pixel</a></h4></section></summary><div class='docblock'>Returns the pixel located at (x, y). Indexed from top left. <a href="../trait.GenericImageView.html#method.unsafe_get_pixel">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.pixels" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/image/image.rs.html#782-792">source</a><a href="#method.pixels" class="anchor"></a><h4 class="code-header">fn <a href="../trait.GenericImageView.html#method.pixels" class="fnname">pixels</a>(&self) -> <a class="struct" href="../struct.Pixels.html" title="struct image::Pixels">Pixels</a><'_, Self><span class="notable-traits"><span class="notable-traits-tooltip">ⓘ<span class="notable-traits-tooltiptext"><span class="docblock"><span class="notable">Notable traits for <a class="struct" href="../struct.Pixels.html" title="struct image::Pixels">Pixels</a><'a, I></span><code class="content"><span class="where fmt-newline">impl<'a, I: <a class="trait" href="../trait.GenericImageView.html" title="trait image::GenericImageView">GenericImageView</a>> Iterator for <a class="struct" href="../struct.Pixels.html" title="struct image::Pixels">Pixels</a><'a, I></span><span class="where fmt-newline"> type <a class="associatedtype">Item</a> = (u32, u32, I::<a class="associatedtype" href="../trait.GenericImageView.html#associatedtype.Pixel" title="type image::GenericImageView::Pixel">Pixel</a>);</span></code></span></span></span></span></h4></section></summary><div class='docblock'>Returns an Iterator over the pixels of this image. |
| The iterator yields the coordinates of each pixel |
| along with their value <a href="../trait.GenericImageView.html#method.pixels">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.view" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/image/image.rs.html#800-802">source</a><a href="#method.view" class="anchor"></a><h4 class="code-header">fn <a href="../trait.GenericImageView.html#method.view" class="fnname">view</a>(<br> &self,<br> x: u32,<br> y: u32,<br> width: u32,<br> height: u32<br>) -> <a class="struct" href="../struct.SubImage.html" title="struct image::SubImage">SubImage</a><&Self::<a class="associatedtype" href="../trait.GenericImageView.html#associatedtype.InnerImageView" title="type image::GenericImageView::InnerImageView">InnerImageView</a>></h4></section></summary><div class='docblock'>Returns an subimage that is an immutable view into this image. |
| You can use <a href="../trait.GenericImage.html#method.sub_image" title="GenericImage::sub_image"><code>GenericImage::sub_image</code></a> if you need a mutable view instead. |
| The coordinates set the position of the top left corner of the view. <a href="../trait.GenericImageView.html#method.view">Read more</a></div></details></div></details></div><h2 id="synthetic-implementations" class="small-section-header">Auto Trait Implementations<a href="#synthetic-implementations" class="anchor"></a></h2><div id="synthetic-implementations-list"><section id="impl-RefUnwindSafe-for-ViewMut%3CBuffer%2C%20P%3E" class="impl has-srclink"><a href="#impl-RefUnwindSafe-for-ViewMut%3CBuffer%2C%20P%3E" class="anchor"></a><h3 class="code-header">impl<Buffer, P> RefUnwindSafe for <a class="struct" href="struct.ViewMut.html" title="struct image::flat::ViewMut">ViewMut</a><Buffer, P><span class="where fmt-newline">where<br> Buffer: RefUnwindSafe,<br> P: RefUnwindSafe,</span></h3></section><section id="impl-Send-for-ViewMut%3CBuffer%2C%20P%3E" class="impl has-srclink"><a href="#impl-Send-for-ViewMut%3CBuffer%2C%20P%3E" class="anchor"></a><h3 class="code-header">impl<Buffer, P> Send for <a class="struct" href="struct.ViewMut.html" title="struct image::flat::ViewMut">ViewMut</a><Buffer, P><span class="where fmt-newline">where<br> Buffer: Send,<br> P: Send,</span></h3></section><section id="impl-Sync-for-ViewMut%3CBuffer%2C%20P%3E" class="impl has-srclink"><a href="#impl-Sync-for-ViewMut%3CBuffer%2C%20P%3E" class="anchor"></a><h3 class="code-header">impl<Buffer, P> Sync for <a class="struct" href="struct.ViewMut.html" title="struct image::flat::ViewMut">ViewMut</a><Buffer, P><span class="where fmt-newline">where<br> Buffer: Sync,<br> P: Sync,</span></h3></section><section id="impl-Unpin-for-ViewMut%3CBuffer%2C%20P%3E" class="impl has-srclink"><a href="#impl-Unpin-for-ViewMut%3CBuffer%2C%20P%3E" class="anchor"></a><h3 class="code-header">impl<Buffer, P> Unpin for <a class="struct" href="struct.ViewMut.html" title="struct image::flat::ViewMut">ViewMut</a><Buffer, P><span class="where fmt-newline">where<br> Buffer: Unpin,<br> P: Unpin,</span></h3></section><section id="impl-UnwindSafe-for-ViewMut%3CBuffer%2C%20P%3E" class="impl has-srclink"><a href="#impl-UnwindSafe-for-ViewMut%3CBuffer%2C%20P%3E" class="anchor"></a><h3 class="code-header">impl<Buffer, P> UnwindSafe for <a class="struct" href="struct.ViewMut.html" title="struct image::flat::ViewMut">ViewMut</a><Buffer, P><span class="where fmt-newline">where<br> Buffer: UnwindSafe,<br> P: UnwindSafe,</span></h3></section></div><h2 id="blanket-implementations" class="small-section-header">Blanket Implementations<a href="#blanket-implementations" class="anchor"></a></h2><div id="blanket-implementations-list"><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Any-for-ViewMut%3CBuffer%2C%20P%3E" class="impl has-srclink"><a href="#impl-Any-for-ViewMut%3CBuffer%2C%20P%3E" class="anchor"></a><h3 class="code-header">impl<T> Any for T<span class="where fmt-newline">where<br> T: 'static + ?Sized,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.type_id" class="method trait-impl has-srclink"><a href="#method.type_id" class="anchor"></a><h4 class="code-header">fn <a class="fnname">type_id</a>(&self) -> TypeId</h4></section></summary><div class='docblock'>Gets the <code>TypeId</code> of <code>self</code>. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Borrow%3CT%3E-for-ViewMut%3CBuffer%2C%20P%3E" class="impl has-srclink"><a href="#impl-Borrow%3CT%3E-for-ViewMut%3CBuffer%2C%20P%3E" class="anchor"></a><h3 class="code-header">impl<T> Borrow<T> for T<span class="where fmt-newline">where<br> T: ?Sized,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.borrow" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/91522" title="Tracking issue for const_borrow">unstable</a></span><a href="#method.borrow" class="anchor"></a><h4 class="code-header">fn <a class="fnname">borrow</a>(&self) -> &T</h4></section></summary><div class='docblock'>Immutably borrows from an owned value. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-BorrowMut%3CT%3E-for-ViewMut%3CBuffer%2C%20P%3E" class="impl has-srclink"><a href="#impl-BorrowMut%3CT%3E-for-ViewMut%3CBuffer%2C%20P%3E" class="anchor"></a><h3 class="code-header">impl<T> BorrowMut<T> for T<span class="where fmt-newline">where<br> T: ?Sized,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.borrow_mut" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/91522" title="Tracking issue for const_borrow">unstable</a></span><a href="#method.borrow_mut" class="anchor"></a><h4 class="code-header">fn <a class="fnname">borrow_mut</a>(&mut self) -> &mut T</h4></section></summary><div class='docblock'>Mutably borrows from an owned value. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-From%3CT%3E-for-ViewMut%3CBuffer%2C%20P%3E" class="impl has-srclink"><a href="#impl-From%3CT%3E-for-ViewMut%3CBuffer%2C%20P%3E" class="anchor"></a><h3 class="code-header">impl<T> From<T> for T</h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.from" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span><a href="#method.from" class="anchor"></a><h4 class="code-header">fn <a class="fnname">from</a>(t: T) -> T</h4></section></summary><div class="docblock"><p>Returns the argument unchanged.</p> |
| </div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Into%3CU%3E-for-ViewMut%3CBuffer%2C%20P%3E" class="impl has-srclink"><a href="#impl-Into%3CU%3E-for-ViewMut%3CBuffer%2C%20P%3E" class="anchor"></a><h3 class="code-header">impl<T, U> Into<U> for T<span class="where fmt-newline">where<br> U: From<T>,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.into" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span><a href="#method.into" class="anchor"></a><h4 class="code-header">fn <a class="fnname">into</a>(self) -> U</h4></section></summary><div class="docblock"><p>Calls <code>U::from(self)</code>.</p> |
| <p>That is, this conversion is whatever the implementation of |
| <code>[From]<T> for U</code> chooses to do.</p> |
| </div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-ToOwned-for-ViewMut%3CBuffer%2C%20P%3E" class="impl has-srclink"><a href="#impl-ToOwned-for-ViewMut%3CBuffer%2C%20P%3E" class="anchor"></a><h3 class="code-header">impl<T> ToOwned for T<span class="where fmt-newline">where<br> T: Clone,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Owned" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Owned" class="anchor"></a><h4 class="code-header">type <a class="associatedtype">Owned</a> = T</h4></section></summary><div class='docblock'>The resulting type after obtaining ownership.</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.to_owned" class="method trait-impl has-srclink"><a href="#method.to_owned" class="anchor"></a><h4 class="code-header">fn <a class="fnname">to_owned</a>(&self) -> T</h4></section></summary><div class='docblock'>Creates owned data from borrowed data, usually by cloning. <a>Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.clone_into" class="method trait-impl has-srclink"><a href="#method.clone_into" class="anchor"></a><h4 class="code-header">fn <a class="fnname">clone_into</a>(&self, target: &mut T)</h4></section></summary><div class='docblock'>Uses borrowed data to replace owned data, usually by cloning. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-TryFrom%3CU%3E-for-ViewMut%3CBuffer%2C%20P%3E" class="impl has-srclink"><a href="#impl-TryFrom%3CU%3E-for-ViewMut%3CBuffer%2C%20P%3E" class="anchor"></a><h3 class="code-header">impl<T, U> TryFrom<U> for T<span class="where fmt-newline">where<br> U: Into<T>,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Error-1" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Error-1" class="anchor"></a><h4 class="code-header">type <a class="associatedtype">Error</a> = Infallible</h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_from" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span><a href="#method.try_from" class="anchor"></a><h4 class="code-header">fn <a class="fnname">try_from</a>(value: U) -> Result<T, <T as TryFrom<U>>::Error></h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-TryInto%3CU%3E-for-ViewMut%3CBuffer%2C%20P%3E" class="impl has-srclink"><a href="#impl-TryInto%3CU%3E-for-ViewMut%3CBuffer%2C%20P%3E" class="anchor"></a><h3 class="code-header">impl<T, U> TryInto<U> for T<span class="where fmt-newline">where<br> U: TryFrom<T>,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Error" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Error" class="anchor"></a><h4 class="code-header">type <a class="associatedtype">Error</a> = <U as TryFrom<T>>::Error</h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_into" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span><a href="#method.try_into" class="anchor"></a><h4 class="code-header">fn <a class="fnname">try_into</a>(self) -> Result<U, <U as TryFrom<T>>::Error></h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details></div></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="image" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |