mirror of
https://github.com/neogeek23/rusty_snek_gaem.git
synced 2026-02-05 19:48:38 +00:00
25 lines
12 KiB
HTML
25 lines
12 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 `PNMEncoder` struct in crate `image`."><meta name="keywords" content="rust, rustlang, rust-lang, PNMEncoder"><title>image::pnm::PNMEncoder - 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 PNMEncoder</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_subtype">with_subtype</a><a href="#method.with_header">with_header</a><a href="#method.with_dynamic_header">with_dynamic_header</a><a href="#method.encode">encode</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'>pnm</a></p><script>window.sidebarCurrent = {name: 'PNMEncoder', 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'>pnm</a>::<wbr><a class="struct" href=''>PNMEncoder</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/pnm/encoder.rs.html#27-30' title='goto source code'>[src]</a></span></h1><div class="docblock type-decl"><pre class='rust struct'>pub struct PNMEncoder<W: <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Write.html" title="trait std::io::Write">Write</a>> { /* fields omitted */ }</pre></div><div class='docblock'><p>Encodes images to any of the <code>pnm</code> image formats.</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<W: <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Write.html" title="trait std::io::Write">Write</a>> <a class="struct" href="../../image/pnm/struct.PNMEncoder.html" title="struct image::pnm::PNMEncoder">PNMEncoder</a><W></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/pnm/encoder.rs.html#76-270' 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>(writer: W) -> Self</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/image/pnm/encoder.rs.html#82-87' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Create new PNMEncoder from the <code>writer</code>.</p>
|
|||
|
|
<p>The encoded images will have some <code>pnm</code> format. If more control over the image type is
|
|||
|
|
required, use either one of <code>with_subtype</code> or <code>with_header</code>. For more information on the
|
|||
|
|
behaviour, see <code>with_dynamic_header</code>.</p>
|
|||
|
|
</div><h4 id='method.with_subtype' class="method"><span id='with_subtype.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.with_subtype' class='fnname'>with_subtype</a>(self, subtype: <a class="enum" href="../../image/pnm/enum.PNMSubtype.html" title="enum image::pnm::PNMSubtype">PNMSubtype</a>) -> Self</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/image/pnm/encoder.rs.html#96-101' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Encode a specific pnm subtype image.</p>
|
|||
|
|
<p>The magic number and encoding type will be chosen as provided while the rest of the header
|
|||
|
|
data will be generated dynamically. Trying to encode incompatible images (e.g. encoding an
|
|||
|
|
RGB image as Graymap) will result in an error.</p>
|
|||
|
|
<p>This will overwrite the effect of earlier calls to <code>with_header</code> and <code>with_dynamic_header</code>.</p>
|
|||
|
|
</div><h4 id='method.with_header' class="method"><span id='with_header.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.with_header' class='fnname'>with_header</a>(self, header: <a class="struct" href="../../image/pnm/struct.PNMHeader.html" title="struct image::pnm::PNMHeader">PNMHeader</a>) -> Self</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/image/pnm/encoder.rs.html#112-117' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Enforce the use of a chosen header.</p>
|
|||
|
|
<p>While this option gives the most control over the actual written data, the encoding process
|
|||
|
|
will error in case the header data and image parameters do not agree. It is the users
|
|||
|
|
obligation to ensure that the width and height are set accordingly, for example.</p>
|
|||
|
|
<p>Choose this option if you want a lossless decoding/encoding round trip.</p>
|
|||
|
|
<p>This will overwrite the effect of earlier calls to <code>with_subtype</code> and <code>with_dynamic_header</code>.</p>
|
|||
|
|
</div><h4 id='method.with_dynamic_header' class="method"><span id='with_dynamic_header.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.with_dynamic_header' class='fnname'>with_dynamic_header</a>(self) -> Self</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/image/pnm/encoder.rs.html#126-131' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Create the header dynamically for each image.</p>
|
|||
|
|
<p>This is the default option upon creation of the encoder. With this, most images should be
|
|||
|
|
encodable but the specific format chosen is out of the users control. The pnm subtype is
|
|||
|
|
chosen arbitrarily by the library.</p>
|
|||
|
|
<p>This will overwrite the effect of earlier calls to <code>with_subtype</code> and <code>with_header</code>.</p>
|
|||
|
|
</div><h4 id='method.encode' class="method"><span id='encode.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.encode' class='fnname'>encode</a><'s, S>(<br> &mut self, <br> image: S, <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> color: <a class="enum" href="../../image/enum.ColorType.html" title="enum image::ColorType">ColorType</a><br>) -> <a class="type" href="https://doc.rust-lang.org/nightly/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>> <span class="where fmt-newline">where<br> S: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><FlatSamples<'s>>, </span></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/image/pnm/encoder.rs.html#137-157' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Encode an image whose samples are represented as <code>u8</code>.</p>
|
|||
|
|
<p>Some <code>pnm</code> subtypes are incompatible with some color options, a chosen header most
|
|||
|
|
certainly with any deviation from the original decoded image.</p>
|
|||
|
|
</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<W> <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/pnm/struct.PNMEncoder.html" title="struct image::pnm::PNMEncoder">PNMEncoder</a><W> <span class="where fmt-newline">where<br> W: <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<W> <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/pnm/struct.PNMEncoder.html" title="struct image::pnm::PNMEncoder">PNMEncoder</a><W> <span class="where fmt-newline">where<br> W: <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>
|