51 lines
No EOL
21 KiB
HTML
51 lines
No EOL
21 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="A trait for different ways of mixing colors together."><title>Blend in cosmic::cosmic_theme::palette::blend - 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="#">Blend</a></h2><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.burn" title="burn">burn</a></li><li><a href="#tymethod.darken" title="darken">darken</a></li><li><a href="#tymethod.difference" title="difference">difference</a></li><li><a href="#tymethod.dodge" title="dodge">dodge</a></li><li><a href="#tymethod.exclusion" title="exclusion">exclusion</a></li><li><a href="#tymethod.hard_light" title="hard_light">hard_light</a></li><li><a href="#tymethod.lighten" title="lighten">lighten</a></li><li><a href="#tymethod.multiply" title="multiply">multiply</a></li><li><a href="#tymethod.overlay" title="overlay">overlay</a></li><li><a href="#tymethod.screen" title="screen">screen</a></li><li><a href="#tymethod.soft_light" title="soft_light">soft_light</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::<wbr>blend</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>::<wbr><a href="index.html">blend</a></div><h1>Trait <span class="trait">Blend</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/blend/blend.rs.html#19">Source</a> </span></div><pre class="rust item-decl"><code>pub trait Blend {
|
||
// Required methods
|
||
fn <a href="#tymethod.multiply" class="fn">multiply</a>(self, other: Self) -> Self;
|
||
<span class="item-spacer"></span> fn <a href="#tymethod.screen" class="fn">screen</a>(self, other: Self) -> Self;
|
||
<span class="item-spacer"></span> fn <a href="#tymethod.overlay" class="fn">overlay</a>(self, other: Self) -> Self;
|
||
<span class="item-spacer"></span> fn <a href="#tymethod.darken" class="fn">darken</a>(self, other: Self) -> Self;
|
||
<span class="item-spacer"></span> fn <a href="#tymethod.lighten" class="fn">lighten</a>(self, other: Self) -> Self;
|
||
<span class="item-spacer"></span> fn <a href="#tymethod.dodge" class="fn">dodge</a>(self, other: Self) -> Self;
|
||
<span class="item-spacer"></span> fn <a href="#tymethod.burn" class="fn">burn</a>(self, other: Self) -> Self;
|
||
<span class="item-spacer"></span> fn <a href="#tymethod.hard_light" class="fn">hard_light</a>(self, other: Self) -> Self;
|
||
<span class="item-spacer"></span> fn <a href="#tymethod.soft_light" class="fn">soft_light</a>(self, other: Self) -> Self;
|
||
<span class="item-spacer"></span> fn <a href="#tymethod.difference" class="fn">difference</a>(self, other: Self) -> Self;
|
||
<span class="item-spacer"></span> fn <a href="#tymethod.exclusion" class="fn">exclusion</a>(self, other: Self) -> Self;
|
||
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>A trait for different ways of mixing colors together.</p>
|
||
<p>This implements the classic separable blend modes, <a href="https://www.w3.org/TR/compositing-1/#blending">as described by
|
||
W3C</a>.</p>
|
||
<p><em>Note: The default implementations of the blend modes are meant for color
|
||
components in the range [0.0, 1.0] and may otherwise produce strange
|
||
results.</em></p>
|
||
</div></details><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.multiply" class="method"><a class="src rightside" href="https://docs.rs/palette/0.7.6/src/palette/blend/blend.rs.html#23">Source</a><h4 class="code-header">fn <a href="#tymethod.multiply" class="fn">multiply</a>(self, other: Self) -> Self</h4></section></summary><div class="docblock"><p>Multiply <code>self</code> with <code>other</code>. This uses the alpha component to regulate
|
||
the effect, so it’s not just plain component wise multiplication.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.screen" class="method"><a class="src rightside" href="https://docs.rs/palette/0.7.6/src/palette/blend/blend.rs.html#27">Source</a><h4 class="code-header">fn <a href="#tymethod.screen" class="fn">screen</a>(self, other: Self) -> Self</h4></section></summary><div class="docblock"><p>Make a color which is at least as light as <code>self</code> or <code>other</code>.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.overlay" class="method"><a class="src rightside" href="https://docs.rs/palette/0.7.6/src/palette/blend/blend.rs.html#32">Source</a><h4 class="code-header">fn <a href="#tymethod.overlay" class="fn">overlay</a>(self, other: Self) -> Self</h4></section></summary><div class="docblock"><p>Multiply <code>self</code> or <code>other</code> if other is dark, or screen them if <code>other</code>
|
||
is light. This results in an S curve.</p>
|
||
</div></details><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/blend/blend.rs.html#36">Source</a><h4 class="code-header">fn <a href="#tymethod.darken" class="fn">darken</a>(self, other: Self) -> Self</h4></section></summary><div class="docblock"><p>Return the darkest parts of <code>self</code> and <code>other</code>.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.lighten" class="method"><a class="src rightside" href="https://docs.rs/palette/0.7.6/src/palette/blend/blend.rs.html#40">Source</a><h4 class="code-header">fn <a href="#tymethod.lighten" class="fn">lighten</a>(self, other: Self) -> Self</h4></section></summary><div class="docblock"><p>Return the lightest parts of <code>self</code> and <code>other</code>.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.dodge" class="method"><a class="src rightside" href="https://docs.rs/palette/0.7.6/src/palette/blend/blend.rs.html#45">Source</a><h4 class="code-header">fn <a href="#tymethod.dodge" class="fn">dodge</a>(self, other: Self) -> Self</h4></section></summary><div class="docblock"><p>Lighten <code>other</code> to reflect <code>self</code>. Results in <code>other</code> if <code>self</code> is
|
||
black.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.burn" class="method"><a class="src rightside" href="https://docs.rs/palette/0.7.6/src/palette/blend/blend.rs.html#50">Source</a><h4 class="code-header">fn <a href="#tymethod.burn" class="fn">burn</a>(self, other: Self) -> Self</h4></section></summary><div class="docblock"><p>Darken <code>other</code> to reflect <code>self</code>. Results in <code>other</code> if <code>self</code> is
|
||
white.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.hard_light" class="method"><a class="src rightside" href="https://docs.rs/palette/0.7.6/src/palette/blend/blend.rs.html#56">Source</a><h4 class="code-header">fn <a href="#tymethod.hard_light" class="fn">hard_light</a>(self, other: Self) -> Self</h4></section></summary><div class="docblock"><p>Multiply <code>self</code> or <code>other</code> if other is dark, or screen them if <code>self</code>
|
||
is light. This is similar to <code>overlay</code>, but depends on <code>self</code> instead
|
||
of <code>other</code>.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.soft_light" class="method"><a class="src rightside" href="https://docs.rs/palette/0.7.6/src/palette/blend/blend.rs.html#62">Source</a><h4 class="code-header">fn <a href="#tymethod.soft_light" class="fn">soft_light</a>(self, other: Self) -> Self</h4></section></summary><div class="docblock"><p>Lighten <code>other</code> if <code>self</code> is light, or darken <code>other</code> as if it’s burned
|
||
if <code>self</code> is dark. The effect is increased if the components of <code>self</code>
|
||
is further from 0.5.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.difference" class="method"><a class="src rightside" href="https://docs.rs/palette/0.7.6/src/palette/blend/blend.rs.html#67">Source</a><h4 class="code-header">fn <a href="#tymethod.difference" class="fn">difference</a>(self, other: Self) -> Self</h4></section></summary><div class="docblock"><p>Return the absolute difference between <code>self</code> and <code>other</code>. It’s
|
||
basically <code>abs(self - other)</code>, but regulated by the alpha component.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.exclusion" class="method"><a class="src rightside" href="https://docs.rs/palette/0.7.6/src/palette/blend/blend.rs.html#73">Source</a><h4 class="code-header">fn <a href="#tymethod.exclusion" class="fn">exclusion</a>(self, other: Self) -> Self</h4></section></summary><div class="docblock"><p>Similar to <code>difference</code>, but appears to result in a lower contrast.
|
||
<code>other</code> is inverted if <code>self</code> is white, and preserved if <code>self</code> is
|
||
black.</p>
|
||
</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"><section id="impl-Blend-for-PreAlpha%3CC%3E" class="impl"><a class="src rightside" href="https://docs.rs/palette/0.7.6/src/palette/blend/blend.rs.html#76-80">Source</a><a href="#impl-Blend-for-PreAlpha%3CC%3E" class="anchor">§</a><h3 class="code-header">impl<C, T, const N: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>> <a class="trait" href="trait.Blend.html" title="trait cosmic::cosmic_theme::palette::blend::Blend">Blend</a> for <a class="struct" href="../alpha/struct.PreAlpha.html" title="struct cosmic::cosmic_theme::palette::alpha::PreAlpha">PreAlpha</a><C><div class="where">where
|
||
C: <a class="trait" href="trait.Premultiply.html" title="trait cosmic::cosmic_theme::palette::blend::Premultiply">Premultiply</a><Scalar = T> + <a class="trait" href="../stimulus/trait.StimulusColor.html" title="trait cosmic::cosmic_theme::palette::stimulus::StimulusColor">StimulusColor</a> + <a class="trait" href="../cast/trait.ArrayCast.html" title="trait cosmic::cosmic_theme::palette::cast::ArrayCast">ArrayCast</a><Array = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">[T; N]</a>> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>,
|
||
T: <a class="trait" href="../num/trait.Real.html" title="trait cosmic::cosmic_theme::palette::num::Real">Real</a> + <a class="trait" href="../num/trait.Zero.html" title="trait cosmic::cosmic_theme::palette::num::Zero">Zero</a> + <a class="trait" href="../num/trait.One.html" title="trait cosmic::cosmic_theme::palette::num::One">One</a> + <a class="trait" href="../num/trait.MinMax.html" title="trait cosmic::cosmic_theme::palette::num::MinMax">MinMax</a> + <a class="trait" href="../num/trait.Clamp.html" title="trait cosmic::cosmic_theme::palette::num::Clamp">Clamp</a> + <a class="trait" href="../num/trait.Sqrt.html" title="trait cosmic::cosmic_theme::palette::num::Sqrt">Sqrt</a> + <a class="trait" href="../num/trait.Abs.html" title="trait cosmic::cosmic_theme::palette::num::Abs">Abs</a> + <a class="trait" href="../num/trait.Arithmetics.html" title="trait cosmic::cosmic_theme::palette::num::Arithmetics">Arithmetics</a> + <a class="trait" href="../num/trait.PartialCmp.html" title="trait cosmic::cosmic_theme::palette::num::PartialCmp">PartialCmp</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>,
|
||
<T as <a class="trait" href="../bool_mask/trait.HasBoolMask.html" title="trait cosmic::cosmic_theme::palette::bool_mask::HasBoolMask">HasBoolMask</a>>::<a class="associatedtype" href="../bool_mask/trait.HasBoolMask.html#associatedtype.Mask" title="type cosmic::cosmic_theme::palette::bool_mask::HasBoolMask::Mask">Mask</a>: <a class="trait" href="../bool_mask/trait.LazySelect.html" title="trait cosmic::cosmic_theme::palette::bool_mask::LazySelect">LazySelect</a><T>,</div></h3></section><section id="impl-Blend-for-Alpha%3CC,+T%3E" class="impl"><a class="src rightside" href="https://docs.rs/palette/0.7.6/src/palette/blend/blend.rs.html#229-233">Source</a><a href="#impl-Blend-for-Alpha%3CC,+T%3E" class="anchor">§</a><h3 class="code-header">impl<C, T, const N: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>> <a class="trait" href="trait.Blend.html" title="trait cosmic::cosmic_theme::palette::blend::Blend">Blend</a> for <a class="struct" href="../struct.Alpha.html" title="struct cosmic::cosmic_theme::palette::Alpha">Alpha</a><C, T><div class="where">where
|
||
C: <a class="trait" href="trait.Premultiply.html" title="trait cosmic::cosmic_theme::palette::blend::Premultiply">Premultiply</a><Scalar = T> + <a class="trait" href="../stimulus/trait.StimulusColor.html" title="trait cosmic::cosmic_theme::palette::stimulus::StimulusColor">StimulusColor</a> + <a class="trait" href="../cast/trait.ArrayCast.html" title="trait cosmic::cosmic_theme::palette::cast::ArrayCast">ArrayCast</a><Array = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">[T; N]</a>> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>,
|
||
T: <a class="trait" href="../num/trait.Real.html" title="trait cosmic::cosmic_theme::palette::num::Real">Real</a> + <a class="trait" href="../num/trait.Zero.html" title="trait cosmic::cosmic_theme::palette::num::Zero">Zero</a> + <a class="trait" href="../num/trait.One.html" title="trait cosmic::cosmic_theme::palette::num::One">One</a> + <a class="trait" href="../num/trait.MinMax.html" title="trait cosmic::cosmic_theme::palette::num::MinMax">MinMax</a> + <a class="trait" href="../num/trait.Clamp.html" title="trait cosmic::cosmic_theme::palette::num::Clamp">Clamp</a> + <a class="trait" href="../num/trait.Sqrt.html" title="trait cosmic::cosmic_theme::palette::num::Sqrt">Sqrt</a> + <a class="trait" href="../num/trait.Abs.html" title="trait cosmic::cosmic_theme::palette::num::Abs">Abs</a> + <a class="trait" href="../num/trait.Arithmetics.html" title="trait cosmic::cosmic_theme::palette::num::Arithmetics">Arithmetics</a> + <a class="trait" href="../num/trait.PartialCmp.html" title="trait cosmic::cosmic_theme::palette::num::PartialCmp">PartialCmp</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>,
|
||
<T as <a class="trait" href="../bool_mask/trait.HasBoolMask.html" title="trait cosmic::cosmic_theme::palette::bool_mask::HasBoolMask">HasBoolMask</a>>::<a class="associatedtype" href="../bool_mask/trait.HasBoolMask.html#associatedtype.Mask" title="type cosmic::cosmic_theme::palette::bool_mask::HasBoolMask::Mask">Mask</a>: <a class="trait" href="../bool_mask/trait.LazySelect.html" title="trait cosmic::cosmic_theme::palette::bool_mask::LazySelect">LazySelect</a><T>,</div></h3></section><section id="impl-Blend-for-C" class="impl"><a class="src rightside" href="https://docs.rs/palette/0.7.6/src/palette/blend/blend.rs.html#138-142">Source</a><a href="#impl-Blend-for-C" class="anchor">§</a><h3 class="code-header">impl<C, T, const N: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>> <a class="trait" href="trait.Blend.html" title="trait cosmic::cosmic_theme::palette::blend::Blend">Blend</a> for C<div class="where">where
|
||
C: <a class="trait" href="trait.Premultiply.html" title="trait cosmic::cosmic_theme::palette::blend::Premultiply">Premultiply</a><Scalar = T> + <a class="trait" href="../stimulus/trait.StimulusColor.html" title="trait cosmic::cosmic_theme::palette::stimulus::StimulusColor">StimulusColor</a> + <a class="trait" href="../cast/trait.ArrayCast.html" title="trait cosmic::cosmic_theme::palette::cast::ArrayCast">ArrayCast</a><Array = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">[T; N]</a>> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>,
|
||
T: <a class="trait" href="../num/trait.Real.html" title="trait cosmic::cosmic_theme::palette::num::Real">Real</a> + <a class="trait" href="../num/trait.Zero.html" title="trait cosmic::cosmic_theme::palette::num::Zero">Zero</a> + <a class="trait" href="../num/trait.One.html" title="trait cosmic::cosmic_theme::palette::num::One">One</a> + <a class="trait" href="../num/trait.MinMax.html" title="trait cosmic::cosmic_theme::palette::num::MinMax">MinMax</a> + <a class="trait" href="../num/trait.Clamp.html" title="trait cosmic::cosmic_theme::palette::num::Clamp">Clamp</a> + <a class="trait" href="../num/trait.Sqrt.html" title="trait cosmic::cosmic_theme::palette::num::Sqrt">Sqrt</a> + <a class="trait" href="../num/trait.Abs.html" title="trait cosmic::cosmic_theme::palette::num::Abs">Abs</a> + <a class="trait" href="../num/trait.Arithmetics.html" title="trait cosmic::cosmic_theme::palette::num::Arithmetics">Arithmetics</a> + <a class="trait" href="../num/trait.PartialCmp.html" title="trait cosmic::cosmic_theme::palette::num::PartialCmp">PartialCmp</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>,
|
||
<T as <a class="trait" href="../bool_mask/trait.HasBoolMask.html" title="trait cosmic::cosmic_theme::palette::bool_mask::HasBoolMask">HasBoolMask</a>>::<a class="associatedtype" href="../bool_mask/trait.HasBoolMask.html#associatedtype.Mask" title="type cosmic::cosmic_theme::palette::bool_mask::HasBoolMask::Mask">Mask</a>: <a class="trait" href="../bool_mask/trait.LazySelect.html" title="trait cosmic::cosmic_theme::palette::bool_mask::LazySelect">LazySelect</a><T>,</div></h3></section></div><script src="../../../../trait.impl/palette/blend/blend/trait.Blend.js" data-ignore-extern-crates="palette" async></script></section></div></main></body></html> |