38 lines
No EOL
11 KiB
HTML
38 lines
No EOL
11 KiB
HTML
<!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="Operators for darkening a color;"><title>Darken in cosmic::cosmic_theme::palette - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../../static.files/rustdoc-aa0817cf.css"><meta name="rustdoc-vars" data-root-path="../../../" data-static-root-path="../../../static.files/" data-current-crate="cosmic" data-themes="" data-resource-suffix="" data-rustdoc-version="1.90.0-nightly (3048886e5 2025-07-30)" data-channel="nightly" data-search-js="search-fa3e91e5.js" data-settings-js="settings-5514c975.js" ><script src="../../../static.files/storage-68b7e25d.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../../static.files/main-eebb9057.js"></script><noscript><link rel="stylesheet" href="../../../static.files/noscript-32bb7600.css"></noscript><link rel="alternate icon" type="image/png" href="../../../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../../../static.files/favicon-044be391.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" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../../cosmic/index.html">cosmic</a><span class="version">1.0.0</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Darken</a></h2><h3><a href="#required-associated-types">Required Associated Types</a></h3><ul class="block"><li><a href="#associatedtype.Scalar" title="Scalar">Scalar</a></li></ul><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.darken" title="darken">darken</a></li><li><a href="#tymethod.darken_fixed" title="darken_fixed">darken_fixed</a></li></ul><h3><a href="#dyn-compatibility">Dyn Compatibility</a></h3><h3><a href="#implementors">Implementors</a></h3></section><div id="rustdoc-modnav"><h2><a href="index.html">In cosmic::<wbr>cosmic_<wbr>theme::<wbr>palette</a></h2></div></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><div class="rustdoc-breadcrumbs"><a href="../../index.html">cosmic</a>::<wbr><a href="../index.html">cosmic_theme</a>::<wbr><a href="index.html">palette</a></div><h1>Trait <span class="trait">Darken</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="https://docs.rs/palette/0.7.6/src/palette/lib.rs.html#754">Source</a> </span></div><pre class="rust item-decl"><code>pub trait Darken {
|
||
type <a href="#associatedtype.Scalar" class="associatedtype">Scalar</a>;
|
||
|
||
// Required methods
|
||
fn <a href="#tymethod.darken" class="fn">darken</a>(self, factor: Self::<a class="associatedtype" href="trait.Darken.html#associatedtype.Scalar" title="type cosmic::cosmic_theme::palette::Darken::Scalar">Scalar</a>) -> Self;
|
||
<span class="item-spacer"></span> fn <a href="#tymethod.darken_fixed" class="fn">darken_fixed</a>(self, amount: Self::<a class="associatedtype" href="trait.Darken.html#associatedtype.Scalar" title="type cosmic::cosmic_theme::palette::Darken::Scalar">Scalar</a>) -> Self;
|
||
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Operators for darkening a color;</p>
|
||
<p>The trait’s functions are split into two groups of functions: relative and
|
||
fixed/absolute.</p>
|
||
<p>The relative function, <a href="trait.Darken.html#tymethod.darken" title="method cosmic::cosmic_theme::palette::Darken::darken"><code>darken</code></a>, scales the lightness
|
||
towards the minimum lightness value. This means that for a color with 50%
|
||
lightness, if <code>darken(0.5)</code> is applied to it, the color will scale halfway
|
||
to the minimum value of 0% resulting in a new lightness value of 25%.</p>
|
||
<p>The fixed or absolute function, <a href="trait.Darken.html#tymethod.darken_fixed" title="method cosmic::cosmic_theme::palette::Darken::darken_fixed"><code>darken_fixed</code></a>,
|
||
decreases the lightness value by an amount that is independent of the
|
||
current lightness of the color. So for a color with 50% lightness, if
|
||
<code>darken_fixed(0.5)</code> is applied to it, the color will have 50% lightness
|
||
removed from its lightness value resulting in a new value of 0%.</p>
|
||
<p>See also <a href="trait.DarkenAssign.html" title="trait cosmic::cosmic_theme::palette::DarkenAssign"><code>DarkenAssign</code></a>, <a href="trait.Lighten.html" title="trait cosmic::cosmic_theme::palette::Lighten"><code>Lighten</code></a> and <a href="trait.LightenAssign.html" title="trait cosmic::cosmic_theme::palette::LightenAssign"><code>LightenAssign</code></a>.</p>
|
||
</div></details><h2 id="required-associated-types" class="section-header">Required Associated Types<a href="#required-associated-types" class="anchor">§</a></h2><div class="methods"><details class="toggle" open><summary><section id="associatedtype.Scalar" class="method"><a class="src rightside" href="https://docs.rs/palette/0.7.6/src/palette/lib.rs.html#756">Source</a><h4 class="code-header">type <a href="#associatedtype.Scalar" class="associatedtype">Scalar</a></h4></section></summary><div class="docblock"><p>The type of the darken modifier.</p>
|
||
</div></details></div><h2 id="required-methods" class="section-header">Required Methods<a href="#required-methods" class="anchor">§</a></h2><div class="methods"><details class="toggle method-toggle" open><summary><section id="tymethod.darken" class="method"><a class="src rightside" href="https://docs.rs/palette/0.7.6/src/palette/lib.rs.html#769">Source</a><h4 class="code-header">fn <a href="#tymethod.darken" class="fn">darken</a>(self, factor: Self::<a class="associatedtype" href="trait.Darken.html#associatedtype.Scalar" title="type cosmic::cosmic_theme::palette::Darken::Scalar">Scalar</a>) -> Self</h4></section></summary><div class="docblock"><p>Scale the color towards the minimum lightness by <code>factor</code>, a value
|
||
ranging from <code>0.0</code> to <code>1.0</code>.</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>approx::assert_relative_eq;
|
||
<span class="kw">use </span>palette::{Hsv, Darken};
|
||
|
||
<span class="kw">let </span>color = Hsv::new_srgb(<span class="number">0.0</span>, <span class="number">1.0</span>, <span class="number">0.5</span>);
|
||
<span class="macro">assert_relative_eq!</span>(color.darken(<span class="number">0.5</span>).value, <span class="number">0.25</span>);</code></pre></div>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.darken_fixed" class="method"><a class="src rightside" href="https://docs.rs/palette/0.7.6/src/palette/lib.rs.html#781">Source</a><h4 class="code-header">fn <a href="#tymethod.darken_fixed" class="fn">darken_fixed</a>(self, amount: Self::<a class="associatedtype" href="trait.Darken.html#associatedtype.Scalar" title="type cosmic::cosmic_theme::palette::Darken::Scalar">Scalar</a>) -> Self</h4></section></summary><div class="docblock"><p>Darken the color by <code>amount</code>, a value ranging from <code>0.0</code> to <code>1.0</code>.</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>approx::assert_relative_eq;
|
||
<span class="kw">use </span>palette::{Hsv, Darken};
|
||
|
||
<span class="kw">let </span>color = Hsv::new_srgb(<span class="number">0.0</span>, <span class="number">1.0</span>, <span class="number">0.4</span>);
|
||
<span class="macro">assert_relative_eq!</span>(color.darken_fixed(<span class="number">0.2</span>).value, <span class="number">0.2</span>);</code></pre></div>
|
||
</div></details></div><h2 id="dyn-compatibility" class="section-header">Dyn Compatibility<a href="#dyn-compatibility" class="anchor">§</a></h2><div class="dyn-compatibility-info"><p>This trait is <b>not</b> <a href="https://doc.rust-lang.org/nightly/reference/items/traits.html#dyn-compatibility">dyn compatible</a>.</p><p><i>In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.</i></p></div><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"><details class="toggle implementors-toggle"><summary><section id="impl-Darken-for-T" class="impl"><a class="src rightside" href="https://docs.rs/palette/0.7.6/src/palette/lib.rs.html#784-787">Source</a><a href="#impl-Darken-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="trait.Darken.html" title="trait cosmic::cosmic_theme::palette::Darken">Darken</a> for T<div class="where">where
|
||
T: <a class="trait" href="trait.Lighten.html" title="trait cosmic::cosmic_theme::palette::Lighten">Lighten</a>,
|
||
<T as <a class="trait" href="trait.Lighten.html" title="trait cosmic::cosmic_theme::palette::Lighten">Lighten</a>>::<a class="associatedtype" href="trait.Lighten.html#associatedtype.Scalar" title="type cosmic::cosmic_theme::palette::Lighten::Scalar">Scalar</a>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/arith/trait.Neg.html" title="trait core::ops::arith::Neg">Neg</a><Output = <T as <a class="trait" href="trait.Lighten.html" title="trait cosmic::cosmic_theme::palette::Lighten">Lighten</a>>::<a class="associatedtype" href="trait.Lighten.html#associatedtype.Scalar" title="type cosmic::cosmic_theme::palette::Lighten::Scalar">Scalar</a>>,</div></h3></section></summary><div class="impl-items"><section id="associatedtype.Scalar-1" class="associatedtype trait-impl"><a class="src rightside" href="https://docs.rs/palette/0.7.6/src/palette/lib.rs.html#789">Source</a><a href="#associatedtype.Scalar-1" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.Scalar" class="associatedtype">Scalar</a> = <T as <a class="trait" href="trait.Lighten.html" title="trait cosmic::cosmic_theme::palette::Lighten">Lighten</a>>::<a class="associatedtype" href="trait.Lighten.html#associatedtype.Scalar" title="type cosmic::cosmic_theme::palette::Lighten::Scalar">Scalar</a></h4></section></div></details></div><script src="../../../trait.impl/palette/trait.Darken.js" async></script></section></div></main></body></html> |