mirror of
https://github.com/neogeek23/rusty_snek_gaem.git
synced 2026-02-05 11:38:44 +00:00
22 lines
18 KiB
HTML
22 lines
18 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 `HDRDecoder` struct in crate `image`."><meta name="keywords" content="rust, rustlang, rust-lang, HDRDecoder"><title>image::hdr::HDRDecoder - 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 HDRDecoder</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><a href="#method.with_strictness">with_strictness</a><a href="#method.metadata">metadata</a><a href="#method.read_image_native">read_image_native</a><a href="#method.read_image_transform">read_image_transform</a><a href="#method.read_image_ldr">read_image_ldr</a><a href="#method.read_image_hdr">read_image_hdr</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Debug">Debug</a><a href="#impl-IntoIterator">IntoIterator</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'>hdr</a></p><script>window.sidebarCurrent = {name: 'HDRDecoder', 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'>hdr</a>::<wbr><a class="struct" href=''>HDRDecoder</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/hdr/hdr_decoder.rs.html#87-92' title='goto source code'>[src]</a></span></h1><div class="docblock type-decl"><pre class='rust struct'>pub struct HDRDecoder<R> { /* fields omitted */ }</pre></div><div class='docblock'><p>An Radiance HDR decoder</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="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.BufRead.html" title="trait std::io::BufRead">BufRead</a>> <a class="struct" href="../../image/hdr/struct.HDRDecoder.html" title="struct image::hdr::HDRDecoder">HDRDecoder</a><R></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/hdr/hdr_decoder.rs.html#174-337' 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>(reader: R) -> <a class="type" href="../../image/type.ImageResult.html" title="type image::ImageResult">ImageResult</a><<a class="struct" href="../../image/hdr/struct.HDRDecoder.html" title="struct image::hdr::HDRDecoder">HDRDecoder</a><R>></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/image/hdr/hdr_decoder.rs.html#178-180' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Reads Radiance HDR image header from stream <code>r</code>
|
||
if the header is valid, creates HDRDecoder
|
||
strict mode is enabled</p>
|
||
</div><h4 id='method.with_strictness' class="method"><span id='with_strictness.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.with_strictness' class='fnname'>with_strictness</a>(reader: R, strict: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>) -> <a class="type" href="../../image/type.ImageResult.html" title="type image::ImageResult">ImageResult</a><<a class="struct" href="../../image/hdr/struct.HDRDecoder.html" title="struct image::hdr::HDRDecoder">HDRDecoder</a><R>></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/image/hdr/hdr_decoder.rs.html#189-255' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Reads Radiance HDR image header from stream <code>reader</code>,
|
||
if the header is valid, creates <code>HDRDecoder</code>.</p>
|
||
<p>strict enables strict mode</p>
|
||
<p>Warning! Reading wrong file in non-strict mode
|
||
could consume file size worth of memory in the process.</p>
|
||
</div><h4 id='method.metadata' class="method"><span id='metadata.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.metadata' class='fnname'>metadata</a>(&self) -> <a class="struct" href="../../image/hdr/struct.HDRMetadata.html" title="struct image::hdr::HDRMetadata">HDRMetadata</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/image/hdr/hdr_decoder.rs.html#258-260' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Returns file metadata. Refer to <code>HDRMetadata</code> for details.</p>
|
||
</div><h4 id='method.read_image_native' class="method"><span id='read_image_native.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.read_image_native' class='fnname'>read_image_native</a>(self) -> <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="struct" href="../../image/hdr/struct.RGBE8Pixel.html" title="struct image::hdr::RGBE8Pixel">RGBE8Pixel</a>>></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/image/hdr/hdr_decoder.rs.html#263-279' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Consumes decoder and returns a vector of RGBE8 pixels</p>
|
||
</div><h4 id='method.read_image_transform' class="method"><span id='read_image_transform.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.read_image_transform' class='fnname'>read_image_transform</a><T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>, F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.Fn.html" title="trait core::ops::function::Fn">Fn</a>(<a class="struct" href="../../image/hdr/struct.RGBE8Pixel.html" title="struct image::hdr::RGBE8Pixel">RGBE8Pixel</a>) -> T>(<br> self, <br> f: F<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><T>></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/image/hdr/hdr_decoder.rs.html#282-324' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Consumes decoder and returns a vector of transformed pixels</p>
|
||
</div><h4 id='method.read_image_ldr' class="method"><span id='read_image_ldr.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.read_image_ldr' class='fnname'>read_image_ldr</a>(self) -> <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="struct" href="../../image/struct.Rgb.html" title="struct image::Rgb">Rgb</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/hdr/hdr_decoder.rs.html#328-330' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Consumes decoder and returns a vector of Rgb<u8> pixels.
|
||
scale = 1, gamma = 2.2</p>
|
||
</div><h4 id='method.read_image_hdr' class="method"><span id='read_image_hdr.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.read_image_hdr' class='fnname'>read_image_hdr</a>(self) -> <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="struct" href="../../image/struct.Rgb.html" title="struct image::Rgb">Rgb</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f32.html">f32</a>>>></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/image/hdr/hdr_decoder.rs.html#334-336' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Consumes decoder and returns a vector of Rgb<f32> pixels.</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-Debug' 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/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a>> <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="../../image/hdr/struct.HDRDecoder.html" title="struct image::hdr::HDRDecoder">HDRDecoder</a><R></code><a href='#impl-Debug' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/image/hdr/hdr_decoder.rs.html#86' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.fmt' class="method"><span id='fmt.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt' class='fnname'>fmt</a>(&self, f: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>) -> <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/image/hdr/hdr_decoder.rs.html#86' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></p>
|
||
</div></div><h3 id='impl-IntoIterator' 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.BufRead.html" title="trait std::io::BufRead">BufRead</a>> <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/trait.IntoIterator.html" title="trait core::iter::traits::IntoIterator">IntoIterator</a> for <a class="struct" href="../../image/hdr/struct.HDRDecoder.html" title="struct image::hdr::HDRDecoder">HDRDecoder</a><R></code><a href='#impl-IntoIterator' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/image/hdr/hdr_decoder.rs.html#339-361' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='associatedtype.Item' class="type"><span id='Item.t' class='invisible'><code>type <a href='https://doc.rust-lang.org/nightly/core/iter/traits/trait.IntoIterator.html#associatedtype.Item' class="type">Item</a> = <a class="type" href="../../image/type.ImageResult.html" title="type image::ImageResult">ImageResult</a><<a class="struct" href="../../image/hdr/struct.RGBE8Pixel.html" title="struct image::hdr::RGBE8Pixel">RGBE8Pixel</a>></code></span></h4>
|
||
<div class='docblock'><p>The type of the elements being iterated over.</p>
|
||
</div><h4 id='associatedtype.IntoIter' class="type"><span id='IntoIter.t' class='invisible'><code>type <a href='https://doc.rust-lang.org/nightly/core/iter/traits/trait.IntoIterator.html#associatedtype.IntoIter' class="type">IntoIter</a> = <a class="struct" href="../../image/hdr/struct.HDRImageDecoderIterator.html" title="struct image::hdr::HDRImageDecoderIterator">HDRImageDecoderIterator</a><R></code></span></h4>
|
||
<div class='docblock'><p>Which kind of iterator are we turning this into?</p>
|
||
</div><h4 id='method.into_iter' class="method"><span id='into_iter.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/iter/traits/trait.IntoIterator.html#tymethod.into_iter' class='fnname'>into_iter</a>(self) -> Self::<a class="type" href="https://doc.rust-lang.org/nightly/core/iter/traits/trait.IntoIterator.html#associatedtype.IntoIter" title="type core::iter::traits::IntoIterator::IntoIter">IntoIter</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/image/hdr/hdr_decoder.rs.html#343-360' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Creates an iterator from a value. <a href="https://doc.rust-lang.org/nightly/core/iter/traits/trait.IntoIterator.html#tymethod.into_iter">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/hdr/struct.HDRDecoder.html" title="struct image::hdr::HDRDecoder">HDRDecoder</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/hdr/struct.HDRDecoder.html" title="struct image::hdr::HDRDecoder">HDRDecoder</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> |