mirror of
https://github.com/neogeek23/rusty_snek_gaem.git
synced 2026-02-04 11:08:40 +00:00
11 lines
16 KiB
HTML
11 lines
16 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 `TIFFDecoder` struct in crate `image`."><meta name="keywords" content="rust, rustlang, rust-lang, TIFFDecoder"><title>image::tiff::TIFFDecoder - 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 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><p class='location'>Struct TIFFDecoder</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.new">new</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-ImageDecoder">ImageDecoder</a></div><a class="sidebar-title" href="#synthetic-implementations">Auto Trait Implementations</a><div class="sidebar-links"><a href="#impl-Send">Send</a><a href="#impl-Sync">Sync</a></div></div><p class='location'><a href='../index.html'>image</a>::<wbr><a href='index.html'>tiff</a></p><script>window.sidebarCurrent = {name: 'TIFFDecoder', 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"><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'>Struct <a href='../index.html'>image</a>::<wbr><a href='index.html'>tiff</a>::<wbr><a class="struct" href=''>TIFFDecoder</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/tiff.rs.html#17-21' title='goto source code'>[src]</a></span></h1><div class="docblock type-decl"><pre class='rust struct'>pub struct TIFFDecoder<R> <span class="where fmt-newline">where<br> 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>, </span> { /* fields omitted */ }</pre></div><div class='docblock'><p>Decoder for TIFF images.</p>
|
||
</div><h2 id='methods' class='small-section-header'>Methods<a href='#methods' class='anchor'></a></h2><h3 id='impl' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl<R> <a class="struct" href="../../image/tiff/struct.TIFFDecoder.html" title="struct image::tiff::TIFFDecoder">TIFFDecoder</a><R> <span class="where fmt-newline">where<br> 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>, </span></code><a href='#impl' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/image/tiff.rs.html#23-30' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.new' class="method"><span id='new.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.new' class='fnname'>new</a>(r: R) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="../../image/tiff/struct.TIFFDecoder.html" title="struct image::tiff::TIFFDecoder">TIFFDecoder</a><R>, <a class="enum" href="../../image/enum.ImageError.html" title="enum image::ImageError">ImageError</a>></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/image/tiff.rs.html#27-29' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Create a new TIFFDecoder.</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-ImageDecoder' class='impl'><span class='in-band'><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>> <a class="trait" href="../../image/trait.ImageDecoder.html" title="trait image::ImageDecoder">ImageDecoder</a> for <a class="struct" href="../../image/tiff/struct.TIFFDecoder.html" title="struct image::tiff::TIFFDecoder">TIFFDecoder</a><R></code><a href='#impl-ImageDecoder' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/image/tiff.rs.html#64-84' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.dimensions' class="method"><span id='dimensions.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../image/trait.ImageDecoder.html#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></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/image/tiff.rs.html#65-67' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Returns a tuple containing the width and height of the image</p>
|
||
</div><h4 id='method.colortype' class="method"><span id='colortype.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../image/trait.ImageDecoder.html#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></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/image/tiff.rs.html#69-71' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Returns the color type of the image e.g. RGB(8) (8bit RGB)</p>
|
||
</div><h4 id='method.row_len' class="method"><span id='row_len.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../image/trait.ImageDecoder.html#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></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/image/tiff.rs.html#73-75' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Returns the length in bytes of one decoded row of the image</p>
|
||
</div><h4 id='method.read_scanline' class="method"><span id='read_scanline.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../image/trait.ImageDecoder.html#tymethod.read_scanline' class='fnname'>read_scanline</a>(&mut self, _: <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></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/image/tiff.rs.html#77-79' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Reads one row from the image into <code>buf</code> and returns the row index</p>
|
||
</div><h4 id='method.read_image' class="method"><span id='read_image.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../image/trait.ImageDecoder.html#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></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/image/tiff.rs.html#81-83' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Decodes the entire image and return it as a Vector</p>
|
||
</div><h4 id='method.is_animated' class="method"><span id='is_animated.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../image/trait.ImageDecoder.html#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></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/image/image.rs.html#224-228' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Returns true if the image is animated</p>
|
||
</div><h4 id='method.into_frames' class="method"><span id='into_frames.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../image/trait.ImageDecoder.html#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></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/image/image.rs.html#234-238' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Returns the frames of the image <a href="../../image/trait.ImageDecoder.html#method.into_frames">Read more</a></p>
|
||
</div><h4 id='method.load_rect' class="method"><span id='load_rect.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../image/trait.ImageDecoder.html#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></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/image/image.rs.html#242-279' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><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> <a href="../../image/trait.ImageDecoder.html#method.load_rect">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'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl<R> <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/tiff/struct.TIFFDecoder.html" title="struct image::tiff::TIFFDecoder">TIFFDecoder</a><R> <span class="where fmt-newline">where<br> R: <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></span></td><td><span class='out-of-band'></span></td></tr></tbody></table></h3><div class='impl-items'></div><h3 id='impl-Sync' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl<R> <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/tiff/struct.TIFFDecoder.html" title="struct image::tiff::TIFFDecoder">TIFFDecoder</a><R> <span class="where fmt-newline">where<br> R: <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></span></td><td><span class='out-of-band'></span></td></tr></tbody></table></h3><div class='impl-items'></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> |