nannou 0.9.0

A Creative Coding Framework for Rust.
Documentation
use crate::color::{self, Alpha, IntoColor, Rgb, Rgba};
use crate::math::num_traits::{Float, One};

/// The default scalar value for working with color channels, hues, etc.
pub type DefaultScalar = f32;

/// An **Rgba** type with the default Scalar.
///
/// Used by the **draw::properties::Common** type.
pub type DefaultRgba = Rgba<DefaultScalar>;

/// Types that may be converted directly into an RGBA color.
pub trait IntoRgba<S>
where
    S: Float,
{
    /// Convert self into RGBA.
    fn into_rgba(self) -> Rgba<S>;
}

/// Nodes that support setting colors.
pub trait SetColor<S>: Sized
where
    S: Float,
{
    /// Provide a mutable reference to the RGBA field which can be used for setting colors.
    fn rgba_mut(&mut self) -> &mut Option<Rgba<S>>;

    /// Specify a color.
    ///
    /// This method supports any color type that can be converted into RGBA.
    ///
    /// Colors that have no alpha channel will be given an opaque alpha channel value `1.0`.
    fn color<C>(mut self, color: C) -> Self
    where
        C: IntoRgba<S>,
    {
        *self.rgba_mut() = Some(color.into_rgba());
        self
    }

    /// Specify the color via red, green and blue channels.
    fn rgb(self, r: S, g: S, b: S) -> Self {
        self.color(Rgb::new(r, g, b))
    }

    /// Specify the color via red, green, blue and alpha channels.
    fn rgba(self, r: S, g: S, b: S, a: S) -> Self {
        self.color(Rgba::new(r, g, b, a))
    }

    /// Specify the color via hue, saturation and luminance.
    ///
    /// If you're looking for HSV or HSB, use the `hsv` method instead.
    ///
    /// The given hue expects a value between `0.0` and `1.0` where `0.0` is 0 degress and `1.0` is
    /// 360 degrees (or 2 PI radians).
    ///
    /// See the [wikipedia entry](https://en.wikipedia.org/wiki/HSL_and_HSV) for more details on
    /// this color space.
    fn hsl(self, h: S, s: S, l: S) -> Self
    where
        S: Into<color::RgbHue<S>>,
    {
        let hue = h * S::from(360.0).unwrap();
        self.color(color::Hsl::new(hue.into(), s, l))
    }

    /// Specify the color via hue, saturation, luminance and an alpha channel.
    ///
    /// If you're looking for HSVA or HSBA, use the `hsva` method instead.
    ///
    /// The given hue expects a value between `0.0` and `1.0` where `0.0` is 0 degress and `1.0` is
    /// 360 degrees (or 2 PI radians).
    ///
    /// See the [wikipedia entry](https://en.wikipedia.org/wiki/HSL_and_HSV) for more details on
    /// this color space.
    fn hsla(self, h: S, s: S, l: S, a: S) -> Self
    where
        S: Into<color::RgbHue<S>>,
    {
        let hue = h * S::from(360.0).unwrap();
        self.color(color::Hsla::new(hue.into(), s, l, a))
    }

    /// Specify the color via hue, saturation and *value* (brightness).
    ///
    /// This is sometimes also known as "hsb".
    ///
    /// The given hue expects a value between `0.0` and `1.0` where `0.0` is 0 degress and `1.0` is
    /// 360 degrees (or 2 PI radians).
    ///
    /// See the [wikipedia entry](https://en.wikipedia.org/wiki/HSL_and_HSV) for more details on
    /// this color space.
    fn hsv(self, h: S, s: S, v: S) -> Self
    where
        S: Into<color::RgbHue<S>>,
    {
        let hue = h * S::from(360.0).unwrap();
        self.color(color::Hsv::new(hue.into(), s, v))
    }

    /// Specify the color via hue, saturation, *value* (brightness) and an alpha channel.
    ///
    /// This is sometimes also known as "hsba".
    ///
    /// The given hue expects a value between `0.0` and `1.0` where `0.0` is 0 degress and `1.0` is
    /// 360 degrees (or 2 PI radians).
    ///
    /// See the [wikipedia entry](https://en.wikipedia.org/wiki/HSL_and_HSV) for more details on
    /// this color space.
    fn hsva(self, h: S, s: S, v: S, a: S) -> Self
    where
        S: Into<color::RgbHue<S>>,
    {
        let hue = h * S::from(360.0).unwrap();
        self.color(color::Hsva::new(hue.into(), s, v, a))
    }
}

impl<S> SetColor<S> for Option<Rgba<S>>
where
    S: Float,
{
    fn rgba_mut(&mut self) -> &mut Option<Rgba<S>> {
        self
    }
}

fn into_rgb_with_alpha<C, S>(color: C) -> Rgba<S>
where
    C: IntoColor<S>,
    S: Float + One,
{
    let color = color.into_rgb();
    let alpha = One::one();
    Alpha { color, alpha }
}

impl<S> IntoRgba<S> for color::Xyz<S>
where
    S: Float + One,
{
    fn into_rgba(self) -> Rgba<S> {
        into_rgb_with_alpha(self)
    }
}

impl<S> IntoRgba<S> for color::Yxy<S>
where
    S: Float + One,
{
    fn into_rgba(self) -> Rgba<S> {
        into_rgb_with_alpha(self)
    }
}

impl<S> IntoRgba<S> for color::Lab<S>
where
    S: Float + One,
{
    fn into_rgba(self) -> Rgba<S> {
        into_rgb_with_alpha(self)
    }
}

impl<S> IntoRgba<S> for color::Lch<S>
where
    S: Float + One,
{
    fn into_rgba(self) -> Rgba<S> {
        into_rgb_with_alpha(self)
    }
}

impl<S> IntoRgba<S> for color::Rgb<S>
where
    S: Float + One,
{
    fn into_rgba(self) -> Rgba<S> {
        into_rgb_with_alpha(self)
    }
}

impl<S> IntoRgba<S> for color::Hsl<S>
where
    S: Float + One,
{
    fn into_rgba(self) -> Rgba<S> {
        into_rgb_with_alpha(self)
    }
}

impl<S> IntoRgba<S> for color::Hsv<S>
where
    S: Float + One,
{
    fn into_rgba(self) -> Rgba<S> {
        into_rgb_with_alpha(self)
    }
}

impl<S> IntoRgba<S> for color::Hwb<S>
where
    S: Float + One,
{
    fn into_rgba(self) -> Rgba<S> {
        into_rgb_with_alpha(self)
    }
}

impl<S> IntoRgba<S> for color::Luma<S>
where
    S: Float + One,
{
    fn into_rgba(self) -> Rgba<S> {
        into_rgb_with_alpha(self)
    }
}

impl<C, S> IntoRgba<S> for Alpha<C, S>
where
    C: IntoColor<S>,
    S: Float,
{
    fn into_rgba(self) -> Rgba<S> {
        let Alpha { color, alpha } = self;
        let color = color.into_rgb();
        Alpha { color, alpha }
    }
}