mirror of
https://github.com/neogeek23/rusty_snek_gaem.git
synced 2026-02-05 11:38:44 +00:00
87 lines
8.5 KiB
HTML
87 lines
8.5 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 `pnm` mod in crate `image`."><meta name="keywords" content="rust, rustlang, rust-lang, pnm"><title>image::pnm - 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 mod"><!--[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'>Module pnm</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li></ul></div><p class='location'><a href='../index.html'>image</a></p><script>window.sidebarCurrent = {name: 'pnm', ty: 'mod', 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'>Module <a href='../index.html'>image</a>::<wbr><a class="mod" href=''>pnm</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/mod.rs.html#1-160' title='goto source code'>[src]</a></span></h1><div class='docblock'><p>Decoding of netpbm image formats (pbm, pgm, ppm and pam).</p>
|
||
<p>The formats pbm, pgm and ppm are fully supported. The pam decoder recognizes the tuple types
|
||
<code>BLACKANDWHITE</code>, <code>GRAYSCALE</code> and <code>RGB</code> and explicitely recognizes but rejects their <code>_ALPHA</code>
|
||
variants for now as alpha color types are unsupported.</p>
|
||
</div><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
|
||
<table>
|
||
<tr class=' module-item'>
|
||
<td><a class="struct" href="struct.ArbitraryHeader.html"
|
||
title='struct image::pnm::ArbitraryHeader'>ArbitraryHeader</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Header produced by a <code>pam</code> file ("Portable Arbitrary Map")</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="struct" href="struct.BitmapHeader.html"
|
||
title='struct image::pnm::BitmapHeader'>BitmapHeader</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Header produced by a <code>pbm</code> file ("Portable Bit Map")</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="struct" href="struct.GraymapHeader.html"
|
||
title='struct image::pnm::GraymapHeader'>GraymapHeader</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Header produced by a <code>pgm</code> file ("Portable Gray Map")</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="struct" href="struct.PNMDecoder.html"
|
||
title='struct image::pnm::PNMDecoder'>PNMDecoder</a></td>
|
||
<td class='docblock-short'>
|
||
<p>PNM decoder</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="struct" href="struct.PNMEncoder.html"
|
||
title='struct image::pnm::PNMEncoder'>PNMEncoder</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Encodes images to any of the <code>pnm</code> image formats.</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="struct" href="struct.PNMHeader.html"
|
||
title='struct image::pnm::PNMHeader'>PNMHeader</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Stores the complete header data of a file.</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="struct" href="struct.PixmapHeader.html"
|
||
title='struct image::pnm::PixmapHeader'>PixmapHeader</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Header produced by a <code>ppm</code> file ("Portable Pixel Map")</p>
|
||
|
||
</td>
|
||
</tr></table><h2 id='enums' class='section-header'><a href="#enums">Enums</a></h2>
|
||
<table>
|
||
<tr class=' module-item'>
|
||
<td><a class="enum" href="enum.ArbitraryTuplType.html"
|
||
title='enum image::pnm::ArbitraryTuplType'>ArbitraryTuplType</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Standardized tuple type specifiers in the header of a <code>pam</code>.</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="enum" href="enum.PNMSubtype.html"
|
||
title='enum image::pnm::PNMSubtype'>PNMSubtype</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Denotes the category of the magic number</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="enum" href="enum.SampleEncoding.html"
|
||
title='enum image::pnm::SampleEncoding'>SampleEncoding</a></td>
|
||
<td class='docblock-short'>
|
||
<p>The kind of encoding used to store sample values</p>
|
||
|
||
</td>
|
||
</tr></table></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> |