blob: 14b56e88c120e75d4f216de5ee225377ddf3e22b [file] [log] [blame]
<!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="Functions for altering and converting the color of pixelbufs"><meta name="keywords" content="rust, rustlang, rust-lang, colorops"><title>image::imageops::colorops - 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">&#9776;</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 colorops</a></h2><div class="sidebar-elems"><section><ul class="block"><li><a href="#structs">Structs</a></li><li><a href="#traits">Traits</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 href="../index.html">imageops</a>::<wbr><a class="mod" href="#">colorops</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/colorops.rs.html#1-542">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Functions for altering and converting the color of pixelbufs</p>
</div></details><h2 id="structs" class="small-section-header"><a href="#structs">Structs</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.BiLevel.html" title="image::imageops::colorops::BiLevel struct">BiLevel</a></div><div class="item-right docblock-short">A bi-level color map</div></div></div><h2 id="traits" class="small-section-header"><a href="#traits">Traits</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.ColorMap.html" title="image::imageops::colorops::ColorMap trait">ColorMap</a></div><div class="item-right docblock-short">A color map</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.brighten.html" title="image::imageops::colorops::brighten fn">brighten</a></div><div class="item-right docblock-short">Brighten the supplied image.
<code>value</code> is the amount to brighten each pixel by.
Negative values decrease the brightness and positive values increase it.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.brighten_in_place.html" title="image::imageops::colorops::brighten_in_place fn">brighten_in_place</a></div><div class="item-right docblock-short">Brighten the supplied image in place.
<code>value</code> is the amount to brighten each pixel by.
Negative values decrease the brightness and positive values increase it.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.contrast.html" title="image::imageops::colorops::contrast fn">contrast</a></div><div class="item-right docblock-short">Adjust the contrast of the supplied image.
<code>contrast</code> is the amount to adjust the contrast by.
Negative values decrease the contrast and positive values increase the contrast.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.contrast_in_place.html" title="image::imageops::colorops::contrast_in_place fn">contrast_in_place</a></div><div class="item-right docblock-short">Adjust the contrast of the supplied image in place.
<code>contrast</code> is the amount to adjust the contrast by.
Negative values decrease the contrast and positive values increase the contrast.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.dither.html" title="image::imageops::colorops::dither fn">dither</a></div><div class="item-right docblock-short">Reduces the colors of the image using the supplied <code>color_map</code> while applying
Floyd-Steinberg dithering to improve the visual conception</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.grayscale.html" title="image::imageops::colorops::grayscale fn">grayscale</a></div><div class="item-right docblock-short">Convert the supplied image to grayscale</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.huerotate.html" title="image::imageops::colorops::huerotate fn">huerotate</a></div><div class="item-right docblock-short">Hue rotate the supplied image.
<code>value</code> is the degrees to rotate each pixel by.
0 and 360 do nothing, the rest rotates by the given degree value.
just like the css webkit filter hue-rotate(180)</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.huerotate_in_place.html" title="image::imageops::colorops::huerotate_in_place fn">huerotate_in_place</a></div><div class="item-right docblock-short">Hue rotate the supplied image in place.
<code>value</code> is the degrees to rotate each pixel by.
0 and 360 do nothing, the rest rotates by the given degree value.
just like the css webkit filter hue-rotate(180)</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.index_colors.html" title="image::imageops::colorops::index_colors fn">index_colors</a></div><div class="item-right docblock-short">Reduces the colors using the supplied <code>color_map</code> and returns an image of the indices</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.invert.html" title="image::imageops::colorops::invert fn">invert</a></div><div class="item-right docblock-short">Invert each pixel within the supplied image.
This function operates in place.</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>