|
|
<!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="API documentation for the Rust `SubImage` struct in crate `image`."><meta name="keywords" content="rust, rustlang, rust-lang, SubImage"><title>image::SubImage - Rust</title><link rel="stylesheet" type="text/css" href="../normalize.css"><link rel="stylesheet" type="text/css" href="../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../dark.css"><link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle"><script src="../storage.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="shortcut icon" href="../favicon.ico"><style type="text/css">#crate-search{background-image:url("../down-arrow.svg");}</style></head><body class="rustdoc struct"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">☰</div><a href='../image/index.html'><div class='logo-container'><img src='../rust-logo.png' alt='logo'></div></a><p class='location'>Struct SubImage</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.change_bounds">change_bounds</a><a href="#method.new">new</a><a href="#method.to_image">to_image</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-GenericImage">GenericImage</a><a href="#impl-GenericImageView">GenericImageView</a></div><a class="sidebar-title" href="#synthetic-implementations">Auto Trait Implementations</a><div class="sidebar-links"><a href="#impl-RefUnwindSafe">RefUnwindSafe</a><a href="#impl-Send">Send</a><a href="#impl-Sync">Sync</a><a href="#impl-Unpin">Unpin</a><a href="#impl-UnwindSafe">UnwindSafe</a></div><a class="sidebar-title" href="#blanket-implementations">Blanket Implementations</a><div class="sidebar-links"><a href="#impl-Any">Any</a><a href="#impl-Borrow%3CT%3E">Borrow<T></a><a href="#impl-BorrowMut%3CT%3E">BorrowMut<T></a><a href="#impl-From%3CT%3E">From<T></a><a href="#impl-Into%3CU%3E">Into<U></a><a href="#impl-SetParameter">SetParameter</a><a href="#impl-TryFrom%3CU%3E">TryFrom<U></a><a href="#impl-TryInto%3CU%3E">TryInto<U></a></div></div><p class='location'><a href='index.html'>image</a></p><script>window.sidebarCurrent = {name: 'SubImage', ty: 'struct', relpath: ''};</script><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!"><img src="../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../theme.js"></script><nav class="sub"><form class="search-form js-only"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><a id="settings-menu" href="../settings.html"><img src="../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class='fqn'><span class='out-of-band'><span id='render-detail'><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class='inner'>−</span>]</a></span><a class='srclink' href='../src/image/image.rs.html#712-718' title='goto source code'>[src]</a></span><span class='in-band'>Struct <a href='index.html'>image</a>::<wbr><a class="struct" href=''>SubImage</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class='rust struct'>pub struct SubImage<I> { /* fields omitted */ }</pre></div><div class='docblock'><p>A View into another image</p>
|
|
|
</div><h2 id='methods' class='small-section-header'>Methods<a href='#methods' class='anchor'></a></h2><h3 id='impl' class='impl'><code class='in-band'>impl<I> <a class="struct" href="../image/struct.SubImage.html" title="struct image::SubImage">SubImage</a><I></code><a href='#impl' class='anchor'></a><a class='srclink' href='../src/image/image.rs.html#726-764' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.new' class="method"><code id='new.v'>pub fn <a href='#method.new' class='fnname'>new</a>(image: I, x: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>, y: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>, width: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>, height: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>) -> <a class="struct" href="../image/struct.SubImage.html" title="struct image::SubImage">SubImage</a><I></code><a class='srclink' href='../src/image/image.rs.html#728-736' title='goto source code'>[src]</a></h4><div class='docblock'><p>Construct a new subimage</p>
|
|
|
</div><h4 id='method.change_bounds' class="method"><code id='change_bounds.v'>pub fn <a href='#method.change_bounds' class='fnname'>change_bounds</a>(&mut self, x: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>, y: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>, width: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>, height: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>)</code><a class='srclink' href='../src/image/image.rs.html#739-744' title='goto source code'>[src]</a></h4><div class='docblock'><p>Change the coordinates of this subimage.</p>
|
|
|
</div><h4 id='method.to_image' class="method"><code id='to_image.v'>pub fn <a href='#method.to_image' class='fnname'>to_image</a>(<br> &self<br>) -> <a class="struct" href="../image/struct.ImageBuffer.html" title="struct image::ImageBuffer">ImageBuffer</a><<<I as <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/deref/trait.Deref.html" title="trait core::ops::deref::Deref">Deref</a>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/ops/deref/trait.Deref.html#associatedtype.Target" title="type core::ops::deref::Deref::Target">Target</a> as <a class="trait" href="../image/trait.GenericImageView.html" title="trait image::GenericImageView">GenericImageView</a>>::<a class="type" href="../image/trait.GenericImageView.html#associatedtype.Pixel" title="type image::GenericImageView::Pixel">Pixel</a>, <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<<<I as <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/deref/trait.Deref.html" title="trait core::ops::deref::Deref">Deref</a>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/ops/deref/trait.Deref.html#associatedtype.Target" title="type core::ops::deref::Deref::Target">Target</a> as <a class="trait" href="../image/trait.GenericImageView.html" title="trait image::GenericImageView">GenericImageView</a>>::<a class="type" href="../image/trait.GenericImageView.html#associatedtype.Pixel" title="type image::GenericImageView::Pixel">Pixel</a> as <a class="trait" href="../image/trait.Pixel.html" title="trait image::Pixel">Pixel</a>>::<a class="type" href="../image/trait.Pixel.html#associatedtype.Subpixel" title="type image::Pixel::Subpixel">Subpixel</a>>> <span class="where fmt-newline">where<br> I: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/deref/trait.Deref.html" title="trait core::ops::deref::Deref">Deref</a>,<br> I::<a class="type" href="https://doc.rust-lang.org/nightly/core/ops/deref/trait.Deref.html#associatedtype.Target" title="type core::ops::deref::Deref::Target">Target</a>: <a class="trait" href="../image/trait.GenericImage.html" title="trait image::GenericImage">GenericImage</a> + 'static, </span></code><a class='srclink' href='../src/image/image.rs.html#747-763' title='goto source code'>[src]</a></h4><div class='docblock'><p>Convert this subimage to an ImageBuffer</p>
|
|
|
</div></div><h2 id='implementations' class='small-section-header'>Trait Implementations<a href='#implementations' class='anchor'></a></h2><div id='implementations-list'><h3 id='impl-GenericImageView' class='impl'><code class='in-band'>impl<I> <a class="trait" href="../image/trait.GenericImageView.html" title="trait image::GenericImageView">GenericImageView</a> for <a class="struct" href="../image/struct.SubImage.html" title="struct image::SubImage">SubImage</a><I> <span class="where fmt-newline">where<br> I: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/deref/trait.Deref.html" title="trait core::ops::deref::Deref">Deref</a>,<br> I::<a class="type" href="https://doc.rust-lang.org/nightly/core/ops/deref/trait.Deref.html#associatedtype.Target" title="type core::ops::deref::Deref::Target">Target</a>: <a class="trait" href="../image/trait.GenericImageView.html" title="trait image::GenericImageView">GenericImageView</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href='#impl-GenericImageView' class='anchor'></a><a class='srclink' href='../src/image/image.rs.html#767-796' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Pixel' class="type"><code id='Pixel.t'>type <a href='../image/trait.GenericImageView.html#associatedtype.Pixel' class="type">Pixel</a> = <<I as <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/deref/trait.Deref.html" title="trait core::ops::deref::Deref">Deref</a>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/ops/deref/trait.Deref.html#associatedtype.Target" title="type core::ops::deref::Deref::Target">Target</a> as <a class="trait" href="../image/trait.GenericImageView.html" title="trait image::GenericImageView">GenericImageView</a>>::<a class="type" href="../image/trait.GenericImageView.html#associatedtype.Pixel" title="type image::GenericImageView::Pixel">Pixel</a></code></h4><div class='docblock'><p>The type of pixel.</p>
|
|
|
</div><h4 id='associatedtype.InnerImageView' class="type"><code id='InnerImageView.t'>type <a href='../image/trait.GenericImageView.html#associatedtype.InnerImageView' class="type">InnerImageView</a> = I::<a class="type" href="https://doc.rust-lang.org/nightly/core/ops/deref/trait.Deref.html#associatedtype.Target" title="type core::ops::deref::Deref::Target">Target</a></code></h4><div class='docblock'><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. <a href="../image/trait.GenericImageView.html#associatedtype.InnerImageView">Read more</a></p>
|
|
|
</div><h4 id='method.dimensions' class="method hidden"><code id='dimensions.v'>fn <a href='../image/trait.GenericImageView.html#tymethod.dimensions' class='fnname'>dimensions</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a></code><a class='srclink' href='../src/image/image.rs.html#775-777' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>The width and height of this image.</p>
|
|
|
</div><h4 id='method.bounds' class="method hidden"><code id='bounds.v'>fn <a href='../image/trait.GenericImageView.html#tymethod.bounds' class='fnname'>bounds</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a></code><a class='srclink' href='../src/image/image.rs.html#779-781' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>The bounding rectangle of this image.</p>
|
|
|
</div><h4 id='method.get_pixel' class="method hidden"><code id='get_pixel.v'>fn <a href='../image/trait.GenericImageView.html#tymethod.get_pixel' class='fnname'>get_pixel</a>(&self, x: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>, y: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>) -> Self::<a class="type" href="../image/trait.GenericImageView.html#associatedtype.Pixel" title="type image::GenericImageView::Pixel">Pixel</a></code><a class='srclink' href='../src/image/image.rs.html#783-785' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Returns the pixel located at (x, y) <a href="../image/trait.GenericImageView.html#tymethod.get_pixel">Read more</a></p>
|
|
|
</div><h4 id='method.view' class="method hidden"><code id='view.v'>fn <a href='../image/trait.GenericImageView.html#method.view' class='fnname'>view</a>(<br> &self, <br> x: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>, <br> y: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>, <br> width: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>, <br> height: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a><br>) -> <a class="struct" href="../image/struct.SubImage.html" title="struct image::SubImage">SubImage</a><&Self::<a class="type" href="../image/trait.GenericImageView.html#associatedtype.InnerImageView" title="type image::GenericImageView::InnerImageView">InnerImageView</a>></code><a class='srclink' href='../src/image/image.rs.html#787-791' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Returns an subimage that is an immutable view into this image.</p>
|
|
|
</div><h4 id='method.inner' class="method hidden"><code id='inner.v'>fn <a href='../image/trait.GenericImageView.html#tymethod.inner' class='fnname'>inner</a>(&self) -> &Self::<a class="type" href="../image/trait.GenericImageView.html#associatedtype.InnerImageView" title="type image::GenericImageView::InnerImageView">InnerImageView</a></code><a class='srclink' href='../src/image/image.rs.html#793-795' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Returns a reference to the underlying image.</p>
|
|
|
</div><h4 id='method.width' class="method hidden"><code id='width.v'>fn <a href='../image/trait.GenericImageView.html#method.width' class='fnname'>width</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a></code><a class='srclink' href='../src/image/image.rs.html#556-559' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>The width of this image.</p>
|
|
|
</div><h4 id='method.height' class="method hidden"><code id='height.v'>fn <a href='../image/trait.GenericImageView.html#method.height' class='fnname'>height</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a></code><a class='srclink' href='../src/image/image.rs.html#562-565' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>The height of this image.</p>
|
|
|
</div><h4 id='method.in_bounds' class="method hidden"><code id='in_bounds.v'>fn <a href='../image/trait.GenericImageView.html#method.in_bounds' class='fnname'>in_bounds</a>(&self, x: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>, y: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><a class='srclink' href='../src/image/image.rs.html#571-574' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Returns true if this x, y coordinate is contained inside the image.</p>
|
|
|
</div><h4 id='method.unsafe_get_pixel' class="method hidden"><code id='unsafe_get_pixel.v'>unsafe fn <a href='../image/trait.GenericImageView.html#method.unsafe_get_pixel' class='fnname'>unsafe_get_pixel</a>(&self, x: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>, y: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>) -> Self::<a class="type" href="../image/trait.GenericImageView.html#associatedtype.Pixel" title="type image::GenericImageView::Pixel">Pixel</a></code><a class='srclink' href='../src/image/image.rs.html#588-590' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Returns the pixel located at (x, y) <a href="../image/trait.GenericImageView.html#method.unsafe_get_pixel">Read more</a></p>
|
|
|
</div><h4 id='method.pixels' class="method hidden"><div class="important-traits"><div class='tooltip'>ⓘ<span class='tooltiptext'>Important traits for <a class="struct" href="../image/struct.Pixels.html" title="struct image::Pixels">Pixels</a><'a, I></span></div><div class="content hidden"><h3 class="important">Important traits for <a class="struct" href="../image/struct.Pixels.html" title="struct image::Pixels">Pixels</a><'a, I></h3><code class="content"><span class="where fmt-newline">impl<'a, I: <a class="trait" href="../image/trait.GenericImageView.html" title="trait image::GenericImageView">GenericImageView</a>> <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/iterator/trait.Iterator.html" title="trait core::iter::traits::iterator::Iterator">Iterator</a> for <a class="struct" href="../image/struct.Pixels.html" title="struct image::Pixels">Pixels</a><'a, I></span><span class="where fmt-newline"> type <a href='https://doc.rust-lang.org/nightly/core/iter/traits/iterator/trait.Iterator.html#associatedtype.Item' class="type">Item</a> = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>, I::<a class="type" href="../image/trait.GenericImageView.html#associatedtype.Pixel" title="type image::GenericImageView::Pixel">Pixel</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>;</span></code></div></div><code id='pixels.v'>fn <a href='../image/trait.GenericImageView.html#method.pixels' class='fnname'>pixels</a>(&self) -> <a class="struct" href="../image/struct.Pixels.html" title="struct image::Pixels">Pixels</a><Self></code><a class='srclink' href='../src/image/image.rs.html#595-605' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Returns an Iterator over the pixels of this image. The iterator yields the coordinates of each pixel along with their value <a href="../image/trait.GenericImageView.html#method.pixels">Read more</a></p>
|
|
|
</div></div><h3 id='impl-GenericImage' class='impl'><code class='in-band'>impl<I> <a class="trait" href="../image/trait.GenericImage.html" title="trait image::GenericImage">GenericImage</a> for <a class="struct" href="../image/struct.SubImage.html" title="struct image::SubImage">SubImage</a><I> <span class="where fmt-newline">where<br> I: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/deref/trait.DerefMut.html" title="trait core::ops::deref::DerefMut">DerefMut</a>,<br> I::<a class="type" href="https://doc.rust-lang.org/nightly/core/ops/deref/trait.Deref.html#associatedtype.Target" title="type core::ops::deref::Deref::Target">Target</a>: <a class="trait" href="../image/trait.GenericImage.html" title="trait image::GenericImage">GenericImage</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href='#impl-GenericImage' class='anchor'></a><a class='srclink' href='../src/image/image.rs.html#799-836' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.InnerImage' class="type"><code id='InnerImage.t'>type <a href='../image/trait.GenericImage.html#associatedtype.InnerImage' class="type">InnerImage</a> = I::<a class="type" href="https://doc.rust-lang.org/nightly/core/ops/deref/trait.Deref.html#associatedtype.Target" title="type core::ops::deref::Deref::Target">Target</a></code></h4><div class='docblock'><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. <a href="../image/trait.GenericImage.html#associatedtype.InnerImage">Read more</a></p>
|
|
|
</div><h4 id='method.get_pixel_mut' class="method hidden"><code id='get_pixel_mut.v'>fn <a href='../image/trait.GenericImage.html#tymethod.get_pixel_mut' class='fnname'>get_pixel_mut</a>(&mut self, x: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>, y: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>) -> &mut Self::<a class="type" href="../image/trait.GenericImageView.html#associatedtype.Pixel" title="type image::GenericImageView::Pixel">Pixel</a></code><a class='srclink' href='../src/image/image.rs.html#806-808' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Gets a reference to the mutable pixel at location <code>(x, y)</code> <a href="../image/trait.GenericImage.html#tymethod.get_pixel_mut">Read more</a></p>
|
|
|
</div><h4 id='method.put_pixel' class="method hidden"><code id='put_pixel.v'>fn <a href='../image/trait.GenericImage.html#tymethod.put_pixel' class='fnname'>put_pixel</a>(&mut self, x: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>, y: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>, pixel: Self::<a class="type" href="../image/trait.GenericImageView.html#associatedtype.Pixel" title="type image::GenericImageView::Pixel">Pixel</a>)</code><a class='srclink' href='../src/image/image.rs.html#810-813' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Put a pixel at location (x, y) <a href="../image/trait.GenericImage.html#tymethod.put_pixel">Read more</a></p>
|
|
|
</div><h4 id='method.blend_pixel' class="method"><code id='blend_pixel.v'>fn <a href='../image/trait.GenericImage.html#tymethod.blend_pixel' class='fnname'>blend_pixel</a>(&mut self, x: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>, y: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>, pixel: Self::<a class="type" href="../image/trait.GenericImageView.html#associatedtype.Pixel" title="type image::GenericImageView::Pixel">Pixel</a>)</code><a class='srclink' href='../src/image/image.rs.html#816-819' title='goto source code'>[src]</a></h4><div class='docblock'><p>DEPRECATED: This method will be removed. Blend the pixel directly instead.</p>
|
|
|
</div><h4 id='method.sub_image' class="method hidden"><code id='sub_image.v'>fn <a href='../image/trait.GenericImage.html#method.sub_image' class='fnname'>sub_image</a>(<br> &mut self, <br> x: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>, <br> y: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>, <br> width: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>, <br> height: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a><br>) -> <a class="struct" href="../image/struct.SubImage.html" title="struct image::SubImage">SubImage</a><&mut Self::<a class="type" href="../image/trait.GenericImage.html#associatedtype.InnerImage" title="type image::GenericImage::InnerImage">InnerImage</a>></code><a class='srclink' href='../src/image/image.rs.html#821-831' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Returns a subimage that is a view into this image.</p>
|
|
|
</div><h4 id='method.inner_mut' class="method hidden"><code id='inner_mut.v'>fn <a href='../image/trait.GenericImage.html#tymethod.inner_mut' class='fnname'>inner_mut</a>(&mut self) -> &mut Self::<a class="type" href="../image/trait.GenericImage.html#associatedtype.InnerImage" title="type image::GenericImage::InnerImage">InnerImage</a></code><a class='srclink' href='../src/image/image.rs.html#833-835' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Returns a mutable reference to the underlying image.</p>
|
|
|
</div><h4 id='method.unsafe_put_pixel' class="method hidden"><code id='unsafe_put_pixel.v'>unsafe fn <a href='../image/trait.GenericImage.html#method.unsafe_put_pixel' class='fnname'>unsafe_put_pixel</a>(&mut self, x: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>, y: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>, pixel: Self::<a class="type" href="../image/trait.GenericImageView.html#associatedtype.Pixel" title="type image::GenericImageView::Pixel">Pixel</a>)</code><a class='srclink' href='../src/image/image.rs.html#640-642' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Puts a pixel at location (x, y) <a href="../image/trait.GenericImage.html#method.unsafe_put_pixel">Read more</a></p>
|
|
|
</div><h4 id='method.pixels_mut' class="method hidden"><div class="important-traits"><div class='tooltip'>ⓘ<span class='tooltiptext'>Important traits for <a class="struct" href="../image/struct.MutPixels.html" title="struct image::MutPixels">MutPixels</a><'a, I></span></div><div class="content hidden"><h3 class="important">Important traits for <a class="struct" href="../image/struct.MutPixels.html" title="struct image::MutPixels">MutPixels</a><'a, I></h3><code class="content"><span class="where fmt-newline">impl<'a, I: <a class="trait" href="../image/trait.GenericImage.html" title="trait image::GenericImage">GenericImage</a> + 'a> <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/iterator/trait.Iterator.html" title="trait core::iter::traits::iterator::Iterator">Iterator</a> for <a class="struct" href="../image/struct.MutPixels.html" title="struct image::MutPixels">MutPixels</a><'a, I> <span class="where fmt-newline">where<br> I::<a class="type" href="../image/trait.GenericImageView.html#associatedtype.Pixel" title="type image::GenericImageView::Pixel">Pixel</a>: 'a,<br> <I::<a class="type" href="../image/trait.GenericImageView.html#associatedtype.Pixel" title="type image::GenericImageView::Pixel">Pixel</a> as <a class="trait" href="../image/trait.Pixel.html" title="trait image::Pixel">Pixel</a>>::<a class="type" href="../image/trait.Pixel.html#associatedtype.Subpixel" title="type image::Pixel::Subpixel">Subpixel</a>: 'a, </span></span><span class="where fmt-newline"> type <a href='https://doc.rust-lang.org/nightly/core/iter/traits/iterator/trait.Iterator.html#associatedtype.Item' class="type">Item</a> = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>, &'a mut I::<a class="type" href="../image/trait.GenericImageView.html#associatedtype.Pixel" title="type image::GenericImageView::Pixel">Pixel</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>;</span></code></div></div><code id='pixels_mut.v'>fn <a href='../image/trait.GenericImage.html#method.pixels_mut' class='fnname'>pixels_mut</a>(&mut self) -> <a class="struct" href="../image/struct.MutPixels.html" title="struct image::MutPixels">MutPixels</a><Self></code><a class='srclink' href='../src/image/image.rs.html#655-665' title='goto source code'>[src]</a></h4><div class='stability hidden'><div class='stab deprecated'>Deprecated: <p>This cannot be implemented safely in Rust. Please use the image buffer directly.</p>
|
|
|
</div></div><div class='docblock hidden'><p>Returns an Iterator over mutable pixels of this image. The iterator yields the coordinates of each pixel along with a mutable reference to them. <a href="../image/trait.GenericImage.html#method.pixels_mut">Read more</a></p>
|
|
|
</div><h4 id='method.copy_from' class="method hidden"><code id='copy_from.v'>fn <a href='../image/trait.GenericImage.html#method.copy_from' class='fnname'>copy_from</a><O>(&mut self, other: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>O, x: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>, y: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a> <span class="where fmt-newline">where<br> O: <a class="trait" href="../image/trait.GenericImageView.html" title="trait image::GenericImageView">GenericImageView</a><Pixel = Self::<a class="type" href="../image/trait.GenericImageView.html#associatedtype.Pixel" title="type image::GenericImageView::Pixel">Pixel</a>>, </span></code><a class='srclink' href='../src/image/image.rs.html#677-694' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Copies all of the pixels from another image into this image. <a href="../image/trait.GenericImage.html#method.copy_from">Read more</a></p>
|
|
|
</div></div></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'><h3 id='impl-Send' class='impl'><code class='in-band'>impl<I> <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="../image/struct.SubImage.html" title="struct image::SubImage">SubImage</a><I> <span class="where fmt-newline">where<br> I: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>, </span></code><a href='#impl-Send' class='anchor'></a></h3><div class='impl-items'></div><h3 id='impl-Unpin' class='impl'><code class='in-band'>impl<I> <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a> for <a class="struct" href="../image/struct.SubImage.html" title="struct image::SubImage">SubImage</a><I> <span class="where fmt-newline">where<br> I: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a>, </span></code><a href='#impl-Unpin' class='anchor'></a></h3><div class='impl-items'></div><h3 id='impl-Sync' class='impl'><code class='in-band'>impl<I> <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="../image/struct.SubImage.html" title="struct image::SubImage">SubImage</a><I> <span class="where fmt-newline">where<br> I: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a>, </span></code><a href='#impl-Sync' class='anchor'></a></h3><div class='impl-items'></div><h3 id='impl-UnwindSafe' class='impl'><code class='in-band'>impl<I> <a class="trait" href="https://doc.rust-lang.org/nightly/std/panic/trait.UnwindSafe.html" title="trait std::panic::UnwindSafe">UnwindSafe</a> for <a class="struct" href="../image/struct.SubImage.html" title="struct image::SubImage">SubImage</a><I> <span class="where fmt-newline">where<br> I: <a class="trait" href="https://doc.rust-lang.org/nightly/std/panic/trait.UnwindSafe.html" title="trait std::panic::UnwindSafe">UnwindSafe</a>, </span></code><a href='#impl-UnwindSafe' class='anchor'></a></h3><div class='impl-items'></div><h3 id='impl-RefUnwindSafe' class='impl'><code class='in-band'>impl<I> <a class="trait" href="https://doc.rust-lang.org/nightly/std/panic/trait.RefUnwindSafe.html" title="trait std::panic::RefUnwindSafe">RefUnwindSafe</a> for <a class="struct" href="../image/struct.SubImage.html" title="struct image::SubImage">SubImage</a><I> <span class="where fmt-newline">where<br> I: <a class="trait" href="https://doc.rust-lang.org/nightly/std/panic/trait.RefUnwindSafe.html" title="trait std::panic::RefUnwindSafe">RefUnwindSafe</a>, </span></code><a href='#impl-RefUnwindSafe' class='anchor'></a></h3><div class='impl-items'></div></div><h2 id='blanket-implementations' class='small-section-header'>Blanket Implementations<a href='#blanket-implementations' class='anchor'></a></h2><div id='blanket-implementations-list'><h3 id='impl-Into%3CU%3E' class='impl'><code class='in-band'>impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><T>, </span></code><a href='#impl-Into%3CU%3E' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#544-549' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.into' class="method hidden"><code id='into.v'>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.Into.html#tymethod.into' class='fnname'>into</a>(self) -> U</code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#546-548' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
|
|
</div></div><h3 id='impl-From%3CT%3E' class='impl'><code class='in-band'>impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><T> for T</code><a href='#impl-From%3CT%3E' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#553-555' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.from' class="method hidden"><code id='from.v'>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from' class='fnname'>from</a>(t: T) -> T</code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#554' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
|
|
</div></div><h3 id='impl-TryFrom%3CU%3E' class='impl'><code class='in-band'>impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><T>, </span></code><a href='#impl-TryFrom%3CU%3E' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#572-578' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Error' class="type"><code id='Error.t'>type <a href='https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error' class="type">Error</a> = <a class="enum" href="https://doc.rust-lang.org/nightly/core/convert/enum.Infallible.html" title="enum core::convert::Infallible">Infallible</a></code></h4><div class='docblock'><p>The type returned in the event of a conversion error.</p>
|
|
|
</div><h4 id='method.try_from' class="method hidden"><code id='try_from.v'>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#tymethod.try_from' class='fnname'>try_from</a>(value: U) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, <T as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#575-577' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
|
|
</div></div><h3 id='impl-TryInto%3CU%3E' class='impl'><code class='in-band'>impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html" title="trait core::convert::TryInto">TryInto</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>, </span></code><a href='#impl-TryInto%3CU%3E' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#560-567' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Error-1' class="type"><code id='Error.t-1'>type <a href='https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#associatedtype.Error' class="type">Error</a> = <U as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a></code></h4><div class='docblock'><p>The type returned in the event of a conversion error.</p>
|
|
|
</div><h4 id='method.try_into' class="method hidden"><code id='try_into.v'>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#tymethod.try_into' class='fnname'>try_into</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><U, <U as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#564-566' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
|
|
</div></div><h3 id='impl-BorrowMut%3CT%3E' class='impl'><code class='in-band'>impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html" title="trait core::borrow::BorrowMut">BorrowMut</a><T> for T <span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href='#impl-BorrowMut%3CT%3E' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#218-220' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.borrow_mut' class="method hidden"><code id='borrow_mut.v'>fn <a href='https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut' class='fnname'>borrow_mut</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>T</code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#219' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Mutably borrows from an owned value. <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut">Read more</a></p>
|
|
|
</div></div><h3 id='impl-Borrow%3CT%3E' class='impl'><code class='in-band'>impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a><T> for T <span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href='#impl-Borrow%3CT%3E' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#213-215' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.borrow' class="method hidden"><code id='borrow.v'>fn <a href='https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow' class='fnname'>borrow</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>T</code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#214' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Immutably borrows from an owned value. <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></p>
|
|
|
</div></div><h3 id='impl-Any' class='impl'><code class='in-band'>impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html" title="trait core::any::Any">Any</a> for T <span class="where fmt-newline">where<br> T: 'static + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href='#impl-Any' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/any.rs.html#100-102' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.type_id' class="method hidden"><code id='type_id.v'>fn <a href='https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id' class='fnname'>type_id</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/any/struct.TypeId.html" title="struct core::any::TypeId">TypeId</a></code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/any.rs.html#101' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Gets the <code>TypeId</code> of <code>self</code>. <a href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id">Read more</a></p>
|
|
|
</div></div><h3 id='impl-SetParameter' class='impl'><code class='in-band'>impl<T> <a class="trait" href="../gif/traits/trait.SetParameter.html" title="trait gif::traits::SetParameter">SetParameter</a> for T</code><a href='#impl-SetParameter' class='anchor'></a><a class='srclink' href='../src/gif/traits.rs.html#25' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.set' class="method hidden"><code id='set.v'>fn <a href='../gif/traits/trait.SetParameter.html#method.set' class='fnname'>set</a><T>(&mut self, value: T) -> <T as <a class="trait" href="../gif/traits/trait.Parameter.html" title="trait gif::traits::Parameter">Parameter</a><Self>>::<a class="type" href="../gif/traits/trait.Parameter.html#associatedtype.Result" title="type gif::traits::Parameter::Result">Result</a> <span class="where fmt-newline">where<br> T: <a class="trait" href="../gif/traits/trait.Parameter.html" title="trait gif::traits::Parameter">Parameter</a><Self>, </span></code><a class='srclink' href='../src/gif/traits.rs.html#20-22' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Sets <code>value</code> as a parameter of <code>self</code>.</p>
|
|
|
</div></div></div></section><section id="search" class="content hidden"></section><section class="footer"></section><aside id="help" class="hidden"><div><h1 class="hidden">Help</h1><div class="shortcuts"><h2>Keyboard Shortcuts</h2><dl><dt><kbd>?</kbd></dt><dd>Show this help dialog</dd><dt><kbd>S</kbd></dt><dd>Focus the search field</dd><dt><kbd>↑</kbd></dt><dd>Move up in search results</dd><dt><kbd>↓</kbd></dt><dd>Move down in search results</dd><dt><kbd>↹</kbd></dt><dd>Switch tab</dd><dt><kbd>⏎</kbd></dt><dd>Go to active search result</dd><dt><kbd>+</kbd></dt><dd>Expand all sections</dd><dt><kbd>-</kbd></dt><dd>Collapse all sections</dd></dl></div><div class="infos"><h2>Search Tricks</h2><p>Prefix searches with a type followed by a colon (e.g., <code>fn:</code>) to restrict the search to a given type.</p><p>Accepted types are: <code>fn</code>, <code>mod</code>, <code>struct</code>, <code>enum</code>, <code>trait</code>, <code>type</code>, <code>macro</code>, and <code>const</code>.</p><p>Search functions by type signature (e.g., <code>vec -> usize</code> or <code>* -> vec</code>)</p><p>Search multiple things at once by splitting your query with comma (e.g., <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../";window.currentCrate = "image";</script><script src="../aliases.js"></script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html> |
