| <!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="A color map"><meta name="keywords" content="rust, rustlang, rust-lang, ColorMap"><title>ColorMap in 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="sidebar-items.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 trait"><!--[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="#">ColorMap</a></h2><div class="sidebar-elems"><section><h3><a href="#required-associated-types">Required Associated Types</a></h3><ul class="block"><li><a href="#associatedtype.Color">Color</a></li></ul><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.index_of">index_of</a></li><li><a href="#tymethod.map_color">map_color</a></li></ul><h3><a href="#provided-methods">Provided Methods</a></h3><ul class="block"><li><a href="#method.has_lookup">has_lookup</a></li><li><a href="#method.lookup">lookup</a></li></ul><h3><a href="#foreign-impls">Implementations on Foreign Types</a></h3><ul class="block"><li><a href="#impl-ColorMap-for-NeuQuant">NeuQuant</a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><h2><a href="index.html">In image::imageops::colorops</a></h2></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">Trait <a href="../../index.html">image</a>::<wbr><a href="../index.html">imageops</a>::<wbr><a href="index.html">colorops</a>::<wbr><a class="trait" href="#">ColorMap</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#310-328">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><div class="item-decl"><pre class="rust trait"><code>pub trait ColorMap { |
| type <a href="#associatedtype.Color" class="associatedtype">Color</a>; |
| |
| fn <a href="#tymethod.index_of" class="fnname">index_of</a>(&self, color: &Self::<a class="associatedtype" href="trait.ColorMap.html#associatedtype.Color" title="type image::imageops::colorops::ColorMap::Color">Color</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>; |
| <span class="item-spacer"></span> fn <a href="#tymethod.map_color" class="fnname">map_color</a>(&self, color: &mut Self::<a class="associatedtype" href="trait.ColorMap.html#associatedtype.Color" title="type image::imageops::colorops::ColorMap::Color">Color</a>); |
| |
| fn <a href="#method.lookup" class="fnname">lookup</a>(&self, index: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><Self::<a class="associatedtype" href="trait.ColorMap.html#associatedtype.Color" title="type image::imageops::colorops::ColorMap::Color">Color</a>> { ... } |
| <span class="item-spacer"></span> fn <a href="#method.has_lookup" class="fnname">has_lookup</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a> { ... } |
| }</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>A color map</p> |
| </div></details><h2 id="required-associated-types" class="small-section-header">Required Associated Types<a href="#required-associated-types" class="anchor"></a></h2><div class="methods"><details class="rustdoc-toggle method-toggle" open><summary><section id="associatedtype.Color" class="method has-srclink"><a class="srclink rightside" href="../../../src/image/imageops/colorops.rs.html#312">source</a><h4 class="code-header">type <a href="#associatedtype.Color" class="associatedtype">Color</a></h4></section></summary><div class="docblock"><p>The color type on which the map operates on</p> |
| </div></details></div><h2 id="required-methods" class="small-section-header">Required Methods<a href="#required-methods" class="anchor"></a></h2><div class="methods"><details class="rustdoc-toggle method-toggle" open><summary><section id="tymethod.index_of" class="method has-srclink"><a class="srclink rightside" href="../../../src/image/imageops/colorops.rs.html#315">source</a><h4 class="code-header">fn <a href="#tymethod.index_of" class="fnname">index_of</a>(&self, color: &Self::<a class="associatedtype" href="trait.ColorMap.html#associatedtype.Color" title="type image::imageops::colorops::ColorMap::Color">Color</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></h4></section></summary><div class="docblock"><p>Returns the index of the closest match of <code>color</code> |
| in the color map.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="tymethod.map_color" class="method has-srclink"><a class="srclink rightside" href="../../../src/image/imageops/colorops.rs.html#327">source</a><h4 class="code-header">fn <a href="#tymethod.map_color" class="fnname">map_color</a>(&self, color: &mut Self::<a class="associatedtype" href="trait.ColorMap.html#associatedtype.Color" title="type image::imageops::colorops::ColorMap::Color">Color</a>)</h4></section></summary><div class="docblock"><p>Maps <code>color</code> to the closest color in the color map.</p> |
| </div></details></div><h2 id="provided-methods" class="small-section-header">Provided Methods<a href="#provided-methods" class="anchor"></a></h2><div class="methods"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.lookup" class="method has-srclink"><a class="srclink rightside" href="../../../src/image/imageops/colorops.rs.html#318-321">source</a><h4 class="code-header">fn <a href="#method.lookup" class="fnname">lookup</a>(&self, index: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><Self::<a class="associatedtype" href="trait.ColorMap.html#associatedtype.Color" title="type image::imageops::colorops::ColorMap::Color">Color</a>></h4></section></summary><div class="docblock"><p>Looks up color by index in the color map. If <code>idx</code> is out of range for the color map, or |
| ColorMap doesn’t implement <code>lookup</code> <code>None</code> is returned.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.has_lookup" class="method has-srclink"><a class="srclink rightside" href="../../../src/image/imageops/colorops.rs.html#323-325">source</a><h4 class="code-header">fn <a href="#method.has_lookup" class="fnname">has_lookup</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></h4></section></summary><div class="docblock"><p>Determine if this implementation of ColorMap overrides the default <code>lookup</code>.</p> |
| </div></details></div><h2 id="foreign-impls" class="small-section-header">Implementations on Foreign Types<a href="#foreign-impls" class="anchor"></a></h2><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-ColorMap-for-NeuQuant" class="impl has-srclink"><a class="srclink rightside" href="../../../src/image/imageops/colorops.rs.html#422-444">source</a><a href="#impl-ColorMap-for-NeuQuant" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="trait.ColorMap.html" title="trait image::imageops::colorops::ColorMap">ColorMap</a> for <a class="struct" href="../../../color_quant/struct.NeuQuant.html" title="struct color_quant::NeuQuant">NeuQuant</a></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.has_lookup-1" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/image/imageops/colorops.rs.html#436-438">source</a><a href="#method.has_lookup-1" class="anchor"></a><h4 class="code-header">fn <a href="#method.has_lookup" class="fnname">has_lookup</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></h4></section></summary><div class="docblock"><p>Indicate NeuQuant implements <code>lookup</code>.</p> |
| </div></details><section id="associatedtype.Color-1" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Color-1" class="anchor"></a><h4 class="code-header">type <a href="#associatedtype.Color" class="associatedtype">Color</a> = <a class="struct" href="../../struct.Rgba.html" title="struct image::Rgba">Rgba</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>></h4></section><section id="method.index_of" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/image/imageops/colorops.rs.html#426-428">source</a><a href="#method.index_of" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.index_of" class="fnname">index_of</a>(&self, color: &<a class="struct" href="../../struct.Rgba.html" title="struct image::Rgba">Rgba</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></h4></section><section id="method.lookup-1" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/image/imageops/colorops.rs.html#431-433">source</a><a href="#method.lookup-1" class="anchor"></a><h4 class="code-header">fn <a href="#method.lookup" class="fnname">lookup</a>(&self, idx: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><Self::<a class="associatedtype" href="trait.ColorMap.html#associatedtype.Color" title="type image::imageops::colorops::ColorMap::Color">Color</a>></h4></section><section id="method.map_color" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/image/imageops/colorops.rs.html#441-443">source</a><a href="#method.map_color" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.map_color" class="fnname">map_color</a>(&self, color: &mut <a class="struct" href="../../struct.Rgba.html" title="struct image::Rgba">Rgba</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>>)</h4></section></div></details><h2 id="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor"></a></h2><div id="implementors-list"><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-ColorMap-for-NeuQuant-1" class="impl has-srclink"><a class="srclink rightside" href="../../../src/image/imageops/colorops.rs.html#398-420">source</a><a href="#impl-ColorMap-for-NeuQuant-1" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="trait.ColorMap.html" title="trait image::imageops::colorops::ColorMap">ColorMap</a> for image::math::nq::<a class="struct" href="../../math/nq/struct.NeuQuant.html" title="struct image::math::nq::NeuQuant">NeuQuant</a></h3></section></summary><div class="impl-items"><section id="associatedtype.Color-2" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Color-2" class="anchor"></a><h4 class="code-header">type <a href="#associatedtype.Color" class="associatedtype">Color</a> = <a class="struct" href="../../struct.Rgba.html" title="struct image::Rgba">Rgba</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>></h4></section></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-ColorMap-for-BiLevel" class="impl has-srclink"><a class="srclink rightside" href="../../../src/image/imageops/colorops.rs.html#362-395">source</a><a href="#impl-ColorMap-for-BiLevel" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="trait.ColorMap.html" title="trait image::imageops::colorops::ColorMap">ColorMap</a> for <a class="struct" href="struct.BiLevel.html" title="struct image::imageops::colorops::BiLevel">BiLevel</a></h3></section></summary><div class="impl-items"><section id="associatedtype.Color-3" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Color-3" class="anchor"></a><h4 class="code-header">type <a href="#associatedtype.Color" class="associatedtype">Color</a> = <a class="struct" href="../../struct.Luma.html" title="struct image::Luma">Luma</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>></h4></section></div></details></div><script src="../../../implementors/image/imageops/colorops/trait.ColorMap.js" data-ignore-extern-crates="color_quant" async></script></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> |
