Struct launchy::Color

pub struct Color {
    pub r: f32,
    pub g: f32,
    pub b: f32,
}

A simple float-based color struct. Each component should lie in 0..=1, but it can also be outside that range. If outside, it will be clipped for some operations

Fields

r: f32

g: f32

b: f32

Implementations

impl Color

pub const BLACK: Color

pub const WHITE: Color

pub const RED: Color

pub const GREEN: Color

pub const BLUE: Color

pub const CYAN: Color

pub const MAGENTA: Color

pub const YELLOW: Color

pub fn new(r: f32, g: f32, b: f32) -> Self

Create a new color from the given red, green, and blue components

Examples:

let lime = Color::new(0.75, 1.0, 0.0);
let beige = Color::new(0.96, 0.96, 0.86);

pub fn from_hue(hue: f32) -> Self

Creates a color from a hue, starting at 0.0 (red) and ending at 1.0 (red). You can pass in any number though, because the cycle repeats (think the x in sin(x))

let red = Color::from_hue(0.0);
let orange = Color::from_hue(0.1);
let greenish_yellow = Color::from_hue(0.2);
let green = Color::from_hue(0.3);
let cyan = Color::from_hue(0.4);
let light_blue = Color::from_hue(0.5);
let blue = Color::from_hue(0.6);
let purple = Color::from_hue(0.7);
let light_pink = Color::from_hue(0.8);
let strong_pink = Color::from_hue(0.9);

pub fn red_green_color(hue: f32) -> Self

Util function that smoothly interpolates between the following 'keyframes':

• 0.00 => green
• 0.25 => yellow
• 0.50 => red
• 0.75 => yellow
• 1.00 => green

and then the cycle continues.

This function is useful to create a smooth cycling gradient of colors on non-RGB devices such as the Launchpad S.

pub fn quantize(self, range: u16) -> (u8, u8, u8)

Return a tuple of color components scaled from 0..=1 to 0..range by doing (component * range).floor().min(range - 1).max(0) on every component.

This function is used by the Canvas implementation of the Launchpads to downscale the high-precision Colors to their respective color width. For example the Launchpad S only supports four levels of brightness for its red and green component, respectively. Therefore, the Launchpad S calls .quantize(4) on a given Color to derive how that color should be represented on the Launchpad S LEDs.

pub fn mix(self, other: Color, proportion_of_other: f32) -> Color

Mix two colors together. The proportion of the second color is specified by proportion_of_other.

Examples:

let very_dark_red = Color::RED.mix(Color::BLACK, 0.9);
let orange = Color::RED.mix(Color::YELLOW, 0.5);
let dark_brown = Color::RED.mix(Color::YELLOW, 0.5).mix(Color::BLACK, 0.7);

Trait Implementations

impl Add<Color> for Color

type Output = Self

The resulting type after applying the + operator.

fn add(self, other: Self) -> Self

Performs the + operation.

impl Add<f32> for Color

type Output = Self

The resulting type after applying the + operator.

fn add(self, addend: f32) -> Self

Performs the + operation.

impl Clone for Color

fn clone(&self) -> Color

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for Color

impl Debug for Color

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Default for Color

fn default() -> Color

Returns the "default value" for a type.

impl Div<f32> for Color

type Output = Self

The resulting type after applying the / operator.

fn div(self, multiplier: f32) -> Self::Output

Performs the / operation.

impl From<Color> for Rgb888

fn from(color: Color) -> Self

Performs the conversion.

impl From<Rgb888> for Color

fn from(color: Rgb888) -> Self

Performs the conversion.

impl Mul<f32> for Color

type Output = Self

The resulting type after applying the * operator.

fn mul(self, multiplier: f32) -> Self::Output

Performs the * operation.

impl Neg for Color

type Output = Self

The resulting type after applying the - operator.

fn neg(self) -> Self

Performs the unary - operation.

impl PartialEq<Color> for Color

fn eq(&self, other: &Color) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Color) -> bool

This method tests for !=.

impl StructuralPartialEq for Color

impl Sub<Color> for Color

type Output = Self

The resulting type after applying the - operator.

fn sub(self, other: Self) -> Self

Performs the - operation.

impl Sub<f32> for Color

type Output = Self

The resulting type after applying the - operator.

fn sub(self, subtrand: f32) -> Self

Performs the - operation.

impl Sum<Color> for Color

fn sum<I: Iterator<Item = Self>>(iter: I) -> Self

Method which takes an iterator and generates Self from the elements by "summing up" the items.