| <!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="Encoding and decoding for various image file formats."><meta name="keywords" content="rust, rustlang, rust-lang, codecs"><title>image::codecs - Rust</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="../../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 mod"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">☰</button><a class="sidebar-logo" href="../../image/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2></h2></nav><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><h2 class="location"><a href="#">Module codecs</a></h2><div class="sidebar-elems"><section><ul class="block"><li><a href="#modules">Modules</a></li></ul></section></div></nav><main><div class="width-limiter"><nav class="sub"><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="main-heading"><h1 class="fqn">Module <a href="../index.html">image</a>::<wbr><a class="mod" href="#">codecs</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../../clipboard.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="srclink" href="../../src/image/lib.rs.html#218">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Encoding and decoding for various image file formats.</p> |
| <h2 id="supported-formats"><a href="#supported-formats">Supported formats</a></h2><div><table><thead><tr><th>Format</th><th>Decoding</th><th>Encoding</th></tr></thead><tbody> |
| <tr><td>PNG</td><td>All supported color types</td><td>Same as decoding</td></tr> |
| <tr><td>JPEG</td><td>Baseline and progressive</td><td>Baseline JPEG</td></tr> |
| <tr><td>GIF</td><td>Yes</td><td>Yes</td></tr> |
| <tr><td>BMP</td><td>Yes</td><td>RGB8, RGBA8, Gray8, GrayA8</td></tr> |
| <tr><td>ICO</td><td>Yes</td><td>Yes</td></tr> |
| <tr><td>TIFF</td><td>Baseline(no fax support) + LZW + PackBits</td><td>RGB8, RGBA8, Gray8</td></tr> |
| <tr><td>WebP</td><td>Lossy(Luma channel only)</td><td>No</td></tr> |
| <tr><td>AVIF</td><td>Only 8-bit</td><td>Lossy</td></tr> |
| <tr><td>PNM</td><td>PBM, PGM, PPM, standard PAM</td><td>Yes</td></tr> |
| <tr><td>DDS</td><td>DXT1, DXT3, DXT5</td><td>No</td></tr> |
| <tr><td>TGA</td><td>Yes</td><td>RGB8, RGBA8, BGR8, BGRA8, Gray8, GrayA8</td></tr> |
| <tr><td>farbfeld</td><td>Yes</td><td>Yes</td></tr> |
| </tbody></table> |
| </div><h3 id="a-note-on-format-specific-features"><a href="#a-note-on-format-specific-features">A note on format specific features</a></h3> |
| <p>One of the main goals of <code>image</code> 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 <em>all</em> major version bumps between them and <code>image</code>. As such, we are wary of exposing too |
| many details, or configuration options, that are not shared between different image formats.</p> |
| <p>Nevertheless, the advantage of precise control is hard to ignore. We will thus consider |
| <em>wrappers</em>, not direct re-exports, in either of the following cases:</p> |
| <ol> |
| <li>A standard specifies that configuration <em>x</em> is required for decoders/encoders and there |
| exists an essentially canonical way to control it.</li> |
| <li>At least two different implementations agree on some (sub-)set of features in practice.</li> |
| <li>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.</li> |
| </ol> |
| <p>Features that fulfill two or more criteria are preferred.</p> |
| <p>Re-exports of dependencies that reach version <code>1</code> will be discussed when it happens.</p> |
| </div></details><h2 id="modules" class="small-section-header"><a href="#modules">Modules</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="mod" href="jpeg/index.html" title="image::codecs::jpeg mod">jpeg</a></div><div class="item-right docblock-short">Decoding and Encoding of JPEG Images</div></div></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> |
