language-servers/slint
1
0
Fork 0
mirror of https://github.com/slint-ui/slint.git synced 2025-09-30 05:44:52 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 5

doc: Attempt to clarify how the factor of color's mix() function is applied

Browse source
This commit is contained in:
Simon Hausmann 2024-04-15 08:45:01 +02:00 • committed by Simon Hausmann
parent 8e3728864e
commit a61ca93cd1
4 changed files with 14 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

5
api/cpp/include/slint_color.h
View file

@ -153,8 +153,9 @@ public:
/// The transparency is obtained by multiplying the alpha channel by `(1 - factor)`.
[[nodiscard]] inline Color transparentize(float factor) const;
/// Returns a new color that is a mix of \a this and \a other, with a proportion
/// factor given by \a factor (which will be clamped to be between `0.0` and `1.0`).
/// Returns a new color that is a mix of \a this color and \a other. The specified \a factor is
/// clamped to be between `0.0` and `1.0` and then applied to \a this color, while `1.0 -
/// factor` is applied to \a other.
[[nodiscard]] inline Color mix(const Color &other, float factor) const;
/// Returns a new version of this color with the opacity set to \a alpha.

5
api/node/src/types/brush.rs
View file

@ -142,8 +142,9 @@ impl SlintRgbaColor {
SlintRgbaColor::from(self.inner.transparentize(amount as f32))
}
/// Returns a new color that is a mix of `self` and `other`, with a proportion
/// factor given by `factor` (which will be clamped to be between `0.0` and `1.0`).
/// Returns a new color that is a mix of `this` color and `other`. The specified factor is
/// clamped to be between `0.0` and `1.0` and then applied to `this` color, while `1.0 - factor`
///is applied to `other`.
#[napi]
pub fn mix(&self, other: &SlintRgbaColor, factor: f64) -> SlintRgbaColor {
SlintRgbaColor::from(self.inner.mix(&other.inner, factor as f32))

6
docs/reference/src/language/syntax/types.md
View file

@ -95,8 +95,10 @@ All colors and brushes define the following methods:
- **`mix(other: brush, factor: float) -> brush`**
Returns a new color that is a mix of this color and `other`, with a proportion
factor given by factor (which will be clamped to be between `0.0` and `1.0`).
Returns a new color that is a mix of this color and `other`. The specified factor is
clamped to be between `0.0` and `1.0` and then applied to this color, while `1.0 - factor`
is applied to `other`. For example `red.mix(green, 70%)` will have a stronger tone of red, while
`red.mix(green, 30%)` will have a stronger tone of green.
- **`transparentize(factor: float) -> brush`**

7
internal/core/graphics/color.rs
View file

@ -234,8 +234,9 @@ impl Color {
color
}
/// Returns a new color that is a mix of `self` and `other`, with a proportion
/// factor given by `factor` (which will be clamped to be between `0.0` and `1.0`).
/// Returns a new color that is a mix of this color and `other`. The specified factor is
/// clamped to be between `0.0` and `1.0` and then applied to this color, while `1.0 - factor`
/// is applied to `other`.
///
/// # Examples
/// Mix red with black half-and-half:
@ -246,7 +247,7 @@ impl Color {
/// assert_eq!(red.mix(&black, 0.5), Color::from_rgb_u8(128, 0, 0));
/// ```
///
/// Mix Purple with OrangeRed with `75%`:`25%` ratio:
/// Mix Purple with OrangeRed, with `75%` purpe and `25%` orange red ratio:
/// ```
/// # use i_slint_core::graphics::Color;
/// let purple = Color::from_rgb_u8(128, 0, 128);