mirror of
https://github.com/neogeek23/rusty_snek_gaem.git
synced 2026-02-05 11:38:44 +00:00
45 lines
20 KiB
HTML
45 lines
20 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 `ImageDecoder` trait in crate `image`."><meta name="keywords" content="rust, rustlang, rust-lang, ImageDecoder"><title>image::ImageDecoder - 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 ImageDecoder</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#required-methods">Required Methods</a><div class="sidebar-links"><a href="#tymethod.dimensions">dimensions</a><a href="#tymethod.colortype">colortype</a><a href="#tymethod.row_len">row_len</a><a href="#tymethod.read_scanline">read_scanline</a><a href="#tymethod.read_image">read_image</a></div><a class="sidebar-title" href="#provided-methods">Provided Methods</a><div class="sidebar-links"><a href="#method.is_animated">is_animated</a><a href="#method.into_frames">into_frames</a><a href="#method.load_rect">load_rect</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: 'ImageDecoder', 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=''>ImageDecoder</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#207-280' title='goto source code'>[src]</a></span></h1><div class="docblock type-decl"><pre class='rust trait'>pub trait ImageDecoder: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> {
|
||
fn <a href='#tymethod.dimensions' class='fnname'>dimensions</a>(&mut self) -> <a class="type" href="../image/type.ImageResult.html" title="type image::ImageResult">ImageResult</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 class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>>;
|
||
<div class='item-spacer'></div> fn <a href='#tymethod.colortype' class='fnname'>colortype</a>(&mut self) -> <a class="type" href="../image/type.ImageResult.html" title="type image::ImageResult">ImageResult</a><<a class="enum" href="../image/enum.ColorType.html" title="enum image::ColorType">ColorType</a>>;
|
||
<div class='item-spacer'></div> fn <a href='#tymethod.row_len' class='fnname'>row_len</a>(&mut self) -> <a class="type" href="../image/type.ImageResult.html" title="type image::ImageResult">ImageResult</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>>;
|
||
<div class='item-spacer'></div> fn <a href='#tymethod.read_scanline' class='fnname'>read_scanline</a>(&mut self, buf: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&mut [</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>) -> <a class="type" href="../image/type.ImageResult.html" title="type image::ImageResult">ImageResult</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>>;
|
||
<div class='item-spacer'></div> fn <a href='#tymethod.read_image' class='fnname'>read_image</a>(&mut self) -> <a class="type" href="../image/type.ImageResult.html" title="type image::ImageResult">ImageResult</a><<a class="enum" href="../image/enum.DecodingResult.html" title="enum image::DecodingResult">DecodingResult</a>>;
|
||
|
||
fn <a href='#method.is_animated' class='fnname'>is_animated</a>(&mut self) -> <a class="type" href="../image/type.ImageResult.html" title="type image::ImageResult">ImageResult</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>> { ... }
|
||
<div class='item-spacer'></div> fn <a href='#method.into_frames' class='fnname'>into_frames</a>(self) -> <a class="type" href="../image/type.ImageResult.html" title="type image::ImageResult">ImageResult</a><<a class="struct" href="../image/struct.Frames.html" title="struct image::Frames">Frames</a>> { ... }
|
||
<div class='item-spacer'></div> fn <a href='#method.load_rect' class='fnname'>load_rect</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> length: <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> ) -> <a class="type" href="../image/type.ImageResult.html" title="type image::ImageResult">ImageResult</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>>> { ... }
|
||
}</pre></div><div class='docblock'><p>The trait that all decoders implement</p>
|
||
</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.dimensions' class='method'><span id='dimensions.v' class='invisible'><code>fn <a href='#tymethod.dimensions' class='fnname'>dimensions</a>(&mut self) -> <a class="type" href="../image/type.ImageResult.html" title="type image::ImageResult">ImageResult</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 class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>></code></span></h3><div class='docblock'><p>Returns a tuple containing the width and height of the image</p>
|
||
</div><h3 id='tymethod.colortype' class='method'><span id='colortype.v' class='invisible'><code>fn <a href='#tymethod.colortype' class='fnname'>colortype</a>(&mut self) -> <a class="type" href="../image/type.ImageResult.html" title="type image::ImageResult">ImageResult</a><<a class="enum" href="../image/enum.ColorType.html" title="enum image::ColorType">ColorType</a>></code></span></h3><div class='docblock'><p>Returns the color type of the image e.g. RGB(8) (8bit RGB)</p>
|
||
</div><h3 id='tymethod.row_len' class='method'><span id='row_len.v' class='invisible'><code>fn <a href='#tymethod.row_len' class='fnname'>row_len</a>(&mut self) -> <a class="type" href="../image/type.ImageResult.html" title="type image::ImageResult">ImageResult</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>></code></span></h3><div class='docblock'><p>Returns the length in bytes of one decoded row of the image</p>
|
||
</div><h3 id='tymethod.read_scanline' class='method'><span id='read_scanline.v' class='invisible'><code>fn <a href='#tymethod.read_scanline' class='fnname'>read_scanline</a>(&mut self, buf: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&mut [</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>) -> <a class="type" href="../image/type.ImageResult.html" title="type image::ImageResult">ImageResult</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>></code></span></h3><div class='docblock'><p>Reads one row from the image into <code>buf</code> and returns the row index</p>
|
||
</div><h3 id='tymethod.read_image' class='method'><span id='read_image.v' class='invisible'><code>fn <a href='#tymethod.read_image' class='fnname'>read_image</a>(&mut self) -> <a class="type" href="../image/type.ImageResult.html" title="type image::ImageResult">ImageResult</a><<a class="enum" href="../image/enum.DecodingResult.html" title="enum image::DecodingResult">DecodingResult</a>></code></span></h3><div class='docblock'><p>Decodes the entire image and return it as a Vector</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.is_animated' class='method'><span id='is_animated.v' class='invisible'><code>fn <a href='#method.is_animated' class='fnname'>is_animated</a>(&mut self) -> <a class="type" href="../image/type.ImageResult.html" title="type image::ImageResult">ImageResult</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>></code></span></h3><div class='docblock'><p>Returns true if the image is animated</p>
|
||
</div><h3 id='method.into_frames' class='method'><span id='into_frames.v' class='invisible'><code>fn <a href='#method.into_frames' class='fnname'>into_frames</a>(self) -> <a class="type" href="../image/type.ImageResult.html" title="type image::ImageResult">ImageResult</a><<a class="struct" href="../image/struct.Frames.html" title="struct image::Frames">Frames</a>></code></span></h3><div class='docblock'><p>Returns the frames of the image</p>
|
||
<p>If the image is not animated it returns a single frame</p>
|
||
</div><h3 id='method.load_rect' class='method'><span id='load_rect.v' class='invisible'><code>fn <a href='#method.load_rect' class='fnname'>load_rect</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> length: <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>) -> <a class="type" href="../image/type.ImageResult.html" title="type image::ImageResult">ImageResult</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>>></code></span></h3><div class='docblock'><p>Decodes a specific region of the image, represented by the rectangle
|
||
starting from <code>x</code> and <code>y</code> and having <code>length</code> and <code>width</code></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<R: <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Read.html" title="trait std::io::Read">Read</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Seek.html" title="trait std::io::Seek">Seek</a>> ImageDecoder for <a class="struct" href="../image/bmp/struct.BMPDecoder.html" title="struct image::bmp::BMPDecoder">BMPDecoder</a><R></code><td><div class='out-of-band'><a class='srclink' href='../src/image/bmp/decoder.rs.html#1228-1256' title='goto source code'>[src]</a></div></td></tr></tbody></table></li>
|
||
<li><table class='table-display'><tbody><tr><td><code>impl<R: <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Read.html" title="trait std::io::Read">Read</a>> ImageDecoder for <a class="struct" href="../image/dxt/struct.DXTDecoder.html" title="struct image::dxt::DXTDecoder">DXTDecoder</a><R></code><td><div class='out-of-band'><a class='srclink' href='../src/image/dxt.rs.html#101-135' title='goto source code'>[src]</a></div></td></tr></tbody></table></li>
|
||
<li><table class='table-display'><tbody><tr><td><code>impl<R: <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Read.html" title="trait std::io::Read">Read</a>> ImageDecoder for <a class="struct" href="../image/gif/struct.Decoder.html" title="struct image::gif::Decoder">Decoder</a><R></code><td><div class='out-of-band'><a class='srclink' href='../src/image/gif.rs.html#81-226' title='goto source code'>[src]</a></div></td></tr></tbody></table></li>
|
||
<li><table class='table-display'><tbody><tr><td><code>impl<R: <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.BufRead.html" title="trait std::io::BufRead">BufRead</a>> ImageDecoder for <a class="struct" href="../image/hdr/struct.HDRAdapter.html" title="struct image::hdr::HDRAdapter">HDRAdapter</a><R></code><td><div class='out-of-band'><a class='srclink' href='../src/image/hdr/hdr_decoder.rs.html#44-79' title='goto source code'>[src]</a></div></td></tr></tbody></table></li>
|
||
<li><table class='table-display'><tbody><tr><td><code>impl<R: <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Read.html" title="trait std::io::Read">Read</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Seek.html" title="trait std::io::Seek">Seek</a>> ImageDecoder for <a class="struct" href="../image/ico/struct.ICODecoder.html" title="struct image::ico::ICODecoder">ICODecoder</a><R></code><td><div class='out-of-band'><a class='srclink' href='../src/image/ico/decoder.rs.html#163-278' title='goto source code'>[src]</a></div></td></tr></tbody></table></li>
|
||
<li><table class='table-display'><tbody><tr><td><code>impl<R: <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Read.html" title="trait std::io::Read">Read</a>> ImageDecoder for <a class="struct" href="../image/jpeg/struct.JPEGDecoder.html" title="struct image::jpeg::JPEGDecoder">JPEGDecoder</a><R></code><td><div class='out-of-band'><a class='srclink' href='../src/image/jpeg/decoder.rs.html#42-71' title='goto source code'>[src]</a></div></td></tr></tbody></table></li>
|
||
<li><table class='table-display'><tbody><tr><td><code>impl<R: <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Read.html" title="trait std::io::Read">Read</a>> ImageDecoder for <a class="struct" href="../image/png/struct.PNGDecoder.html" title="struct image::png::PNGDecoder">PNGDecoder</a><R></code><td><div class='out-of-band'><a class='srclink' href='../src/image/png.rs.html#53-86' title='goto source code'>[src]</a></div></td></tr></tbody></table></li>
|
||
<li><table class='table-display'><tbody><tr><td><code>impl<R: <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Read.html" title="trait std::io::Read">Read</a>> ImageDecoder for <a class="struct" href="../image/pnm/struct.PNMDecoder.html" title="struct image::pnm::PNMDecoder">PNMDecoder</a><R></code><td><div class='out-of-band'><a class='srclink' href='../src/image/pnm/decoder.rs.html#404-424' title='goto source code'>[src]</a></div></td></tr></tbody></table></li>
|
||
<li><table class='table-display'><tbody><tr><td><code>impl<R: <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Read.html" title="trait std::io::Read">Read</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Seek.html" title="trait std::io::Seek">Seek</a>> ImageDecoder for <a class="struct" href="../image/tga/struct.TGADecoder.html" title="struct image::tga::TGADecoder">TGADecoder</a><R></code><td><div class='out-of-band'><a class='srclink' href='../src/image/tga/decoder.rs.html#470-531' title='goto source code'>[src]</a></div></td></tr></tbody></table></li>
|
||
<li><table class='table-display'><tbody><tr><td><code>impl<R: <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Read.html" title="trait std::io::Read">Read</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Seek.html" title="trait std::io::Seek">Seek</a>> ImageDecoder for <a class="struct" href="../image/tiff/struct.TIFFDecoder.html" title="struct image::tiff::TIFFDecoder">TIFFDecoder</a><R></code><td><div class='out-of-band'><a class='srclink' href='../src/image/tiff.rs.html#64-84' title='goto source code'>[src]</a></div></td></tr></tbody></table></li>
|
||
<li><table class='table-display'><tbody><tr><td><code>impl<R: <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Read.html" title="trait std::io::Read">Read</a>> ImageDecoder for <a class="struct" href="../image/webp/struct.WebpDecoder.html" title="struct image::webp::WebpDecoder">WebpDecoder</a><R></code><td><div class='out-of-band'><a class='srclink' href='../src/image/webp/decoder.rs.html#100-139' 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.ImageDecoder.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> |