| <!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 View into another image"><meta name="keywords" content="rust, rustlang, rust-lang, SubImage"><title>SubImage in image - 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="#">SubImage</a></h2><div class="sidebar-elems"><section><h3><a href="#implementations">Methods</a></h3><ul class="block"><li><a href="#method.change_bounds">change_bounds</a></li><li><a href="#method.new">new</a></li><li><a href="#method.to_image">to_image</a></li></ul><h3><a href="#trait-implementations">Trait Implementations</a></h3><ul class="block"><li><a href="#impl-GenericImage-for-SubImage%3CI%3E">GenericImage</a></li><li><a href="#impl-GenericImageView-for-SubImage%3CI%3E">GenericImageView</a></li></ul><h3><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul class="block"><li><a href="#impl-RefUnwindSafe-for-SubImage%3CI%3E">RefUnwindSafe</a></li><li><a href="#impl-Send-for-SubImage%3CI%3E">Send</a></li><li><a href="#impl-Sync-for-SubImage%3CI%3E">Sync</a></li><li><a href="#impl-Unpin-for-SubImage%3CI%3E">Unpin</a></li><li><a href="#impl-UnwindSafe-for-SubImage%3CI%3E">UnwindSafe</a></li></ul><h3><a href="#blanket-implementations">Blanket Implementations</a></h3><ul class="block"><li><a href="#impl-Any-for-SubImage%3CI%3E">Any</a></li><li><a href="#impl-Borrow%3CT%3E-for-SubImage%3CI%3E">Borrow<T></a></li><li><a href="#impl-BorrowMut%3CT%3E-for-SubImage%3CI%3E">BorrowMut<T></a></li><li><a href="#impl-From%3CT%3E-for-SubImage%3CI%3E">From<T></a></li><li><a href="#impl-Into%3CU%3E-for-SubImage%3CI%3E">Into<U></a></li><li><a href="#impl-TryFrom%3CU%3E-for-SubImage%3CI%3E">TryFrom<U></a></li><li><a href="#impl-TryInto%3CU%3E-for-SubImage%3CI%3E">TryInto<U></a></li></ul></section><h2><a href="index.html">In image</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 class="struct" href="#">SubImage</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/image.rs.html#944-950">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 SubImage<I> { /* 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 View into another image</p> |
| <p>Instances of this struct can be created using:</p> |
| <ul> |
| <li><a href="trait.GenericImage.html#method.sub_image" title="GenericImage::sub_image"><code>GenericImage::sub_image</code></a> to create a mutable view,</li> |
| <li><a href="trait.GenericImageView.html#method.view" title="GenericImageView::view"><code>GenericImageView::view</code></a> to create an immutable view,</li> |
| <li><a href="struct.SubImage.html#method.new" title="SubImage::new"><code>SubImage::new</code></a> to instantiate the struct directly.</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-SubImage%3CI%3E" class="impl has-srclink"><a class="srclink rightside" href="../src/image/image.rs.html#958-997">source</a><a href="#impl-SubImage%3CI%3E" class="anchor"></a><h3 class="code-header">impl<I> <a class="struct" href="struct.SubImage.html" title="struct image::SubImage">SubImage</a><I></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.new" class="method has-srclink"><a class="srclink rightside" href="../src/image/image.rs.html#961-969">source</a><h4 class="code-header">pub fn <a href="#method.new" class="fnname">new</a>(image: I, x: u32, y: u32, width: u32, height: u32) -> <a class="struct" href="struct.SubImage.html" title="struct image::SubImage">SubImage</a><I></h4></section></summary><div class="docblock"><p>Construct a new subimage |
| The coordinates set the position of the top left corner of the SubImage.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.change_bounds" class="method has-srclink"><a class="srclink rightside" href="../src/image/image.rs.html#972-977">source</a><h4 class="code-header">pub fn <a href="#method.change_bounds" class="fnname">change_bounds</a>(&mut self, x: u32, y: u32, width: u32, height: u32)</h4></section></summary><div class="docblock"><p>Change the coordinates of this subimage.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.to_image" class="method has-srclink"><a class="srclink rightside" href="../src/image/image.rs.html#980-996">source</a><h4 class="code-header">pub fn <a href="#method.to_image" class="fnname">to_image</a>(<br> &self<br>) -> <a class="struct" href="struct.ImageBuffer.html" title="struct image::ImageBuffer">ImageBuffer</a><<<I as Deref>::Target as <a class="trait" href="trait.GenericImageView.html" title="trait image::GenericImageView">GenericImageView</a>>::<a class="associatedtype" href="trait.GenericImageView.html#associatedtype.Pixel" title="type image::GenericImageView::Pixel">Pixel</a>, Vec<<<<I as Deref>::Target as <a class="trait" href="trait.GenericImageView.html" title="trait image::GenericImageView">GenericImageView</a>>::<a class="associatedtype" href="trait.GenericImageView.html#associatedtype.Pixel" title="type image::GenericImageView::Pixel">Pixel</a> as <a class="trait" href="trait.Pixel.html" title="trait image::Pixel">Pixel</a>>::<a class="associatedtype" href="trait.Pixel.html#associatedtype.Subpixel" title="type image::Pixel::Subpixel">Subpixel</a>>><span class="where fmt-newline">where<br> I: Deref,<br> I::Target: <a class="trait" href="trait.GenericImage.html" title="trait image::GenericImage">GenericImage</a> + 'static,</span></h4></section></summary><div class="docblock"><p>Convert this subimage to an ImageBuffer</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-GenericImage-for-SubImage%3CI%3E" class="impl has-srclink"><a class="srclink rightside" href="../src/image/image.rs.html#1032-1069">source</a><a href="#impl-GenericImage-for-SubImage%3CI%3E" class="anchor"></a><h3 class="code-header">impl<I> <a class="trait" href="trait.GenericImage.html" title="trait image::GenericImage">GenericImage</a> for <a class="struct" href="struct.SubImage.html" title="struct image::SubImage">SubImage</a><I><span class="where fmt-newline">where<br> I: DerefMut,<br> I::Target: <a class="trait" href="trait.GenericImage.html" title="trait image::GenericImage">GenericImage</a> + Sized,</span></h3></section></summary><div class="impl-items"><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/image.rs.html#1049-1052">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"><p>DEPRECATED: This method will be removed. Blend the pixel directly instead.</p> |
| </div></details><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> = <I as Deref>::Target</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/image.rs.html#1039-1041">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/image.rs.html#1043-1046">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.sub_image" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/image/image.rs.html#1054-1064">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><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/image.rs.html#1066-1068">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::<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 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></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-GenericImageView-for-SubImage%3CI%3E" class="impl has-srclink"><a class="srclink rightside" href="../src/image/image.rs.html#1000-1029">source</a><a href="#impl-GenericImageView-for-SubImage%3CI%3E" class="anchor"></a><h3 class="code-header">impl<I> <a class="trait" href="trait.GenericImageView.html" title="trait image::GenericImageView">GenericImageView</a> for <a class="struct" href="struct.SubImage.html" title="struct image::SubImage">SubImage</a><I><span class="where fmt-newline">where<br> I: Deref,<br> I::Target: <a class="trait" href="trait.GenericImageView.html" title="trait image::GenericImageView">GenericImageView</a> + Sized,</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> = <<I as Deref>::Target as <a class="trait" href="trait.GenericImageView.html" title="trait image::GenericImageView">GenericImageView</a>>::<a class="associatedtype" href="trait.GenericImageView.html#associatedtype.Pixel" title="type image::GenericImageView::Pixel">Pixel</a></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> = <I as Deref>::Target</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/image.rs.html#1008-1010">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/image.rs.html#1012-1014">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.get_pixel" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/image/image.rs.html#1016-1018">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.view" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/image/image.rs.html#1020-1024">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><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/image.rs.html#1026-1028">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::<a class="associatedtype" href="trait.GenericImageView.html#associatedtype.InnerImageView" title="type image::GenericImageView::InnerImageView">InnerImageView</a></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.in_bounds" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/image/image.rs.html#753-756">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.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></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-SubImage%3CI%3E" class="impl has-srclink"><a href="#impl-RefUnwindSafe-for-SubImage%3CI%3E" class="anchor"></a><h3 class="code-header">impl<I> RefUnwindSafe for <a class="struct" href="struct.SubImage.html" title="struct image::SubImage">SubImage</a><I><span class="where fmt-newline">where<br> I: RefUnwindSafe,</span></h3></section><section id="impl-Send-for-SubImage%3CI%3E" class="impl has-srclink"><a href="#impl-Send-for-SubImage%3CI%3E" class="anchor"></a><h3 class="code-header">impl<I> Send for <a class="struct" href="struct.SubImage.html" title="struct image::SubImage">SubImage</a><I><span class="where fmt-newline">where<br> I: Send,</span></h3></section><section id="impl-Sync-for-SubImage%3CI%3E" class="impl has-srclink"><a href="#impl-Sync-for-SubImage%3CI%3E" class="anchor"></a><h3 class="code-header">impl<I> Sync for <a class="struct" href="struct.SubImage.html" title="struct image::SubImage">SubImage</a><I><span class="where fmt-newline">where<br> I: Sync,</span></h3></section><section id="impl-Unpin-for-SubImage%3CI%3E" class="impl has-srclink"><a href="#impl-Unpin-for-SubImage%3CI%3E" class="anchor"></a><h3 class="code-header">impl<I> Unpin for <a class="struct" href="struct.SubImage.html" title="struct image::SubImage">SubImage</a><I><span class="where fmt-newline">where<br> I: Unpin,</span></h3></section><section id="impl-UnwindSafe-for-SubImage%3CI%3E" class="impl has-srclink"><a href="#impl-UnwindSafe-for-SubImage%3CI%3E" class="anchor"></a><h3 class="code-header">impl<I> UnwindSafe for <a class="struct" href="struct.SubImage.html" title="struct image::SubImage">SubImage</a><I><span class="where fmt-newline">where<br> I: 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-SubImage%3CI%3E" class="impl has-srclink"><a href="#impl-Any-for-SubImage%3CI%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-SubImage%3CI%3E" class="impl has-srclink"><a href="#impl-Borrow%3CT%3E-for-SubImage%3CI%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-SubImage%3CI%3E" class="impl has-srclink"><a href="#impl-BorrowMut%3CT%3E-for-SubImage%3CI%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-SubImage%3CI%3E" class="impl has-srclink"><a href="#impl-From%3CT%3E-for-SubImage%3CI%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-SubImage%3CI%3E" class="impl has-srclink"><a href="#impl-Into%3CU%3E-for-SubImage%3CI%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-TryFrom%3CU%3E-for-SubImage%3CI%3E" class="impl has-srclink"><a href="#impl-TryFrom%3CU%3E-for-SubImage%3CI%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-SubImage%3CI%3E" class="impl has-srclink"><a href="#impl-TryInto%3CU%3E-for-SubImage%3CI%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> |
