pixel-canvas 0.2.3

A crate to make it easy to build interactive computer art with just a pixel buffer.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130

//! Types and utilities to represent colors.

use std::ops::{Add, Mul, Sub};

// @Todo: Explain colors.

/// A single RGB-888 color.
// This must be repr(C) in order to directly upload to the GPU.
#[repr(C)]
#[derive(Copy, Clone, Default)]
pub struct Color {
    /// The red component.
    pub r: u8,
    /// The green component.
    pub g: u8,
    /// The blue component.
    pub b: u8,
}

impl Color {
    /// The color black.
    pub const BLACK: Color = Color { r: 0, g: 0, b: 0 };
    /// The color white.
    pub const WHITE: Color = Color {
        r: 255,
        g: 255,
        b: 255,
    };

    /// A convenience constructor for a color.
    pub fn rgb(r: u8, g: u8, b: u8) -> Color {
        Color { r, g, b }
    }
}

/// A trait to blend between two values by some factor.
pub trait Blend<T> {
    /// Blend between two values.
    /// ```rust
    /// # use pixel_canvas::prelude::*;
    /// // Blend entirely in integer math.
    /// assert_eq!(100.blend(200, 0), 100);
    /// assert_eq!(100.blend(200, 128), 150);
    /// assert_eq!(100.blend(200, 255), 200);
    /// // Blend with a floating point factor.
    /// assert_eq!(100.blend(200, 0.0), 100);
    /// assert_eq!(100.blend(200, 0.5), 150);
    /// assert_eq!(100.blend(200, 1.0), 200);
    /// ```
    fn blend(self, other: Self, factor: T) -> Self;
}

impl Blend<u8> for u8 {
    fn blend(self, other: u8, factor: u8) -> u8 {
        (self as i16 + (((other as i16 - self as i16) * (factor as i16) + 127) / 255)) as u8
    }
}

impl Blend<u8> for Color {
    fn blend(self, other: Color, factor: u8) -> Color {
        Color {
            r: self.r.blend(other.r, factor),
            g: self.g.blend(other.g, factor),
            b: self.b.blend(other.b, factor),
        }
    }
}

impl Blend<f32> for u8 {
    fn blend(self, other: u8, factor: f32) -> u8 {
        (self as f32 * (1.0 - factor) + other as f32 * factor) as u8
    }
}

impl Blend<f32> for Color {
    fn blend(self, other: Color, factor: f32) -> Color {
        Color {
            r: self.r.blend(other.r, factor),
            g: self.g.blend(other.g, factor),
            b: self.b.blend(other.b, factor),
        }
    }
}

impl Add<Color> for Color {
    type Output = Color;
    fn add(self, rhs: Color) -> Color {
        Color {
            r: self.r.saturating_add(rhs.r),
            g: self.g.saturating_add(rhs.g),
            b: self.b.saturating_add(rhs.b),
        }
    }
}

impl Sub<Color> for Color {
    type Output = Color;
    fn sub(self, rhs: Color) -> Color {
        Color {
            r: self.r.saturating_sub(rhs.r),
            g: self.g.saturating_sub(rhs.g),
            b: self.b.saturating_sub(rhs.b),
        }
    }
}

impl Mul<Color> for Color {
    type Output = Color;
    fn mul(self, rhs: Color) -> Color {
        Color {
            r: ((self.r as u16 * rhs.r as u16) >> 8) as u8,
            g: ((self.g as u16 * rhs.g as u16) >> 8) as u8,
            b: ((self.b as u16 * rhs.b as u16) >> 8) as u8,
        }
    }
}

impl Mul<u8> for Color {
    type Output = Color;
    fn mul(self, rhs: u8) -> Color {
        Color::BLACK.blend(self, rhs)
    }
}

impl Mul<f32> for Color {
    type Output = Color;
    fn mul(self, rhs: f32) -> Color {
        Color::BLACK.blend(self, rhs)
    }
}