2017-07-14 23:24:09 +00:00
|
|
|
|
<!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">
|
2017-07-14 23:30:16 +00:00
|
|
|
|
<meta name="description" content="API documentation for the Rust `chunk` mod in crate `png`.">
|
|
|
|
|
|
<meta name="keywords" content="rust, rustlang, rust-lang, chunk">
|
2017-07-14 23:24:09 +00:00
|
|
|
|
|
2017-07-14 23:30:16 +00:00
|
|
|
|
<title>png::chunk - Rust</title>
|
2017-07-14 23:24:09 +00:00
|
|
|
|
|
|
|
|
|
|
<link rel="stylesheet" type="text/css" href="../../normalize.css">
|
|
|
|
|
|
<link rel="stylesheet" type="text/css" href="../../rustdoc.css">
|
|
|
|
|
|
<link rel="stylesheet" type="text/css" href="../../main.css">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</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">
|
|
|
|
|
|
|
2017-07-14 23:30:16 +00:00
|
|
|
|
<p class='location'>Module chunk</p><div class="block items"><ul><li><a href="#constants">Constants</a></li><li><a href="#functions">Functions</a></li><li><a href="#types">Type Definitions</a></li></ul></div><p class='location'><a href='../index.html'>png</a></p><script>window.sidebarCurrent = {name: 'chunk', ty: 'mod', relpath: '../'};</script><script defer src="../sidebar-items.js"></script>
|
2017-07-14 23:24:09 +00:00
|
|
|
|
</nav>
|
|
|
|
|
|
|
|
|
|
|
|
<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">
|
|
|
|
|
|
</div>
|
|
|
|
|
|
</form>
|
|
|
|
|
|
</nav>
|
|
|
|
|
|
|
|
|
|
|
|
<section id='main' class="content">
|
2017-07-14 23:30:16 +00:00
|
|
|
|
<h1 class='fqn'><span class='in-band'>Module <a href='../index.html'>png</a>::<wbr><a class="mod" href=''>chunk</a></span><span class='out-of-band'><span id='render-detail'>
|
2017-07-14 23:24:09 +00:00
|
|
|
|
<a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">
|
|
|
|
|
|
[<span class='inner'>−</span>]
|
|
|
|
|
|
</a>
|
2017-07-14 23:30:16 +00:00
|
|
|
|
</span><a class='srclink' href='../../src/png/chunk.rs.html#1-59' title='goto source code'>[src]</a></span></h1>
|
|
|
|
|
|
<div class='docblock'><p>Chunk types and functions</p>
|
|
|
|
|
|
</div><h2 id='constants' class='section-header'><a href="#constants">Constants</a></h2>
|
2017-07-14 23:24:09 +00:00
|
|
|
|
<table>
|
|
|
|
|
|
<tr class=' module-item'>
|
2017-07-14 23:30:16 +00:00
|
|
|
|
<td><a class="constant" href="constant.IDAT.html"
|
|
|
|
|
|
title='constant png::chunk::IDAT'>IDAT</a></td>
|
2017-07-14 23:24:09 +00:00
|
|
|
|
<td class='docblock-short'>
|
2017-07-14 23:30:16 +00:00
|
|
|
|
<p>Image data</p>
|
2017-07-14 23:24:09 +00:00
|
|
|
|
</td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
<tr class=' module-item'>
|
2017-07-14 23:30:16 +00:00
|
|
|
|
<td><a class="constant" href="constant.IEND.html"
|
|
|
|
|
|
title='constant png::chunk::IEND'>IEND</a></td>
|
2017-07-14 23:24:09 +00:00
|
|
|
|
<td class='docblock-short'>
|
2017-07-14 23:30:16 +00:00
|
|
|
|
<p>Image trailer</p>
|
2017-07-14 23:24:09 +00:00
|
|
|
|
</td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
<tr class=' module-item'>
|
2017-07-14 23:30:16 +00:00
|
|
|
|
<td><a class="constant" href="constant.IHDR.html"
|
|
|
|
|
|
title='constant png::chunk::IHDR'>IHDR</a></td>
|
2017-07-14 23:24:09 +00:00
|
|
|
|
<td class='docblock-short'>
|
2017-07-14 23:30:16 +00:00
|
|
|
|
<p>Image header</p>
|
2017-07-14 23:24:09 +00:00
|
|
|
|
</td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
<tr class=' module-item'>
|
2017-07-14 23:30:16 +00:00
|
|
|
|
<td><a class="constant" href="constant.PLTE.html"
|
|
|
|
|
|
title='constant png::chunk::PLTE'>PLTE</a></td>
|
2017-07-14 23:24:09 +00:00
|
|
|
|
<td class='docblock-short'>
|
2017-07-14 23:30:16 +00:00
|
|
|
|
<p>Palette</p>
|
2017-07-14 23:24:09 +00:00
|
|
|
|
</td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
<tr class=' module-item'>
|
2017-07-14 23:30:16 +00:00
|
|
|
|
<td><a class="constant" href="constant.acTL.html"
|
|
|
|
|
|
title='constant png::chunk::acTL'>acTL</a></td>
|
2017-07-14 23:24:09 +00:00
|
|
|
|
<td class='docblock-short'>
|
2017-07-14 23:30:16 +00:00
|
|
|
|
<p>Animation control</p>
|
2017-07-14 23:24:09 +00:00
|
|
|
|
</td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
<tr class=' module-item'>
|
2017-07-14 23:30:16 +00:00
|
|
|
|
<td><a class="constant" href="constant.bKGD.html"
|
|
|
|
|
|
title='constant png::chunk::bKGD'>bKGD</a></td>
|
2017-07-14 23:24:09 +00:00
|
|
|
|
<td class='docblock-short'>
|
2017-07-14 23:30:16 +00:00
|
|
|
|
<p>Background colour</p>
|
2017-07-14 23:24:09 +00:00
|
|
|
|
</td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
<tr class=' module-item'>
|
2017-07-14 23:30:16 +00:00
|
|
|
|
<td><a class="constant" href="constant.fcTL.html"
|
|
|
|
|
|
title='constant png::chunk::fcTL'>fcTL</a></td>
|
2017-07-14 23:24:09 +00:00
|
|
|
|
<td class='docblock-short'>
|
2017-07-14 23:30:16 +00:00
|
|
|
|
<p>Frame control</p>
|
2017-07-14 23:24:09 +00:00
|
|
|
|
</td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
<tr class=' module-item'>
|
2017-07-14 23:30:16 +00:00
|
|
|
|
<td><a class="constant" href="constant.fdAT.html"
|
|
|
|
|
|
title='constant png::chunk::fdAT'>fdAT</a></td>
|
2017-07-14 23:24:09 +00:00
|
|
|
|
<td class='docblock-short'>
|
2017-07-14 23:30:16 +00:00
|
|
|
|
<p>Frame data</p>
|
2017-07-14 23:24:09 +00:00
|
|
|
|
</td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
<tr class=' module-item'>
|
2017-07-14 23:30:16 +00:00
|
|
|
|
<td><a class="constant" href="constant.pHYs.html"
|
|
|
|
|
|
title='constant png::chunk::pHYs'>pHYs</a></td>
|
2017-07-14 23:24:09 +00:00
|
|
|
|
<td class='docblock-short'>
|
2017-07-14 23:30:16 +00:00
|
|
|
|
<p>Physical pixel dimensions</p>
|
2017-07-14 23:24:09 +00:00
|
|
|
|
</td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
<tr class=' module-item'>
|
2017-07-14 23:30:16 +00:00
|
|
|
|
<td><a class="constant" href="constant.tIME.html"
|
|
|
|
|
|
title='constant png::chunk::tIME'>tIME</a></td>
|
2017-07-14 23:24:09 +00:00
|
|
|
|
<td class='docblock-short'>
|
2017-07-14 23:30:16 +00:00
|
|
|
|
<p>Image last-modification time</p>
|
2017-07-14 23:24:09 +00:00
|
|
|
|
</td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
<tr class=' module-item'>
|
2017-07-14 23:30:16 +00:00
|
|
|
|
<td><a class="constant" href="constant.tRNS.html"
|
|
|
|
|
|
title='constant png::chunk::tRNS'>tRNS</a></td>
|
|
|
|
|
|
<td class='docblock-short'>
|
|
|
|
|
|
<p>Transparency</p>
|
|
|
|
|
|
</td>
|
|
|
|
|
|
</tr></table><h2 id='functions' class='section-header'><a href="#functions">Functions</a></h2>
|
|
|
|
|
|
<table>
|
|
|
|
|
|
<tr class=' module-item'>
|
|
|
|
|
|
<td><a class="fn" href="fn.is_critical.html"
|
|
|
|
|
|
title='fn png::chunk::is_critical'>is_critical</a></td>
|
2017-07-14 23:24:09 +00:00
|
|
|
|
<td class='docblock-short'>
|
2017-07-14 23:30:16 +00:00
|
|
|
|
<p>Returns true if the chunk is critical.</p>
|
2017-07-14 23:24:09 +00:00
|
|
|
|
</td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
<tr class=' module-item'>
|
2017-07-14 23:30:16 +00:00
|
|
|
|
<td><a class="fn" href="fn.is_private.html"
|
|
|
|
|
|
title='fn png::chunk::is_private'>is_private</a></td>
|
2017-07-14 23:24:09 +00:00
|
|
|
|
<td class='docblock-short'>
|
2017-07-14 23:30:16 +00:00
|
|
|
|
<p>Returns true if the chunk is private.</p>
|
2017-07-14 23:24:09 +00:00
|
|
|
|
</td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
<tr class=' module-item'>
|
2017-07-14 23:30:16 +00:00
|
|
|
|
<td><a class="fn" href="fn.reserved_set.html"
|
|
|
|
|
|
title='fn png::chunk::reserved_set'>reserved_set</a></td>
|
2017-07-14 23:24:09 +00:00
|
|
|
|
<td class='docblock-short'>
|
2017-07-14 23:30:16 +00:00
|
|
|
|
<p>Checks whether the reserved bit of the chunk name is set.
|
|
|
|
|
|
If it is set the chunk name is invalid.</p>
|
2017-07-14 23:24:09 +00:00
|
|
|
|
</td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
<tr class=' module-item'>
|
2017-07-14 23:30:16 +00:00
|
|
|
|
<td><a class="fn" href="fn.safe_to_copy.html"
|
|
|
|
|
|
title='fn png::chunk::safe_to_copy'>safe_to_copy</a></td>
|
|
|
|
|
|
<td class='docblock-short'>
|
|
|
|
|
|
<p>Returns true if the chunk is safe to copy if unknown.</p>
|
|
|
|
|
|
</td>
|
|
|
|
|
|
</tr></table><h2 id='types' class='section-header'><a href="#types">Type Definitions</a></h2>
|
|
|
|
|
|
<table>
|
|
|
|
|
|
<tr class=' module-item'>
|
|
|
|
|
|
<td><a class="type" href="type.ChunkType.html"
|
|
|
|
|
|
title='type png::chunk::ChunkType'>ChunkType</a></td>
|
2017-07-14 23:24:09 +00:00
|
|
|
|
<td class='docblock-short'>
|
2017-07-14 23:30:16 +00:00
|
|
|
|
|
2017-07-14 23:24:09 +00:00
|
|
|
|
</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>?</dt>
|
|
|
|
|
|
<dd>Show this help dialog</dd>
|
|
|
|
|
|
<dt>S</dt>
|
|
|
|
|
|
<dd>Focus the search field</dd>
|
|
|
|
|
|
<dt>⇤</dt>
|
|
|
|
|
|
<dd>Move up in search results</dd>
|
|
|
|
|
|
<dt>⇥</dt>
|
|
|
|
|
|
<dd>Move down in search results</dd>
|
|
|
|
|
|
<dt>⏎</dt>
|
|
|
|
|
|
<dd>Go to active search result</dd>
|
|
|
|
|
|
<dt>+</dt>
|
|
|
|
|
|
<dd>Collapse/expand 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>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
</aside>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<script>
|
|
|
|
|
|
window.rootPath = "../../";
|
2017-07-14 23:30:16 +00:00
|
|
|
|
window.currentCrate = "png";
|
2017-07-14 23:24:09 +00:00
|
|
|
|
</script>
|
|
|
|
|
|
<script src="../../main.js"></script>
|
|
|
|
|
|
<script defer src="../../search-index.js"></script>
|
|
|
|
|
|
</body>
|
|
|
|
|
|
</html>
|
