| <!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 of the Rust file `/root/.cargo/registry/src/github.com-1ecc6299db9ec823/image-0.23.14/./src/lib.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>lib.rs - source</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../../normalize.css"><link rel="stylesheet" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../ayu.css" disabled><link rel="stylesheet" href="../../dark.css" disabled><link rel="stylesheet" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="../../source-script.js"></script><script defer src="../../source-files.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc source"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><a class="sidebar-logo" href="../../image/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a></nav><main><div class="width-limiter"><nav class="sub"><a class="sub-logo-container" href="../../image/index.html"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></a><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="example-wrap"><pre class="src-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> |
| <span id="164">164</span> |
| <span id="165">165</span> |
| <span id="166">166</span> |
| <span id="167">167</span> |
| <span id="168">168</span> |
| <span id="169">169</span> |
| <span id="170">170</span> |
| <span id="171">171</span> |
| <span id="172">172</span> |
| <span id="173">173</span> |
| <span id="174">174</span> |
| <span id="175">175</span> |
| <span id="176">176</span> |
| <span id="177">177</span> |
| <span id="178">178</span> |
| <span id="179">179</span> |
| <span id="180">180</span> |
| <span id="181">181</span> |
| <span id="182">182</span> |
| <span id="183">183</span> |
| <span id="184">184</span> |
| <span id="185">185</span> |
| <span id="186">186</span> |
| <span id="187">187</span> |
| <span id="188">188</span> |
| <span id="189">189</span> |
| <span id="190">190</span> |
| <span id="191">191</span> |
| <span id="192">192</span> |
| <span id="193">193</span> |
| <span id="194">194</span> |
| <span id="195">195</span> |
| <span id="196">196</span> |
| <span id="197">197</span> |
| <span id="198">198</span> |
| <span id="199">199</span> |
| <span id="200">200</span> |
| <span id="201">201</span> |
| <span id="202">202</span> |
| <span id="203">203</span> |
| <span id="204">204</span> |
| <span id="205">205</span> |
| <span id="206">206</span> |
| <span id="207">207</span> |
| <span id="208">208</span> |
| <span id="209">209</span> |
| <span id="210">210</span> |
| <span id="211">211</span> |
| <span id="212">212</span> |
| <span id="213">213</span> |
| <span id="214">214</span> |
| <span id="215">215</span> |
| <span id="216">216</span> |
| <span id="217">217</span> |
| <span id="218">218</span> |
| <span id="219">219</span> |
| <span id="220">220</span> |
| <span id="221">221</span> |
| <span id="222">222</span> |
| <span id="223">223</span> |
| <span id="224">224</span> |
| <span id="225">225</span> |
| <span id="226">226</span> |
| <span id="227">227</span> |
| <span id="228">228</span> |
| <span id="229">229</span> |
| <span id="230">230</span> |
| <span id="231">231</span> |
| <span id="232">232</span> |
| <span id="233">233</span> |
| <span id="234">234</span> |
| <span id="235">235</span> |
| <span id="236">236</span> |
| <span id="237">237</span> |
| <span id="238">238</span> |
| <span id="239">239</span> |
| <span id="240">240</span> |
| <span id="241">241</span> |
| <span id="242">242</span> |
| <span id="243">243</span> |
| <span id="244">244</span> |
| <span id="245">245</span> |
| <span id="246">246</span> |
| <span id="247">247</span> |
| <span id="248">248</span> |
| <span id="249">249</span> |
| <span id="250">250</span> |
| <span id="251">251</span> |
| <span id="252">252</span> |
| <span id="253">253</span> |
| <span id="254">254</span> |
| <span id="255">255</span> |
| <span id="256">256</span> |
| <span id="257">257</span> |
| <span id="258">258</span> |
| <span id="259">259</span> |
| <span id="260">260</span> |
| <span id="261">261</span> |
| <span id="262">262</span> |
| <span id="263">263</span> |
| <span id="264">264</span> |
| <span id="265">265</span> |
| <span id="266">266</span> |
| <span id="267">267</span> |
| <span id="268">268</span> |
| <span id="269">269</span> |
| <span id="270">270</span> |
| <span id="271">271</span> |
| <span id="272">272</span> |
| <span id="273">273</span> |
| <span id="274">274</span> |
| <span id="275">275</span> |
| <span id="276">276</span> |
| <span id="277">277</span> |
| <span id="278">278</span> |
| <span id="279">279</span> |
| <span id="280">280</span> |
| <span id="281">281</span> |
| <span id="282">282</span> |
| <span id="283">283</span> |
| <span id="284">284</span> |
| <span id="285">285</span> |
| <span id="286">286</span> |
| <span id="287">287</span> |
| <span id="288">288</span> |
| <span id="289">289</span> |
| <span id="290">290</span> |
| <span id="291">291</span> |
| <span id="292">292</span> |
| <span id="293">293</span> |
| <span id="294">294</span> |
| <span id="295">295</span> |
| <span id="296">296</span> |
| <span id="297">297</span> |
| <span id="298">298</span> |
| <span id="299">299</span> |
| <span id="300">300</span> |
| <span id="301">301</span> |
| <span id="302">302</span> |
| <span id="303">303</span> |
| <span id="304">304</span> |
| <span id="305">305</span> |
| <span id="306">306</span> |
| <span id="307">307</span> |
| <span id="308">308</span> |
| <span id="309">309</span> |
| <span id="310">310</span> |
| <span id="311">311</span> |
| <span id="312">312</span> |
| <span id="313">313</span> |
| <span id="314">314</span> |
| <span id="315">315</span> |
| <span id="316">316</span> |
| <span id="317">317</span> |
| <span id="318">318</span> |
| <span id="319">319</span> |
| <span id="320">320</span> |
| <span id="321">321</span> |
| <span id="322">322</span> |
| <span id="323">323</span> |
| <span id="324">324</span> |
| <span id="325">325</span> |
| <span id="326">326</span> |
| <span id="327">327</span> |
| <span id="328">328</span> |
| <span id="329">329</span> |
| <span id="330">330</span> |
| <span id="331">331</span> |
| <span id="332">332</span> |
| <span id="333">333</span> |
| <span id="334">334</span> |
| <span id="335">335</span> |
| <span id="336">336</span> |
| <span id="337">337</span> |
| <span id="338">338</span> |
| <span id="339">339</span> |
| <span id="340">340</span> |
| <span id="341">341</span> |
| <span id="342">342</span> |
| <span id="343">343</span> |
| <span id="344">344</span> |
| <span id="345">345</span> |
| <span id="346">346</span> |
| <span id="347">347</span> |
| <span id="348">348</span> |
| <span id="349">349</span> |
| <span id="350">350</span> |
| <span id="351">351</span> |
| <span id="352">352</span> |
| <span id="353">353</span> |
| <span id="354">354</span> |
| <span id="355">355</span> |
| <span id="356">356</span> |
| <span id="357">357</span> |
| <span id="358">358</span> |
| <span id="359">359</span> |
| <span id="360">360</span> |
| <span id="361">361</span> |
| <span id="362">362</span> |
| <span id="363">363</span> |
| <span id="364">364</span> |
| <span id="365">365</span> |
| <span id="366">366</span> |
| <span id="367">367</span> |
| <span id="368">368</span> |
| <span id="369">369</span> |
| <span id="370">370</span> |
| <span id="371">371</span> |
| <span id="372">372</span> |
| <span id="373">373</span> |
| <span id="374">374</span> |
| <span id="375">375</span> |
| <span id="376">376</span> |
| <span id="377">377</span> |
| <span id="378">378</span> |
| <span id="379">379</span> |
| <span id="380">380</span> |
| <span id="381">381</span> |
| <span id="382">382</span> |
| <span id="383">383</span> |
| <span id="384">384</span> |
| <span id="385">385</span> |
| <span id="386">386</span> |
| <span id="387">387</span> |
| <span id="388">388</span> |
| <span id="389">389</span> |
| <span id="390">390</span> |
| <span id="391">391</span> |
| <span id="392">392</span> |
| <span id="393">393</span> |
| <span id="394">394</span> |
| <span id="395">395</span> |
| </pre><pre class="rust"><code><span class="doccomment">//! # Overview |
| //! |
| //! This crate provides native rust implementations of image encoding and decoding as well as some |
| //! basic image manipulation functions. Additional documentation can currently also be found in the |
| //! [README.md file which is most easily viewed on |
| //! github](https://github.com/image-rs/image/blob/master/README.md). |
| //! |
| //! There are two core problems for which this library provides solutions: a unified interface for image |
| //! encodings and simple generic buffers for their content. It's possible to use either feature |
| //! without the other. The focus is on a small and stable set of common operations that can be |
| //! supplemented by other specialized crates. The library also prefers safe solutions with few |
| //! dependencies. |
| //! |
| //! # High level API |
| //! |
| //! Load images using [`io::Reader`]: |
| //! |
| //! ```rust,no_run |
| //! # use std::io::Cursor; |
| //! use image::io::Reader as ImageReader; |
| //! # fn main() -> Result<(), image::ImageError> { |
| //! # let bytes = vec![0u8]; |
| //! |
| //! let img = ImageReader::open("myimage.png")?.decode()?; |
| //! let img2 = ImageReader::new(Cursor::new(bytes)).decode()?; |
| //! # Ok(()) |
| //! # } |
| //! ``` |
| //! |
| //! And save them using [`save`] or [`write_to`] methods: |
| //! |
| //! ```rust,no_run |
| //! # use std::io::Write; |
| //! # use image::ImageOutputFormat; |
| //! # use image::DynamicImage; |
| //! # #[cfg(feature = "png")] |
| //! # fn main() -> Result<(), image::ImageError> { |
| //! # let img: DynamicImage = unimplemented!(); |
| //! # let img2: DynamicImage = unimplemented!(); |
| //! img.save("empty.jpg")?; |
| //! |
| //! let mut bytes: Vec<u8> = Vec::new(); |
| //! img2.write_to(&mut bytes, image::ImageOutputFormat::Png)?; |
| //! # Ok(()) |
| //! # } |
| //! # #[cfg(not(feature = "png"))] fn main() {} |
| //! ``` |
| //! |
| //! With default features, the crate includes support for [many common image formats](codecs/index.html#supported-formats). |
| //! |
| //! [`save`]: enum.DynamicImage.html#method.save |
| //! [`write_to`]: enum.DynamicImage.html#method.write_to |
| //! [`io::Reader`]: io/struct.Reader.html |
| //! |
| //! # Image buffers |
| //! |
| //! The two main types for storing images: |
| //! * [`ImageBuffer`] which holds statically typed image contents. |
| //! * [`DynamicImage`] which is an enum over the supported ImageBuffer formats |
| //! and supports conversions between them. |
| //! |
| //! As well as a few more specialized options: |
| //! * [`GenericImage`] trait for a mutable image buffer. |
| //! * [`GenericImageView`] trait for read only references to a GenericImage. |
| //! * [`flat`] module containing types for interoperability with generic channel |
| //! matrices and foreign interfaces. |
| //! |
| //! [`GenericImageView`]: trait.GenericImageView.html |
| //! [`GenericImage`]: trait.GenericImage.html |
| //! [`ImageBuffer`]: struct.ImageBuffer.html |
| //! [`DynamicImage`]: enum.DynamicImage.html |
| //! [`flat`]: flat/index.html |
| //! |
| //! # Low level encoding/decoding API |
| //! |
| //! The [`ImageDecoder`] and [`ImageDecoderExt`] traits are implemented for many image file |
| //! formats. They decode image data by directly on raw byte slices. Given an ImageDecoder, you can |
| //! produce a DynamicImage via [`DynamicImage::from_decoder`]. |
| //! |
| //! [`ImageEncoder`] provides the analogous functionality for encoding image data. |
| //! |
| //! [`DynamicImage::from_decoder`]: enum.DynamicImage.html#method.from_decoder |
| //! [`ImageDecoderExt`]: trait.ImageDecoderExt.html |
| //! [`ImageDecoder`]: trait.ImageDecoder.html |
| //! [`ImageEncoder`]: trait.ImageEncoder.html |
| </span><span class="attribute">#![warn(missing_docs)] |
| #![warn(unused_qualifications)] |
| #![deny(unreachable_pub)] |
| #![deny(deprecated)] |
| #![deny(missing_copy_implementations)] |
| #![cfg_attr(all(test, feature = <span class="string">"benchmarks"</span>), feature(test))] |
| </span><span class="comment">// it's a bit of a pain otherwise |
| </span><span class="attribute">#![allow(clippy::many_single_char_names)] |
| </span><span class="comment">// it's a backwards compatibility break |
| </span><span class="attribute">#![allow(clippy::wrong_self_convention, clippy::enum_variant_names)] |
| |
| #[cfg(all(test, feature = <span class="string">"benchmarks"</span>))] |
| </span><span class="kw">extern crate </span>test; |
| |
| <span class="attribute">#[cfg(test)] |
| #[macro_use] |
| </span><span class="kw">extern crate </span>quickcheck; |
| |
| <span class="kw">use </span>std::io::Write; |
| |
| <span class="kw">pub use </span><span class="kw">crate</span>::color::{ColorType, ExtendedColorType}; |
| |
| <span class="kw">pub use </span><span class="kw">crate</span>::color::{Luma, LumaA, Rgb, Rgba, Bgr, Bgra}; |
| |
| <span class="kw">pub use </span><span class="kw">crate</span>::error::{ImageError, ImageResult}; |
| |
| <span class="kw">pub use </span><span class="kw">crate</span>::image::{AnimationDecoder, |
| GenericImage, |
| GenericImageView, |
| ImageDecoder, |
| ImageDecoderExt, |
| ImageEncoder, |
| ImageFormat, |
| ImageOutputFormat, |
| Progress, |
| <span class="comment">// Iterators |
| </span>Pixels, |
| SubImage}; |
| |
| <span class="kw">pub use </span><span class="kw">crate</span>::buffer_::{ |
| GrayAlphaImage, |
| GrayImage, |
| <span class="comment">// Image types |
| </span>ImageBuffer, |
| RgbImage, |
| RgbaImage}; |
| |
| <span class="kw">pub use </span><span class="kw">crate</span>::flat::FlatSamples; |
| |
| <span class="comment">// Traits |
| </span><span class="kw">pub use </span><span class="kw">crate</span>::traits::{EncodableLayout, Primitive, Pixel}; |
| |
| <span class="comment">// Opening and loading images |
| </span><span class="kw">pub use </span><span class="kw">crate</span>::io::free_functions::{guess_format, load}; |
| <span class="kw">pub use </span><span class="kw">crate</span>::dynimage::{load_from_memory, load_from_memory_with_format, open, |
| save_buffer, save_buffer_with_format, image_dimensions}; |
| |
| <span class="kw">pub use </span><span class="kw">crate</span>::dynimage::DynamicImage; |
| |
| <span class="kw">pub use </span><span class="kw">crate</span>::animation::{Delay, Frame, Frames}; |
| |
| <span class="comment">// More detailed error type |
| </span><span class="kw">pub mod </span>error; |
| |
| <span class="doccomment">/// Iterators and other auxiliary structure for the `ImageBuffer` type. |
| </span><span class="kw">pub mod </span>buffer { |
| <span class="comment">// Only those not exported at the top-level |
| </span><span class="kw">pub use </span><span class="kw">crate</span>::buffer_::{ |
| ConvertBuffer, |
| EnumeratePixels, |
| EnumeratePixelsMut, |
| EnumerateRows, |
| EnumerateRowsMut, |
| Pixels, |
| PixelsMut, |
| Rows, |
| RowsMut, |
| }; |
| } |
| |
| <span class="comment">// Math utils |
| </span><span class="kw">pub mod </span>math; |
| |
| <span class="comment">// Image processing functions |
| </span><span class="kw">pub mod </span>imageops; |
| |
| <span class="comment">// Io bindings |
| </span><span class="kw">pub mod </span>io; |
| |
| <span class="comment">// Buffer representations for ffi. |
| </span><span class="kw">pub mod </span>flat; |
| |
| <span class="doccomment">/// Encoding and decoding for various image file formats. |
| /// |
| /// # Supported formats |
| /// |
| /// | Format | Decoding | Encoding | |
| /// | ------ | -------- | -------- | |
| /// | PNG | All supported color types | Same as decoding | |
| /// | JPEG | Baseline and progressive | Baseline JPEG | |
| /// | GIF | Yes | Yes | |
| /// | BMP | Yes | RGB8, RGBA8, Gray8, GrayA8 | |
| /// | ICO | Yes | Yes | |
| /// | TIFF | Baseline(no fax support) + LZW + PackBits | RGB8, RGBA8, Gray8 | |
| /// | WebP | Lossy(Luma channel only) | No | |
| /// | AVIF | Only 8-bit | Lossy | |
| /// | PNM | PBM, PGM, PPM, standard PAM | Yes | |
| /// | DDS | DXT1, DXT3, DXT5 | No | |
| /// | TGA | Yes | RGB8, RGBA8, BGR8, BGRA8, Gray8, GrayA8 | |
| /// | farbfeld | Yes | Yes | |
| /// |
| /// ## A note on format specific features |
| /// |
| /// One of the main goals of `image` is stability, in runtime but also for programmers. This |
| /// ensures that performance as well as safety fixes reach a majority of its user base with little |
| /// effort. Re-exporting all details of its dependencies would run counter to this goal as it |
| /// linked _all_ major version bumps between them and `image`. As such, we are wary of exposing too |
| /// many details, or configuration options, that are not shared between different image formats. |
| /// |
| /// Nevertheless, the advantage of precise control is hard to ignore. We will thus consider |
| /// _wrappers_, not direct re-exports, in either of the following cases: |
| /// |
| /// 1. A standard specifies that configuration _x_ is required for decoders/encoders and there |
| /// exists an essentially canonical way to control it. |
| /// 2. At least two different implementations agree on some (sub-)set of features in practice. |
| /// 3. A technical argument including measurements of the performance, space benefits, or otherwise |
| /// objectively quantified benefits can be made, and the added interface is unlikely to require |
| /// breaking changes. |
| /// |
| /// Features that fulfill two or more criteria are preferred. |
| /// |
| /// Re-exports of dependencies that reach version `1` will be discussed when it happens. |
| </span><span class="kw">pub mod </span>codecs { |
| <span class="attribute">#[cfg(any(feature = <span class="string">"avif-encoder"</span>, feature = <span class="string">"avif-decoder"</span>))] |
| </span><span class="kw">pub mod </span>avif; |
| <span class="attribute">#[cfg(feature = <span class="string">"bmp"</span>)] |
| </span><span class="kw">pub mod </span>bmp; |
| <span class="attribute">#[cfg(feature = <span class="string">"dds"</span>)] |
| </span><span class="kw">pub mod </span>dds; |
| <span class="attribute">#[cfg(feature = <span class="string">"dxt"</span>)] |
| </span><span class="kw">pub mod </span>dxt; |
| <span class="attribute">#[cfg(feature = <span class="string">"farbfeld"</span>)] |
| </span><span class="kw">pub mod </span>farbfeld; |
| <span class="attribute">#[cfg(feature = <span class="string">"gif"</span>)] |
| </span><span class="kw">pub mod </span>gif; |
| <span class="attribute">#[cfg(feature = <span class="string">"hdr"</span>)] |
| </span><span class="kw">pub mod </span>hdr; |
| <span class="attribute">#[cfg(feature = <span class="string">"ico"</span>)] |
| </span><span class="kw">pub mod </span>ico; |
| <span class="attribute">#[cfg(feature = <span class="string">"jpeg"</span>)] |
| </span><span class="kw">pub mod </span>jpeg; |
| <span class="attribute">#[cfg(feature = <span class="string">"png"</span>)] |
| </span><span class="kw">pub mod </span>png; |
| <span class="attribute">#[cfg(feature = <span class="string">"pnm"</span>)] |
| </span><span class="kw">pub mod </span>pnm; |
| <span class="attribute">#[cfg(feature = <span class="string">"tga"</span>)] |
| </span><span class="kw">pub mod </span>tga; |
| <span class="attribute">#[cfg(feature = <span class="string">"tiff"</span>)] |
| </span><span class="kw">pub mod </span>tiff; |
| <span class="attribute">#[cfg(feature = <span class="string">"webp"</span>)] |
| </span><span class="kw">pub mod </span>webp; |
| } |
| |
| <span class="attribute">#[cfg(feature = <span class="string">"avif-encoder"</span>)] |
| #[deprecated = <span class="string">"Use codecs::avif instead"</span>] |
| </span><span class="kw">pub mod </span>avif { |
| <span class="doccomment">//! Encoding of AVIF images. |
| </span><span class="kw">pub use </span><span class="kw">crate</span>::codecs::avif::AvifEncoder; |
| } |
| <span class="attribute">#[cfg(feature = <span class="string">"bmp"</span>)] |
| #[deprecated = <span class="string">"Use codecs::bmp instead"</span>] |
| </span><span class="kw">pub mod </span>bmp { |
| <span class="doccomment">//! Decoding and Encoding of BMP Images |
| </span><span class="attribute">#[allow(deprecated)] |
| </span><span class="kw">pub use </span><span class="kw">crate</span>::codecs::bmp::{BMPEncoder, BmpDecoder, BmpEncoder}; |
| } |
| <span class="attribute">#[cfg(feature = <span class="string">"dds"</span>)] |
| #[deprecated = <span class="string">"Use codecs::dds instead"</span>] |
| </span><span class="kw">pub mod </span>dds { |
| <span class="doccomment">//! Decoding of DDS images |
| </span><span class="kw">pub use </span><span class="kw">crate</span>::codecs::dds::DdsDecoder; |
| } |
| <span class="attribute">#[cfg(feature = <span class="string">"dxt"</span>)] |
| #[deprecated = <span class="string">"Use codecs:: instead"</span>] |
| </span><span class="kw">pub mod </span>dxt { |
| <span class="doccomment">//! Decoding of DXT (S3TC) compression |
| </span><span class="attribute">#[allow(deprecated)] |
| </span><span class="kw">pub use </span><span class="kw">crate</span>::codecs::dxt::{ |
| DXTEncoder, DXTReader, DXTVariant, DxtDecoder, DxtEncoder, DxtReader, DxtVariant, |
| }; |
| } |
| <span class="attribute">#[cfg(feature = <span class="string">"farbfeld"</span>)] |
| #[deprecated = <span class="string">"Use codecs::farbfeld instead"</span>] |
| </span><span class="kw">pub mod </span>farbfeld { |
| <span class="doccomment">//! Decoding of farbfeld images |
| </span><span class="kw">pub use </span><span class="kw">crate</span>::codecs::farbfeld::{FarbfeldDecoder, FarbfeldEncoder, FarbfeldReader}; |
| } |
| <span class="attribute">#[cfg(feature = <span class="string">"gif"</span>)] |
| #[deprecated = <span class="string">"Use codecs::gif instead"</span>] |
| </span><span class="kw">pub mod </span>gif { |
| <span class="doccomment">//! Decoding of GIF Images |
| </span><span class="attribute">#[allow(deprecated)] |
| </span><span class="kw">pub use </span><span class="kw">crate</span>::codecs::gif::{Encoder, GifDecoder, GifEncoder, GifReader, Repeat}; |
| } |
| <span class="attribute">#[cfg(feature = <span class="string">"hdr"</span>)] |
| #[deprecated = <span class="string">"Use codecs::hdr instead"</span>] |
| </span><span class="kw">pub mod </span>hdr { |
| <span class="doccomment">//! Decoding of Radiance HDR Images |
| </span><span class="attribute">#[allow(deprecated)] |
| </span><span class="kw">pub use </span><span class="kw">crate</span>::codecs::hdr::{ |
| read_raw_file, rgbe8, to_rgbe8, HDRAdapter, HDREncoder, HDRImageDecoderIterator, |
| HDRMetadata, HdrAdapter, HdrDecoder, HdrEncoder, HdrImageDecoderIterator, HdrMetadata, |
| HdrReader, RGBE8Pixel, Rgbe8Pixel, SIGNATURE, |
| }; |
| } |
| <span class="attribute">#[cfg(feature = <span class="string">"ico"</span>)] |
| #[deprecated = <span class="string">"Use codecs::ico instead"</span>] |
| </span><span class="kw">pub mod </span>ico { |
| <span class="doccomment">//! Decoding and Encoding of ICO files |
| </span><span class="attribute">#[allow(deprecated)] |
| </span><span class="kw">pub use </span><span class="kw">crate</span>::codecs::ico::{ICOEncoder, IcoDecoder, IcoEncoder}; |
| } |
| <span class="attribute">#[cfg(feature = <span class="string">"jpeg"</span>)] |
| #[deprecated = <span class="string">"Use codecs::jpeg instead"</span>] |
| </span><span class="kw">pub mod </span>jpeg { |
| <span class="doccomment">//! Decoding and Encoding of JPEG Images |
| </span><span class="attribute">#[allow(deprecated)] |
| </span><span class="kw">pub use </span><span class="kw">crate</span>::codecs::jpeg::{ |
| JPEGEncoder, JpegDecoder, JpegEncoder, PixelDensity, PixelDensityUnit, |
| }; |
| } |
| <span class="attribute">#[cfg(feature = <span class="string">"png"</span>)] |
| #[deprecated = <span class="string">"Use codecs::png instead"</span>] |
| </span><span class="kw">pub mod </span>png { |
| <span class="doccomment">//! Decoding and Encoding of PNG Images |
| </span><span class="attribute">#[allow(deprecated)] |
| </span><span class="kw">pub use </span><span class="kw">crate</span>::codecs::png::{ |
| ApngDecoder, CompressionType, FilterType, PNGEncoder, PNGReader, PngDecoder, PngEncoder, |
| PngReader, |
| }; |
| } |
| <span class="attribute">#[cfg(feature = <span class="string">"pnm"</span>)] |
| #[deprecated = <span class="string">"Use codecs::pnm instead"</span>] |
| </span><span class="kw">pub mod </span>pnm { |
| <span class="doccomment">//! Decoding and Encoding of netpbm image formats (pbm, pgm, ppm and pam) |
| </span><span class="attribute">#[allow(deprecated)] |
| </span><span class="kw">pub use </span><span class="kw">crate</span>::codecs::pnm::{ |
| ArbitraryHeader, ArbitraryTuplType, BitmapHeader, GraymapHeader, PNMEncoder, PNMHeader, |
| PNMSubtype, PixmapHeader, PnmDecoder, PnmEncoder, PnmHeader, PnmSubtype, SampleEncoding, |
| }; |
| } |
| <span class="attribute">#[cfg(feature = <span class="string">"tga"</span>)] |
| #[deprecated = <span class="string">"Use codecs::tga instead"</span>] |
| </span><span class="kw">pub mod </span>tga { |
| <span class="doccomment">//! Decoding and Encoding of TGA Images |
| </span><span class="attribute">#[allow(deprecated)] |
| </span><span class="kw">pub use </span><span class="kw">crate</span>::codecs::tga::{TgaDecoder, TgaEncoder}; |
| } |
| <span class="attribute">#[cfg(feature = <span class="string">"tiff"</span>)] |
| #[deprecated = <span class="string">"Use codecs::tiff instead"</span>] |
| </span><span class="kw">pub mod </span>tiff { |
| <span class="doccomment">//! Decoding and Encoding of TIFF Images |
| </span><span class="attribute">#[allow(deprecated)] |
| </span><span class="kw">pub use </span><span class="kw">crate</span>::codecs::tiff::{TiffDecoder, TiffEncoder, TiffReader}; |
| } |
| <span class="attribute">#[cfg(feature = <span class="string">"webp"</span>)] |
| #[deprecated = <span class="string">"Use codecs::webp instead"</span>] |
| </span><span class="kw">pub mod </span>webp { |
| <span class="doccomment">//! Decoding of WebP Images |
| </span><span class="attribute">#[allow(deprecated)] |
| </span><span class="kw">pub use </span><span class="kw">crate</span>::codecs::webp::{vp8, WebPDecoder}; |
| } |
| |
| |
| <span class="kw">mod </span>animation; |
| <span class="attribute">#[path = <span class="string">"buffer.rs"</span>] |
| </span><span class="kw">mod </span>buffer_; |
| <span class="kw">mod </span>color; |
| <span class="kw">mod </span>dynimage; |
| <span class="kw">mod </span>image; |
| <span class="kw">mod </span>traits; |
| <span class="kw">mod </span>utils; |
| |
| <span class="comment">// Can't use the macro-call itself within the `doc` attribute. So force it to eval it as part of |
| // the macro invocation. |
| // |
| // The inspiration for the macro and implementation is from |
| // <https://github.com/GuillaumeGomez/doc-comment> |
| // |
| // MIT License |
| // |
| // Copyright (c) 2018 Guillaume Gomez |
| </span><span class="macro">macro_rules! </span>insert_as_doc { |
| { <span class="macro-nonterminal">$content</span>:expr } => { |
| <span class="attribute">#[doc = <span class="macro-nonterminal">$content</span>] </span><span class="kw">extern </span>{ } |
| } |
| } |
| |
| <span class="comment">// Provides the README.md as doc, to ensure the example works! |
| </span><span class="macro">insert_as_doc!</span>(<span class="macro">include_str!</span>(<span class="string">"../README.md"</span>)); |
| |
| <span class="comment">// Copies data from `src` to `dst` |
| // |
| // Panics if the length of `dst` is less than the length of `src`. |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">fn </span>copy_memory(src: <span class="kw-2">&</span>[u8], <span class="kw-2">mut </span>dst: <span class="kw-2">&mut </span>[u8]) { |
| <span class="kw">let </span>len_src = src.len(); |
| <span class="macro">assert!</span>(dst.len() >= len_src); |
| dst.write_all(src).unwrap(); |
| } |
| </code></pre></div> |
| </section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="image" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |
