| <!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="Image Processing Functions"><meta name="keywords" content="rust, rustlang, rust-lang, imageops"><title>image::imageops - 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 imageops</a></h2><div class="sidebar-elems"><section><ul class="block"><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></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="#">imageops</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/imageops/mod.rs.html#1-373">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>Image Processing Functions</p> |
| </div></details><h2 id="reexports" class="small-section-header"><a href="#reexports">Re-exports</a></h2><div class="item-table"><div class="item-row"><div class="item-left import-item" id="reexport.CatmullRom"><code>pub use self::sample::FilterType::<a class="enum" href="enum.FilterType.html" title="enum image::imageops::FilterType">CatmullRom</a>;</code></div></div><div class="item-row"><div class="item-left import-item" id="reexport.Gaussian"><code>pub use self::sample::FilterType::<a class="enum" href="enum.FilterType.html" title="enum image::imageops::FilterType">Gaussian</a>;</code></div></div><div class="item-row"><div class="item-left import-item" id="reexport.Lanczos3"><code>pub use self::sample::FilterType::<a class="enum" href="enum.FilterType.html" title="enum image::imageops::FilterType">Lanczos3</a>;</code></div></div><div class="item-row"><div class="item-left import-item" id="reexport.Nearest"><code>pub use self::sample::FilterType::<a class="enum" href="enum.FilterType.html" title="enum image::imageops::FilterType">Nearest</a>;</code></div></div><div class="item-row"><div class="item-left import-item" id="reexport.Triangle"><code>pub use self::sample::FilterType::<a class="enum" href="enum.FilterType.html" title="enum image::imageops::FilterType">Triangle</a>;</code></div></div><div class="item-row"><div class="item-left import-item" id="reexport.brighten"><code>pub use self::colorops::<a class="fn" href="colorops/fn.brighten.html" title="fn image::imageops::colorops::brighten">brighten</a>;</code></div></div><div class="item-row"><div class="item-left import-item" id="reexport.contrast"><code>pub use self::colorops::<a class="fn" href="colorops/fn.contrast.html" title="fn image::imageops::colorops::contrast">contrast</a>;</code></div></div><div class="item-row"><div class="item-left import-item" id="reexport.dither"><code>pub use self::colorops::<a class="fn" href="colorops/fn.dither.html" title="fn image::imageops::colorops::dither">dither</a>;</code></div></div><div class="item-row"><div class="item-left import-item" id="reexport.grayscale"><code>pub use self::colorops::<a class="fn" href="colorops/fn.grayscale.html" title="fn image::imageops::colorops::grayscale">grayscale</a>;</code></div></div><div class="item-row"><div class="item-left import-item" id="reexport.huerotate"><code>pub use self::colorops::<a class="fn" href="colorops/fn.huerotate.html" title="fn image::imageops::colorops::huerotate">huerotate</a>;</code></div></div><div class="item-row"><div class="item-left import-item" id="reexport.index_colors"><code>pub use self::colorops::<a class="fn" href="colorops/fn.index_colors.html" title="fn image::imageops::colorops::index_colors">index_colors</a>;</code></div></div><div class="item-row"><div class="item-left import-item" id="reexport.invert"><code>pub use self::colorops::<a class="fn" href="colorops/fn.invert.html" title="fn image::imageops::colorops::invert">invert</a>;</code></div></div><div class="item-row"><div class="item-left import-item" id="reexport.BiLevel"><code>pub use self::colorops::<a class="struct" href="colorops/struct.BiLevel.html" title="struct image::imageops::colorops::BiLevel">BiLevel</a>;</code></div></div><div class="item-row"><div class="item-left import-item" id="reexport.ColorMap"><code>pub use self::colorops::<a class="trait" href="colorops/trait.ColorMap.html" title="trait image::imageops::colorops::ColorMap">ColorMap</a>;</code></div></div></div><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="colorops/index.html" title="image::imageops::colorops mod">colorops</a></div><div class="item-right docblock-short">Functions for altering and converting the color of pixelbufs</div></div></div><h2 id="enums" class="small-section-header"><a href="#enums">Enums</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.FilterType.html" title="image::imageops::FilterType enum">FilterType</a></div><div class="item-right docblock-short">Available Sampling Filters.</div></div></div><h2 id="functions" class="small-section-header"><a href="#functions">Functions</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.blur.html" title="image::imageops::blur fn">blur</a></div><div class="item-right docblock-short">Performs a Gaussian blur on the supplied image. |
| <code>sigma</code> is a measure of how much to blur by.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.crop.html" title="image::imageops::crop fn">crop</a></div><div class="item-right docblock-short">Return a mutable view into an image |
| The coordinates set the position of the top left corner of the crop.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.crop_imm.html" title="image::imageops::crop_imm fn">crop_imm</a></div><div class="item-right docblock-short">Return an immutable view into an image |
| The coordinates set the position of the top left corner of the crop.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.filter3x3.html" title="image::imageops::filter3x3 fn">filter3x3</a></div><div class="item-right docblock-short">Perform a 3x3 box filter on the supplied image. |
| <code>kernel</code> is an array of the filter weights of length 9.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.flip_horizontal.html" title="image::imageops::flip_horizontal fn">flip_horizontal</a></div><div class="item-right docblock-short">Flip an image horizontally</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.flip_horizontal_in.html" title="image::imageops::flip_horizontal_in fn">flip_horizontal_in</a></div><div class="item-right docblock-short">Flip an image horizontally and put the result into the destination <a href="../struct.ImageBuffer.html" title="ImageBuffer"><code>ImageBuffer</code></a>.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.flip_horizontal_in_place.html" title="image::imageops::flip_horizontal_in_place fn">flip_horizontal_in_place</a></div><div class="item-right docblock-short">Flip an image horizontally in place.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.flip_vertical.html" title="image::imageops::flip_vertical fn">flip_vertical</a></div><div class="item-right docblock-short">Flip an image vertically</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.flip_vertical_in.html" title="image::imageops::flip_vertical_in fn">flip_vertical_in</a></div><div class="item-right docblock-short">Flip an image vertically and put the result into the destination <a href="../struct.ImageBuffer.html" title="ImageBuffer"><code>ImageBuffer</code></a>.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.flip_vertical_in_place.html" title="image::imageops::flip_vertical_in_place fn">flip_vertical_in_place</a></div><div class="item-right docblock-short">Flip an image vertically in place.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.horizontal_gradient.html" title="image::imageops::horizontal_gradient fn">horizontal_gradient</a></div><div class="item-right docblock-short">Fill the image with a linear horizontal gradient</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.overlay.html" title="image::imageops::overlay fn">overlay</a></div><div class="item-right docblock-short">Overlay an image at a given coordinate (x, y)</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.overlay_bounds.html" title="image::imageops::overlay_bounds fn">overlay_bounds</a></div><div class="item-right docblock-short">Calculate the region that can be copied from top to bottom.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.replace.html" title="image::imageops::replace fn">replace</a></div><div class="item-right docblock-short">Replace the contents of an image at a given coordinate (x, y)</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.resize.html" title="image::imageops::resize fn">resize</a></div><div class="item-right docblock-short">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.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.rotate90.html" title="image::imageops::rotate90 fn">rotate90</a></div><div class="item-right docblock-short">Rotate an image 90 degrees clockwise.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.rotate90_in.html" title="image::imageops::rotate90_in fn">rotate90_in</a></div><div class="item-right docblock-short">Rotate an image 90 degrees clockwise and put the result into the destination <a href="../struct.ImageBuffer.html" title="ImageBuffer"><code>ImageBuffer</code></a>.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.rotate180.html" title="image::imageops::rotate180 fn">rotate180</a></div><div class="item-right docblock-short">Rotate an image 180 degrees clockwise.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.rotate180_in.html" title="image::imageops::rotate180_in fn">rotate180_in</a></div><div class="item-right docblock-short">Rotate an image 180 degrees clockwise and put the result into the destination <a href="../struct.ImageBuffer.html" title="ImageBuffer"><code>ImageBuffer</code></a>.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.rotate180_in_place.html" title="image::imageops::rotate180_in_place fn">rotate180_in_place</a></div><div class="item-right docblock-short">Rotate an image 180 degrees clockwise in place.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.rotate270.html" title="image::imageops::rotate270 fn">rotate270</a></div><div class="item-right docblock-short">Rotate an image 270 degrees clockwise.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.rotate270_in.html" title="image::imageops::rotate270_in fn">rotate270_in</a></div><div class="item-right docblock-short">Rotate an image 270 degrees clockwise and put the result into the destination <a href="../struct.ImageBuffer.html" title="ImageBuffer"><code>ImageBuffer</code></a>.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.thumbnail.html" title="image::imageops::thumbnail fn">thumbnail</a></div><div class="item-right docblock-short">Resize the supplied image to the specific dimensions.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.tile.html" title="image::imageops::tile fn">tile</a></div><div class="item-right docblock-short">Tile an image by repeating it multiple times</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.unsharpen.html" title="image::imageops::unsharpen fn">unsharpen</a></div><div class="item-right docblock-short">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</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.vertical_gradient.html" title="image::imageops::vertical_gradient fn">vertical_gradient</a></div><div class="item-right docblock-short">Fill the image with a linear vertical gradient</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> |
