mirror of
https://github.com/neogeek23/rusty_snek_gaem.git
synced 2026-02-04 11:08:40 +00:00
60 lines
23 KiB
HTML
60 lines
23 KiB
HTML
<!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 `GenericImage` trait in crate `image`."><meta name="keywords" content="rust, rustlang, rust-lang, GenericImage"><title>image::GenericImage - 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></head><body class="rustdoc trait"><!--[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><p class='location'>Trait GenericImage</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#associated-types">Associated Types</a><div class="sidebar-links"><a href="#associatedtype.InnerImage">InnerImage</a></div><a class="sidebar-title" href="#required-methods">Required Methods</a><div class="sidebar-links"><a href="#tymethod.get_pixel_mut">get_pixel_mut</a><a href="#tymethod.put_pixel">put_pixel</a><a href="#tymethod.blend_pixel">blend_pixel</a><a href="#tymethod.inner_mut">inner_mut</a></div><a class="sidebar-title" href="#provided-methods">Provided Methods</a><div class="sidebar-links"><a href="#method.unsafe_put_pixel">unsafe_put_pixel</a><a href="#method.pixels_mut">pixels_mut</a><a href="#method.copy_from">copy_from</a><a href="#method.sub_image">sub_image</a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class='location'><a href='index.html'>image</a></p><script>window.sidebarCurrent = {name: 'GenericImage', ty: 'trait', 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"><input class="search-input" name="search" autocomplete="off" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><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='in-band'>Trait <a href='index.html'>image</a>::<wbr><a class="trait" href=''>GenericImage</a></span><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#430-524' title='goto source code'>[src]</a></span></h1><div class="docblock type-decl"><pre class='rust trait'>pub trait GenericImage: <a class="trait" href="../image/trait.GenericImageView.html" title="trait image::GenericImageView">GenericImageView</a> {
|
||
type <a href='#associatedtype.InnerImage' class="type">InnerImage</a>: <a class="trait" href="../image/trait.GenericImage.html" title="trait image::GenericImage">GenericImage</a><Pixel = Self::<a class="type" href="../image/trait.GenericImageView.html#associatedtype.Pixel" title="type image::GenericImageView::Pixel">Pixel</a>>;
|
||
fn <a href='#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>;
|
||
<div class='item-spacer'></div> fn <a href='#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>);
|
||
<div class='item-spacer'></div> fn <a href='#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>);
|
||
<div class='item-spacer'></div> fn <a href='#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>;
|
||
|
||
unsafe fn <a href='#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>) { ... }
|
||
<div class='item-spacer'></div> fn <a href='#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> { ... }
|
||
<div class='item-spacer'></div> fn <a href='#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><br> <span class="where">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>,
|
||
{ ... }
|
||
<div class='item-spacer'></div> fn <a href='#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>> { ... }
|
||
}</pre></div><div class='docblock'><p>A trait for manipulating images.</p>
|
||
</div>
|
||
<h2 id='associated-types' class='small-section-header'>
|
||
Associated Types<a href='#associated-types' class='anchor'></a>
|
||
</h2>
|
||
<div class='methods'>
|
||
<h3 id='associatedtype.InnerImage' class='method'><span id='InnerImage.t' class='invisible'><code>type <a href='#associatedtype.InnerImage' class="type">InnerImage</a>: <a class="trait" href="../image/trait.GenericImage.html" title="trait image::GenericImage">GenericImage</a><Pixel = Self::<a class="type" href="../image/trait.GenericImageView.html#associatedtype.Pixel" title="type image::GenericImageView::Pixel">Pixel</a>></code></span></h3><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.</p>
|
||
</div></div>
|
||
<h2 id='required-methods' class='small-section-header'>
|
||
Required Methods<a href='#required-methods' class='anchor'></a>
|
||
</h2>
|
||
<div class='methods'>
|
||
<h3 id='tymethod.get_pixel_mut' class='method'><span id='get_pixel_mut.v' class='invisible'><code>fn <a href='#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></span></h3><div class='docblock'><p>Gets a reference to the mutable pixel at location <code>(x, y)</code></p>
|
||
<h1 id="panics" class="section-header"><a href="#panics">Panics</a></h1>
|
||
<p>Panics if <code>(x, y)</code> is out of bounds.</p>
|
||
</div><h3 id='tymethod.put_pixel' class='method'><span id='put_pixel.v' class='invisible'><code>fn <a href='#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></span></h3><div class='docblock'><p>Put a pixel at location (x, y)</p>
|
||
<h1 id="panics-1" class="section-header"><a href="#panics-1">Panics</a></h1>
|
||
<p>Panics if <code>(x, y)</code> is out of bounds.</p>
|
||
</div><h3 id='tymethod.blend_pixel' class='method'><span id='blend_pixel.v' class='invisible'><code>fn <a href='#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></span></h3><div class='docblock'><p>Put a pixel at location (x, y), taking into account alpha channels</p>
|
||
<p>DEPRECATED: This method will be removed. Blend the pixel directly instead.</p>
|
||
</div><h3 id='tymethod.inner_mut' class='method'><span id='inner_mut.v' class='invisible'><code>fn <a href='#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></span></h3><div class='docblock'><p>Returns a mutable reference to the underlying image.</p>
|
||
</div></div>
|
||
<h2 id='provided-methods' class='small-section-header'>
|
||
Provided Methods<a href='#provided-methods' class='anchor'></a>
|
||
</h2>
|
||
<div class='methods'>
|
||
<h3 id='method.unsafe_put_pixel' class='method'><span id='unsafe_put_pixel.v' class='invisible'><code>unsafe fn <a href='#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></span></h3><div class='docblock'><p>Puts a pixel at location (x, y)</p>
|
||
<p>This function can be implemented in a way that ignores bounds checking.</p>
|
||
</div><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/iterator/trait.Iterator.html" title="trait core::iter::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/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><h3 id='method.pixels_mut' class='method'><span id='pixels_mut.v' class='invisible'><code>fn <a href='#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></span></h3><div class='stability'><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'><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.</p>
|
||
</div><h3 id='method.copy_from' class='method'><span id='copy_from.v' class='invisible'><code>fn <a href='#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></span></h3><div class='docblock'><p>Copies all of the pixels from another image into this image.</p>
|
||
<p>The other image is copied with the top-left corner of the
|
||
other image placed at (x, y).</p>
|
||
<p>In order to copy only a piece of the other image, use <code>sub_image</code>.</p>
|
||
<h1 id="returns" class="section-header"><a href="#returns">Returns</a></h1>
|
||
<p><code>true</code> if the copy was successful, <code>false</code> if the image could not
|
||
be copied due to size constraints.</p>
|
||
</div><h3 id='method.sub_image' class='method'><span id='sub_image.v' class='invisible'><code>fn <a href='#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></span></h3><div class='docblock'><p>Returns a subimage that is a view into this image.</p>
|
||
</div></div><h2 id='implementors' class='small-section-header'>Implementors<a href='#implementors' class='anchor'></a></h2><ul class='item-list' id='implementors-list'><li><table class='table-display'><tbody><tr><td><code>impl<P, Container> GenericImage for <a class="struct" href="../image/struct.ImageBuffer.html" title="struct image::ImageBuffer">ImageBuffer</a><P, Container> <span class="where fmt-newline">where<br> P: <a class="trait" href="../image/trait.Pixel.html" title="trait image::Pixel">Pixel</a> + 'static,<br> Container: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/deref/trait.Deref.html" title="trait core::ops::deref::Deref">Deref</a><Target = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">[</a>P::<a class="type" href="../image/trait.Pixel.html#associatedtype.Subpixel" title="type image::Pixel::Subpixel">Subpixel</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>> + <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> P::<a class="type" href="../image/trait.Pixel.html#associatedtype.Subpixel" title="type image::Pixel::Subpixel">Subpixel</a>: 'static, </span><span class="where fmt-newline"> type <a href='#associatedtype.InnerImage' class="type">InnerImage</a> = Self;</span></code><td><div class='out-of-band'><a class='srclink' href='../src/image/buffer.rs.html#551-589' title='goto source code'>[src]</a></div></td></tr></tbody></table></li>
|
||
<li><table class='table-display'><tbody><tr><td><code>impl GenericImage for <a class="enum" href="../image/enum.DynamicImage.html" title="enum image::DynamicImage">DynamicImage</a><span class="where fmt-newline"> type <a href='#associatedtype.InnerImage' class="type">InnerImage</a> = <a class="enum" href="../image/enum.DynamicImage.html" title="enum image::DynamicImage">DynamicImage</a>;</span></code><td><div class='out-of-band'><a class='srclink' href='../src/image/dynimage.rs.html#588-622' title='goto source code'>[src]</a></div></td></tr></tbody></table></li>
|
||
<li><table class='table-display'><tbody><tr><td><code>impl<I> GenericImage 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><span class="where fmt-newline"> type <a href='#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>;</span></code><td><div class='out-of-band'><a class='srclink' href='../src/image/image.rs.html#617-654' title='goto source code'>[src]</a></div></td></tr></tbody></table></li>
|
||
</ul><script type="text/javascript">window.inlined_types=new Set([]);</script><script type="text/javascript" async
|
||
src="../implementors/image/trait.GenericImage.js">
|
||
</script></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> |