<!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="Source to the Rust file `/home/mrh/.cargo/registry/src/github.com-1ecc6299db9ec823/gif-0.10.2/src/lib.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>lib.rs.html -- source</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><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="shortcut icon" href="../../favicon.ico"><style type="text/css">#crate-search{background-image:url("../../down-arrow.svg");}</style></head><body class="rustdoc source"><!--[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><a href='../../gif/index.html'><div class='logo-container'><img src='../../rust-logo.png' alt='logo'></div></a></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"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><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"><pre class="line-numbers"><span id="1"> 1</span>
<span id="2"> 2</span>
<span id="3"> 3</span>
<span id="4"> 4</span>
<span id="5"> 5</span>
<span id="6"> 6</span>
<span id="7"> 7</span>
<span id="8"> 8</span>
<span id="9"> 9</span>
<span id="10"> 10</span>
<span id="11"> 11</span>
<span id="12"> 12</span>
<span id="13"> 13</span>
<span id="14"> 14</span>
<span id="15"> 15</span>
<span id="16"> 16</span>
<span id="17"> 17</span>
<span id="18"> 18</span>
<span id="19"> 19</span>
<span id="20"> 20</span>
<span id="21"> 21</span>
<span id="22"> 22</span>
<span id="23"> 23</span>
<span id="24"> 24</span>
<span id="25"> 25</span>
<span id="26"> 26</span>
<span id="27"> 27</span>
<span id="28"> 28</span>
<span id="29"> 29</span>
<span id="30"> 30</span>
<span id="31"> 31</span>
<span id="32"> 32</span>
<span id="33"> 33</span>
<span id="34"> 34</span>
<span id="35"> 35</span>
<span id="36"> 36</span>
<span id="37"> 37</span>
<span id="38"> 38</span>
<span id="39"> 39</span>
<span id="40"> 40</span>
<span id="41"> 41</span>
<span id="42"> 42</span>
<span id="43"> 43</span>
<span id="44"> 44</span>
<span id="45"> 45</span>
<span id="46"> 46</span>
<span id="47"> 47</span>
<span id="48"> 48</span>
<span id="49"> 49</span>
<span id="50"> 50</span>
<span id="51"> 51</span>
<span id="52"> 52</span>
<span id="53"> 53</span>
<span id="54"> 54</span>
<span id="55"> 55</span>
<span id="56"> 56</span>
<span id="57"> 57</span>
<span id="58"> 58</span>
<span id="59"> 59</span>
<span id="60"> 60</span>
<span id="61"> 61</span>
<span id="62"> 62</span>
<span id="63"> 63</span>
<span id="64"> 64</span>
<span id="65"> 65</span>
<span id="66"> 66</span>
<span id="67"> 67</span>
<span id="68"> 68</span>
<span id="69"> 69</span>
<span id="70"> 70</span>
<span id="71"> 71</span>
<span id="72"> 72</span>
<span id="73"> 73</span>
<span id="74"> 74</span>
<span id="75"> 75</span>
<span id="76"> 76</span>
<span id="77"> 77</span>
<span id="78"> 78</span>
<span id="79"> 79</span>
<span id="80"> 80</span>
<span id="81"> 81</span>
<span id="82"> 82</span>
<span id="83"> 83</span>
<span id="84"> 84</span>
<span id="85"> 85</span>
<span id="86"> 86</span>
<span id="87"> 87</span>
<span id="88"> 88</span>
<span id="89"> 89</span>
<span id="90"> 90</span>
<span id="91"> 91</span>
<span id="92"> 92</span>
<span id="93"> 93</span>
<span id="94"> 94</span>
<span id="95"> 95</span>
<span id="96"> 96</span>
<span id="97"> 97</span>
<span id="98"> 98</span>
<span id="99"> 99</span>
<span id="100">100</span>
<span id="101">101</span>
<span id="102">102</span>
<span id="103">103</span>
<span id="104">104</span>
<span id="105">105</span>
<span id="106">106</span>
<span id="107">107</span>
<span id="108">108</span>
<span id="109">109</span>
<span id="110">110</span>
<span id="111">111</span>
<span id="112">112</span>
<span id="113">113</span>
<span id="114">114</span>
<span id="115">115</span>
<span id="116">116</span>
<span id="117">117</span>
<span id="118">118</span>
<span id="119">119</span>
<span id="120">120</span>
<span id="121">121</span>
<span id="122">122</span>
<span id="123">123</span>
<span id="124">124</span>
<span id="125">125</span>
<span id="126">126</span>
<span id="127">127</span>
<span id="128">128</span>
<span id="129">129</span>
<span id="130">130</span>
<span id="131">131</span>
<span id="132">132</span>
<span id="133">133</span>
<span id="134">134</span>
<span id="135">135</span>
<span id="136">136</span>
<span id="137">137</span>
<span id="138">138</span>
<span id="139">139</span>
<span id="140">140</span>
<span id="141">141</span>
<span id="142">142</span>
<span id="143">143</span>
<span id="144">144</span>
<span id="145">145</span>
<span id="146">146</span>
<span id="147">147</span>
<span id="148">148</span>
<span id="149">149</span>
<span id="150">150</span>
<span id="151">151</span>
<span id="152">152</span>
<span id="153">153</span>
<span id="154">154</span>
<span id="155">155</span>
<span id="156">156</span>
<span id="157">157</span>
<span id="158">158</span>
<span id="159">159</span>
<span id="160">160</span>
<span id="161">161</span>
<span id="162">162</span>
<span id="163">163</span>
</pre><div class="example-wrap"><pre class="rust ">
<span class="doccomment">//! # GIF en- and decoding library [](https://travis-ci.org/PistonDevelopers/image-gif)</span>
<span class="doccomment">//! </span>
<span class="doccomment">//! GIF en- and decoder written in Rust ([API Documentation](http://www.piston.rs/image/gif/index.html)). </span>
<span class="doccomment">//! </span>
<span class="doccomment">//! # GIF encoding and decoding library</span>
<span class="doccomment">//! </span>
<span class="doccomment">//! This library provides all functions necessary to de- and encode GIF files. </span>
<span class="doccomment">//! </span>
<span class="doccomment">//! ## High level interface</span>
<span class="doccomment">//! </span>
<span class="doccomment">//! The high level interface consists of the two types</span>
<span class="doccomment">//! [`Encoder`](struct.Encoder.html) and [`Decoder`](struct.Decoder.html).</span>
<span class="doccomment">//! They as builders for the actual en- and decoders and can be used to set various</span>
<span class="doccomment">//! options beforehand.</span>
<span class="doccomment">//! </span>
<span class="doccomment">//! ### Decoding GIF files</span>
<span class="doccomment">//! </span>
<span class="doccomment">//! ```rust</span>
<span class="doccomment">//! // Open the file</span>
<span class="doccomment">//! use std::fs::File;</span>
<span class="doccomment">//! use gif::SetParameter;</span>
<span class="doccomment">//! let mut decoder = gif::Decoder::new(File::open("tests/samples/sample_1.gif").unwrap());</span>
<span class="doccomment">//! // Configure the decoder such that it will expand the image to RGBA.</span>
<span class="doccomment">//! decoder.set(gif::ColorOutput::RGBA);</span>
<span class="doccomment">//! // Read the file header</span>
<span class="doccomment">//! let mut decoder = decoder.read_info().unwrap();</span>
<span class="doccomment">//! while let Some(frame) = decoder.read_next_frame().unwrap() {</span>
<span class="doccomment">//! // Process every frame</span>
<span class="doccomment">//! }</span>
<span class="doccomment">//! ```</span>
<span class="doccomment">//! </span>
<span class="doccomment">//! </span>
<span class="doccomment">//! </span>
<span class="doccomment">//! ### Encoding GIF files</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! The encoder can be used so save simple computer generated images:</span>
<span class="doccomment">//! </span>
<span class="doccomment">//! ```rust</span>
<span class="doccomment">//! use gif::{Frame, Encoder, Repeat, SetParameter};</span>
<span class="doccomment">//! use std::fs::File;</span>
<span class="doccomment">//! use std::borrow::Cow;</span>
<span class="doccomment">//! </span>
<span class="doccomment">//! let color_map = &[0xFF, 0xFF, 0xFF, 0, 0, 0];</span>
<span class="doccomment">//! let (width, height) = (6, 6);</span>
<span class="doccomment">//! let mut beacon_states = [[</span>
<span class="doccomment">//! 0, 0, 0, 0, 0, 0,</span>
<span class="doccomment">//! 0, 1, 1, 0, 0, 0,</span>
<span class="doccomment">//! 0, 1, 1, 0, 0, 0,</span>
<span class="doccomment">//! 0, 0, 0, 1, 1, 0,</span>
<span class="doccomment">//! 0, 0, 0, 1, 1, 0,</span>
<span class="doccomment">//! 0, 0, 0, 0, 0, 0,</span>
<span class="doccomment">//! ], [</span>
<span class="doccomment">//! 0, 0, 0, 0, 0, 0,</span>
<span class="doccomment">//! 0, 1, 1, 0, 0, 0,</span>
<span class="doccomment">//! 0, 1, 0, 0, 0, 0,</span>
<span class="doccomment">//! 0, 0, 0, 0, 1, 0,</span>
<span class="doccomment">//! 0, 0, 0, 1, 1, 0,</span>
<span class="doccomment">//! 0, 0, 0, 0, 0, 0,</span>
<span class="doccomment">//! ]];</span>
<span class="doccomment">//! let mut image = File::create("tests/samples/beacon.gif").unwrap();;</span>
<span class="doccomment">//! let mut encoder = Encoder::new(&mut image, width, height, color_map).unwrap();</span>
<span class="doccomment">//! encoder.set(Repeat::Infinite).unwrap();</span>
<span class="doccomment">//! for state in &beacon_states {</span>
<span class="doccomment">//! let mut frame = Frame::default();</span>
<span class="doccomment">//! frame.width = width;</span>
<span class="doccomment">//! frame.height = height;</span>
<span class="doccomment">//! frame.buffer = Cow::Borrowed(&*state);</span>
<span class="doccomment">//! encoder.write_frame(&frame).unwrap();</span>
<span class="doccomment">//! }</span>
<span class="doccomment">//! ```</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! [`Frame::from_*`](struct.Frame.html) can be used to convert a true color image to a paletted</span>
<span class="doccomment">//! image with a maximum of 256 colors:</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! ```rust</span>
<span class="doccomment">//! use std::fs::File;</span>
<span class="doccomment">//! </span>
<span class="doccomment">//! // Get pixel data from some source</span>
<span class="doccomment">//! let mut pixels: Vec<u8> = vec![0; 30_000];</span>
<span class="doccomment">//! // Create frame from data</span>
<span class="doccomment">//! let frame = gif::Frame::from_rgb(100, 100, &mut *pixels);</span>
<span class="doccomment">//! // Create encoder</span>
<span class="doccomment">//! let mut image = File::create("target/indexed_color.gif").unwrap();</span>
<span class="doccomment">//! let mut encoder = gif::Encoder::new(&mut image, frame.width, frame.height, &[]).unwrap();</span>
<span class="doccomment">//! // Write frame to file</span>
<span class="doccomment">//! encoder.write_frame(&frame).unwrap();</span>
<span class="doccomment">//! ```</span>
<span class="doccomment">//! </span>
<span class="doccomment">//! ## C API</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! The C API is unstable and widely untested. It can be activated using the feature flag `c_api`.</span>
<span class="comment">// TODO: make this compile</span>
<span class="comment">// ```rust</span>
<span class="comment">// use gif::{Frame, Encoder};</span>
<span class="comment">// use std::fs::File;</span>
<span class="comment">// let color_map = &[0, 0, 0, 0xFF, 0xFF, 0xFF];</span>
<span class="comment">// let mut frame = Frame::default();</span>
<span class="comment">// // Generate checkerboard lattice</span>
<span class="comment">// for (i, j) in (0..10).zip(0..10) {</span>
<span class="comment">// frame.buffer.push(if (i * j) % 2 == 0 {</span>
<span class="comment">// 1</span>
<span class="comment">// } else {</span>
<span class="comment">// 0</span>
<span class="comment">// })</span>
<span class="comment">// }</span>
<span class="comment">// # (|| {</span>
<span class="comment">// {</span>
<span class="comment">// let mut file = File::create("test.gif")?;</span>
<span class="comment">// let mut encoder = Encoder::new(&mut file, 100, 100);</span>
<span class="comment">// encoder.write_global_palette(color_map)?.write_frame(&frame)</span>
<span class="comment">// }</span>
<span class="comment">// # })().unwrap();</span>
<span class="comment">// ```</span>
<span class="attribute">#![<span class="ident">deny</span>(<span class="ident">missing_docs</span>)]</span>
<span class="comment">// Uncomment to run tests</span>
<span class="comment">//#![cfg_attr(test, feature(test))]</span>
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"c_api"</span>)]</span>
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">libc</span>;
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">lzw</span>;
<span class="kw">mod</span> <span class="ident">traits</span>;
<span class="kw">mod</span> <span class="ident">common</span>;
<span class="kw">mod</span> <span class="ident">util</span>;
<span class="kw">mod</span> <span class="ident">reader</span>;
<span class="kw">mod</span> <span class="ident">encoder</span>;
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"c_api"</span>)]</span>
<span class="kw">mod</span> <span class="ident">c_api_utils</span>;
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"c_api"</span>)]</span>
<span class="kw">pub</span> <span class="kw">mod</span> <span class="ident">c_api</span>;
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">traits</span>::{<span class="ident">SetParameter</span>, <span class="ident">Parameter</span>};
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">common</span>::{<span class="ident">Block</span>, <span class="ident">Extension</span>, <span class="ident">DisposalMethod</span>, <span class="ident">Frame</span>};
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">reader</span>::{<span class="ident">StreamingDecoder</span>, <span class="ident">Decoded</span>, <span class="ident">DecodingError</span>};
<span class="doccomment">/// StreamingDecoder configuration parameters</span>
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">reader</span>::{<span class="ident">ColorOutput</span>, <span class="ident">MemoryLimit</span>, <span class="ident">Extensions</span>};
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">reader</span>::{<span class="ident">Reader</span>, <span class="ident">Decoder</span>};
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">encoder</span>::{<span class="ident">Encoder</span>, <span class="ident">ExtensionData</span>, <span class="ident">Repeat</span>};
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">test</span>)]</span>
<span class="attribute">#[<span class="ident">test</span>]</span>
<span class="kw">fn</span> <span class="ident">round_trip</span>() {
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">io</span>::<span class="ident">prelude</span>::<span class="kw-2">*</span>;
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">fs</span>::<span class="ident">File</span>;
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">data</span> <span class="op">=</span> <span class="macro">vec</span><span class="macro">!</span>[];
<span class="ident">File</span>::<span class="ident">open</span>(<span class="string">"tests/samples/sample_1.gif"</span>).<span class="ident">unwrap</span>().<span class="ident">read_to_end</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">data</span>).<span class="ident">unwrap</span>();
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">decoder</span> <span class="op">=</span> <span class="ident">Decoder</span>::<span class="ident">new</span>(<span class="kw-2">&</span><span class="kw-2">*</span><span class="ident">data</span>).<span class="ident">read_info</span>().<span class="ident">unwrap</span>();
<span class="kw">let</span> <span class="ident">palette</span>: <span class="ident">Vec</span><span class="op"><</span><span class="ident">u8</span><span class="op">></span> <span class="op">=</span> <span class="ident">decoder</span>.<span class="ident">palette</span>().<span class="ident">unwrap</span>().<span class="ident">into</span>();
<span class="kw">let</span> <span class="ident">frame</span> <span class="op">=</span> <span class="ident">decoder</span>.<span class="ident">read_next_frame</span>().<span class="ident">unwrap</span>().<span class="ident">unwrap</span>();
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">data2</span> <span class="op">=</span> <span class="macro">vec</span><span class="macro">!</span>[];
{
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">encoder</span> <span class="op">=</span> <span class="ident">Encoder</span>::<span class="ident">new</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">data2</span>, <span class="ident">frame</span>.<span class="ident">width</span>, <span class="ident">frame</span>.<span class="ident">height</span>, <span class="kw-2">&</span><span class="ident">palette</span>).<span class="ident">unwrap</span>();
<span class="ident">encoder</span>.<span class="ident">write_frame</span>(<span class="ident">frame</span>).<span class="ident">unwrap</span>();
}
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="kw-2">&</span><span class="ident">data</span>[..], <span class="kw-2">&</span><span class="ident">data2</span>[..])
}</pre></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 = "gif";</script><script src="../../aliases.js"></script><script src="../../main.js"></script><script src="../../source-script.js"></script><script src="../../source-files.js"></script><script defer src="../../search-index.js"></script></body></html>