|
|
<!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 `imageops` mod in crate `image`."><meta name="keywords" content="rust, rustlang, rust-lang, imageops"><title>image::imageops - 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><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 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">☰</div><a href='../../image/index.html'><div class='logo-container'><img src='../../rust-logo.png' alt='logo'></div></a><p class='location'>Module imageops</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="#enums">Enums</a></li><li><a href="#functions">Functions</a></li></ul></div><p class='location'><a href='../index.html'>image</a></p><script>window.sidebarCurrent = {name: 'imageops', ty: 'mod', relpath: '../'};</script><script defer src="../sidebar-items.js"></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"><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"><h1 class='fqn'><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'>−</span>]</a></span><a class='srclink' href='../../src/image/imageops/mod.rs.html#1-208' title='goto source code'>[src]</a></span><span class='in-band'>Module <a href='../index.html'>image</a>::<wbr><a class="mod" href=''>imageops</a></span></h1><div class='docblock'><p>Image Processing Functions</p>
|
|
|
</div><h2 id='reexports' class='section-header'><a href="#reexports">Re-exports</a></h2>
|
|
|
<table><tr><td><code>pub use self::sample::FilterType::<a class="enum" href="../../image/enum.FilterType.html" title="enum image::FilterType">CatmullRom</a>;</code></td></tr><tr><td><code>pub use self::sample::FilterType::<a class="enum" href="../../image/enum.FilterType.html" title="enum image::FilterType">Gaussian</a>;</code></td></tr><tr><td><code>pub use self::sample::FilterType::<a class="enum" href="../../image/enum.FilterType.html" title="enum image::FilterType">Lanczos3</a>;</code></td></tr><tr><td><code>pub use self::sample::FilterType::<a class="enum" href="../../image/enum.FilterType.html" title="enum image::FilterType">Nearest</a>;</code></td></tr><tr><td><code>pub use self::sample::FilterType::<a class="enum" href="../../image/enum.FilterType.html" title="enum image::FilterType">Triangle</a>;</code></td></tr><tr><td><code>pub use self::colorops::<a class="fn" href="../../image/imageops/colorops/fn.brighten.html" title="fn image::imageops::colorops::brighten">brighten</a>;</code></td></tr><tr><td><code>pub use self::colorops::<a class="fn" href="../../image/imageops/colorops/fn.contrast.html" title="fn image::imageops::colorops::contrast">contrast</a>;</code></td></tr><tr><td><code>pub use self::colorops::<a class="fn" href="../../image/imageops/colorops/fn.dither.html" title="fn image::imageops::colorops::dither">dither</a>;</code></td></tr><tr><td><code>pub use self::colorops::<a class="fn" href="../../image/imageops/colorops/fn.grayscale.html" title="fn image::imageops::colorops::grayscale">grayscale</a>;</code></td></tr><tr><td><code>pub use self::colorops::<a class="fn" href="../../image/imageops/colorops/fn.huerotate.html" title="fn image::imageops::colorops::huerotate">huerotate</a>;</code></td></tr><tr><td><code>pub use self::colorops::<a class="fn" href="../../image/imageops/colorops/fn.index_colors.html" title="fn image::imageops::colorops::index_colors">index_colors</a>;</code></td></tr><tr><td><code>pub use self::colorops::<a class="fn" href="../../image/imageops/colorops/fn.invert.html" title="fn image::imageops::colorops::invert">invert</a>;</code></td></tr><tr><td><code>pub use self::colorops::<a class="struct" href="../../image/imageops/colorops/struct.BiLevel.html" title="struct image::imageops::colorops::BiLevel">BiLevel</a>;</code></td></tr><tr><td><code>pub use self::colorops::<a class="trait" href="../../image/imageops/colorops/trait.ColorMap.html" title="trait image::imageops::colorops::ColorMap">ColorMap</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="colorops/index.html" title='image::imageops::colorops mod'>colorops</a></td><td class='docblock-short'><p>Functions for altering and converting the color of pixelbufs</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.FilterType.html" title='image::imageops::FilterType enum'>FilterType</a></td><td class='docblock-short'><p>Available Sampling Filters</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.blur.html" title='image::imageops::blur fn'>blur</a></td><td class='docblock-short'><p>Performs a Gaussian blur on the supplied image.
|
|
|
<code>sigma</code> is a measure of how much to blur by.</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="fn" href="fn.crop.html" title='image::imageops::crop fn'>crop</a></td><td class='docblock-short'><p>Return a mutable view into an image</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="fn" href="fn.filter3x3.html" title='image::imageops::filter3x3 fn'>filter3x3</a></td><td class='docblock-short'><p>Perform a 3x3 box filter on the supplied image.
|
|
|
<code>kernel</code> is an array of the filter weights of length 9.</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="fn" href="fn.flip_horizontal.html" title='image::imageops::flip_horizontal fn'>flip_horizontal</a></td><td class='docblock-short'><p>Flip an image horizontally</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="fn" href="fn.flip_vertical.html" title='image::imageops::flip_vertical fn'>flip_vertical</a></td><td class='docblock-short'><p>Flip an image vertically</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="fn" href="fn.overlay.html" title='image::imageops::overlay fn'>overlay</a></td><td class='docblock-short'><p>Overlay an image at a given coordinate (x, y)</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="fn" href="fn.overlay_bounds.html" title='image::imageops::overlay_bounds fn'>overlay_bounds</a></td><td class='docblock-short'><p>Calculate the region that can be copied from top to bottom.</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="fn" href="fn.replace.html" title='image::imageops::replace fn'>replace</a></td><td class='docblock-short'><p>Replace the contents of an image at a given coordinate (x, y)</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="fn" href="fn.resize.html" title='image::imageops::resize fn'>resize</a></td><td class='docblock-short'><p>Resize the supplied image to the specified dimensions.
|
|
|
<code>nwidth</code> and <code>nheight</code> are the new dimensions.
|
|
|
<code>filter</code> is the sampling filter to use.</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="fn" href="fn.rotate90.html" title='image::imageops::rotate90 fn'>rotate90</a></td><td class='docblock-short'><p>Rotate an image 90 degrees clockwise.</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="fn" href="fn.rotate180.html" title='image::imageops::rotate180 fn'>rotate180</a></td><td class='docblock-short'><p>Rotate an image 180 degrees clockwise.</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="fn" href="fn.rotate270.html" title='image::imageops::rotate270 fn'>rotate270</a></td><td class='docblock-short'><p>Rotate an image 270 degrees clockwise.</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="fn" href="fn.thumbnail.html" title='image::imageops::thumbnail fn'>thumbnail</a></td><td class='docblock-short'><p>Resize the supplied image to the specific dimensions.</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="fn" href="fn.unsharpen.html" title='image::imageops::unsharpen fn'>unsharpen</a></td><td class='docblock-short'><p>Performs an unsharpen mask on the supplied image.
|
|
|
<code>sigma</code> is the amount to blur the image by.
|
|
|
<code>threshold</code> is the threshold for the difference between</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>⏎</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> |
