2018-10-28 21:14:05 -05:00

447 lines
29 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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 `image` crate."><meta name="keywords" content="rust, rustlang, rust-lang, image"><title>image - 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">&#9776;</div><p class='location'>Crate image</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#reexports">Re-exports</a></li><li><a href="#modules">Modules</a></li><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#traits">Traits</a></li><li><a href="#functions">Functions</a></li><li><a href="#types">Type Definitions</a></li></ul></div><p class='location'></p><script>window.sidebarCurrent = {name: 'image', ty: 'mod', relpath: '../'};</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'>Crate <a class="mod" href=''>image</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'>&#x2212;</span>]</a></span><a class='srclink' href='../src/image/lib.rs.html#1-113' title='goto source code'>[src]</a></span></h1><div class='docblock'><p>This crate provides native rust implementations of
image encoders and decoders and basic image manipulation
functions.</p>
</div><h2 id='reexports' class='section-header'><a href="#reexports">Re-exports</a></h2>
<table><tr><td><code>pub use color::ColorType::<a class="enum" href="../image/enum.ColorType.html" title="enum image::ColorType">Gray</a>;</code></td></tr><tr><td><code>pub use color::ColorType::<a class="enum" href="../image/enum.ColorType.html" title="enum image::ColorType">GrayA</a>;</code></td></tr><tr><td><code>pub use color::ColorType::<a class="enum" href="../image/enum.ColorType.html" title="enum image::ColorType">Palette</a>;</code></td></tr><tr><td><code>pub use color::ColorType::<a class="enum" href="../image/enum.ColorType.html" title="enum image::ColorType">RGB</a>;</code></td></tr><tr><td><code>pub use color::ColorType::<a class="enum" href="../image/enum.ColorType.html" title="enum image::ColorType">RGBA</a>;</code></td></tr><tr><td><code>pub use color::ColorType::<a class="enum" href="../image/enum.ColorType.html" title="enum image::ColorType">BGR</a>;</code></td></tr><tr><td><code>pub use color::ColorType::<a class="enum" href="../image/enum.ColorType.html" title="enum image::ColorType">BGRA</a>;</code></td></tr><tr><td><code>pub use imageops::FilterType::<a class="enum" href="../image/enum.FilterType.html" title="enum image::FilterType">CatmullRom</a>;</code></td></tr><tr><td><code>pub use imageops::FilterType::<a class="enum" href="../image/enum.FilterType.html" title="enum image::FilterType">Gaussian</a>;</code></td></tr><tr><td><code>pub use imageops::FilterType::<a class="enum" href="../image/enum.FilterType.html" title="enum image::FilterType">Lanczos3</a>;</code></td></tr><tr><td><code>pub use imageops::FilterType::<a class="enum" href="../image/enum.FilterType.html" title="enum image::FilterType">Nearest</a>;</code></td></tr><tr><td><code>pub use imageops::FilterType::<a class="enum" href="../image/enum.FilterType.html" title="enum image::FilterType">Triangle</a>;</code></td></tr><tr><td><code>pub use image::ImageFormat::<a class="enum" href="../image/enum.ImageFormat.html" title="enum image::ImageFormat">BMP</a>;</code></td></tr><tr><td><code>pub use image::ImageFormat::<a class="enum" href="../image/enum.ImageFormat.html" title="enum image::ImageFormat">GIF</a>;</code></td></tr><tr><td><code>pub use image::ImageFormat::<a class="enum" href="../image/enum.ImageFormat.html" title="enum image::ImageFormat">ICO</a>;</code></td></tr><tr><td><code>pub use image::ImageFormat::<a class="enum" href="../image/enum.ImageFormat.html" title="enum image::ImageFormat">JPEG</a>;</code></td></tr><tr><td><code>pub use image::ImageFormat::<a class="enum" href="../image/enum.ImageFormat.html" title="enum image::ImageFormat">PNG</a>;</code></td></tr><tr><td><code>pub use image::ImageFormat::<a class="enum" href="../image/enum.ImageFormat.html" title="enum image::ImageFormat">PNM</a>;</code></td></tr><tr><td><code>pub use image::ImageFormat::<a class="enum" href="../image/enum.ImageFormat.html" title="enum image::ImageFormat">WEBP</a>;</code></td></tr><tr><td><code>pub use dynimage::DynamicImage::<a class="enum" href="../image/enum.DynamicImage.html" title="enum image::DynamicImage">ImageLuma8</a>;</code></td></tr><tr><td><code>pub use dynimage::DynamicImage::<a class="enum" href="../image/enum.DynamicImage.html" title="enum image::DynamicImage">ImageLumaA8</a>;</code></td></tr><tr><td><code>pub use dynimage::DynamicImage::<a class="enum" href="../image/enum.DynamicImage.html" title="enum image::DynamicImage">ImageRgb8</a>;</code></td></tr><tr><td><code>pub use dynimage::DynamicImage::<a class="enum" href="../image/enum.DynamicImage.html" title="enum image::DynamicImage">ImageRgba8</a>;</code></td></tr><tr><td><code>pub use dynimage::DynamicImage::<a class="enum" href="../image/enum.DynamicImage.html" title="enum image::DynamicImage">ImageBgr8</a>;</code></td></tr><tr><td><code>pub use dynimage::DynamicImage::<a class="enum" href="../image/enum.DynamicImage.html" title="enum image::DynamicImage">ImageBgra8</a>;</code></td></tr></table><h2 id='modules' class='section-header'><a href="#modules">Modules</a></h2>
<table>
<tr class=' module-item'>
<td><a class="mod" href="bmp/index.html"
title='mod image::bmp'>bmp</a></td>
<td class='docblock-short'>
<p>Decoding and Encoding of BMP Images</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="mod" href="dxt/index.html"
title='mod image::dxt'>dxt</a></td>
<td class='docblock-short'>
<p>Decoding of DXT (S3TC) compression</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="mod" href="gif/index.html"
title='mod image::gif'>gif</a></td>
<td class='docblock-short'>
<p>Decoding of GIF Images</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="mod" href="hdr/index.html"
title='mod image::hdr'>hdr</a></td>
<td class='docblock-short'>
<p>Decoding of Radiance HDR Images</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="mod" href="ico/index.html"
title='mod image::ico'>ico</a></td>
<td class='docblock-short'>
<p>Decoding and Encoding of ICO files</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="mod" href="imageops/index.html"
title='mod image::imageops'>imageops</a></td>
<td class='docblock-short'>
<p>Image Processing Functions</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="mod" href="jpeg/index.html"
title='mod image::jpeg'>jpeg</a></td>
<td class='docblock-short'>
<p>Decoding and Encoding of JPEG Images</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="mod" href="math/index.html"
title='mod image::math'>math</a></td>
<td class='docblock-short'>
<p>Mathematical helper functions and types.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="mod" href="png/index.html"
title='mod image::png'>png</a></td>
<td class='docblock-short'>
<p>Decoding and Encoding of PNG Images</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="mod" href="pnm/index.html"
title='mod image::pnm'>pnm</a></td>
<td class='docblock-short'>
<p>Decoding of netpbm image formats (pbm, pgm, ppm and pam).</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="mod" href="tga/index.html"
title='mod image::tga'>tga</a></td>
<td class='docblock-short'>
<p>Decoding of TGA Images</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="mod" href="tiff/index.html"
title='mod image::tiff'>tiff</a></td>
<td class='docblock-short'>
<p>Decoding and Encoding of TIFF Images</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="mod" href="webp/index.html"
title='mod image::webp'>webp</a></td>
<td class='docblock-short'>
<p>Decoding of Webp Images</p>
</td>
</tr></table><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
<table>
<tr class=' module-item'>
<td><a class="struct" href="struct.Bgr.html"
title='struct image::Bgr'>Bgr</a></td>
<td class='docblock-short'>
<p>BGR colors</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.Bgra.html"
title='struct image::Bgra'>Bgra</a></td>
<td class='docblock-short'>
<p>BGR colors + alpha channel</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.Frame.html"
title='struct image::Frame'>Frame</a></td>
<td class='docblock-short'>
<p>A single animation frame</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.Frames.html"
title='struct image::Frames'>Frames</a></td>
<td class='docblock-short'>
<p>Holds the frames of the animated image</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.ImageBuffer.html"
title='struct image::ImageBuffer'>ImageBuffer</a></td>
<td class='docblock-short'>
<p>Generic image buffer</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.Luma.html"
title='struct image::Luma'>Luma</a></td>
<td class='docblock-short'>
<p>Grayscale colors</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.LumaA.html"
title='struct image::LumaA'>LumaA</a></td>
<td class='docblock-short'>
<p>Grayscale colors + alpha channel</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.MutPixels.html"
title='struct image::MutPixels'>MutPixels</a></td>
<td class='docblock-short'>
<p>Mutable pixel iterator</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.Pixels.html"
title='struct image::Pixels'>Pixels</a></td>
<td class='docblock-short'>
<p>Immutable pixel iterator</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.Rgb.html"
title='struct image::Rgb'>Rgb</a></td>
<td class='docblock-short'>
<p>RGB colors</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.Rgba.html"
title='struct image::Rgba'>Rgba</a></td>
<td class='docblock-short'>
<p>RGB colors + alpha channel</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.SubImage.html"
title='struct image::SubImage'>SubImage</a></td>
<td class='docblock-short'>
<p>A View into another image</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.ColorType.html"
title='enum image::ColorType'>ColorType</a></td>
<td class='docblock-short'>
<p>An enumeration over supported color types and their bit depths</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="enum" href="enum.DecodingResult.html"
title='enum image::DecodingResult'>DecodingResult</a></td>
<td class='docblock-short'>
<p>Result of a decoding process</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="enum" href="enum.DynamicImage.html"
title='enum image::DynamicImage'>DynamicImage</a></td>
<td class='docblock-short'>
<p>A Dynamic Image</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="enum" href="enum.FilterType.html"
title='enum image::FilterType'>FilterType</a></td>
<td class='docblock-short'>
<p>Available Sampling Filters</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="enum" href="enum.ImageError.html"
title='enum image::ImageError'>ImageError</a></td>
<td class='docblock-short'>
<p>An enumeration of Image errors</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="enum" href="enum.ImageFormat.html"
title='enum image::ImageFormat'>ImageFormat</a></td>
<td class='docblock-short'>
<p>An enumeration of supported image formats.
Not all formats support both encoding and decoding.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="enum" href="enum.ImageOutputFormat.html"
title='enum image::ImageOutputFormat'>ImageOutputFormat</a></td>
<td class='docblock-short'>
<p>An enumeration of supported image formats for encoding.</p>
</td>
</tr></table><h2 id='traits' class='section-header'><a href="#traits">Traits</a></h2>
<table>
<tr class=' module-item'>
<td><a class="trait" href="trait.ConvertBuffer.html"
title='trait image::ConvertBuffer'>ConvertBuffer</a></td>
<td class='docblock-short'>
<p>Provides color conversions for whole image buffers.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="trait" href="trait.GenericImage.html"
title='trait image::GenericImage'>GenericImage</a></td>
<td class='docblock-short'>
<p>A trait for manipulating images.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="trait" href="trait.GenericImageView.html"
title='trait image::GenericImageView'>GenericImageView</a></td>
<td class='docblock-short'>
<p>Trait to inspect an image.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="trait" href="trait.ImageDecoder.html"
title='trait image::ImageDecoder'>ImageDecoder</a></td>
<td class='docblock-short'>
<p>The trait that all decoders implement</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="trait" href="trait.Pixel.html"
title='trait image::Pixel'>Pixel</a></td>
<td class='docblock-short'>
<p>A generalized pixel.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="trait" href="trait.Primitive.html"
title='trait image::Primitive'>Primitive</a></td>
<td class='docblock-short'>
<p>Primitive trait from old stdlib</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.Bgr.html"
title='fn image::Bgr'>Bgr</a></td>
<td class='docblock-short'>
</td>
</tr>
<tr class=' module-item'>
<td><a class="fn" href="fn.Bgra.html"
title='fn image::Bgra'>Bgra</a></td>
<td class='docblock-short'>
</td>
</tr>
<tr class=' module-item'>
<td><a class="fn" href="fn.Luma.html"
title='fn image::Luma'>Luma</a></td>
<td class='docblock-short'>
</td>
</tr>
<tr class=' module-item'>
<td><a class="fn" href="fn.LumaA.html"
title='fn image::LumaA'>LumaA</a></td>
<td class='docblock-short'>
</td>
</tr>
<tr class=' module-item'>
<td><a class="fn" href="fn.Rgb.html"
title='fn image::Rgb'>Rgb</a></td>
<td class='docblock-short'>
</td>
</tr>
<tr class=' module-item'>
<td><a class="fn" href="fn.Rgba.html"
title='fn image::Rgba'>Rgba</a></td>
<td class='docblock-short'>
</td>
</tr>
<tr class=' module-item'>
<td><a class="fn" href="fn.guess_format.html"
title='fn image::guess_format'>guess_format</a></td>
<td class='docblock-short'>
<p>Guess image format from memory block</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="fn" href="fn.load.html"
title='fn image::load'>load</a></td>
<td class='docblock-short'>
<p>Create a new image from a Reader</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="fn" href="fn.load_from_memory.html"
title='fn image::load_from_memory'>load_from_memory</a></td>
<td class='docblock-short'>
<p>Create a new image from a byte slice</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="fn" href="fn.load_from_memory_with_format.html"
title='fn image::load_from_memory_with_format'>load_from_memory_with_format</a></td>
<td class='docblock-short'>
<p>Create a new image from a byte slice</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="fn" href="fn.open.html"
title='fn image::open'>open</a></td>
<td class='docblock-short'>
<p>Open the image located at the path specified.
The image's format is determined from the path's file extension.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="fn" href="fn.save_buffer.html"
title='fn image::save_buffer'>save_buffer</a></td>
<td class='docblock-short'>
<p>Saves the supplied buffer to a file at the path specified.</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.GrayAlphaImage.html"
title='type image::GrayAlphaImage'>GrayAlphaImage</a></td>
<td class='docblock-short'>
<p>Sendable grayscale + alpha channel image buffer</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="type" href="type.GrayImage.html"
title='type image::GrayImage'>GrayImage</a></td>
<td class='docblock-short'>
<p>Sendable grayscale image buffer</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="type" href="type.ImageResult.html"
title='type image::ImageResult'>ImageResult</a></td>
<td class='docblock-short'>
<p>Result of an image decoding/encoding process</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="type" href="type.RgbImage.html"
title='type image::RgbImage'>RgbImage</a></td>
<td class='docblock-short'>
<p>Sendable Rgb image buffer</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="type" href="type.RgbaImage.html"
title='type image::RgbaImage'>RgbaImage</a></td>
<td class='docblock-short'>
<p>Sendable Rgb + alpha channel image buffer</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>&#9166;</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>