byteplug 0.0.1

Minimalistic Multimedia Library
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
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149

// Copyright (c) 2020 - Jonathan De Wachter
//
// This source file is part of the Byteplug framework which is released under the MIT license.
// Please refer to the LICENSE file that can be found at the root of the project directory.
//
// Written by Jonathan De Wachter <dewachter.jonathan@gmail.com>, January 2020

use std::default::Default;
use std::cmp;
use std::ops::{Add, AddAssign};

/// Brief description
///
/// The **Color struct** is not documented yet. Pull requests are welcome.
///
#[derive(Debug, Copy, Clone, Eq, PartialEq)]
pub struct Color {
    pub red:   u8,
    pub green: u8,
    pub blue:  u8,
    pub alpha: u8
}

impl Color {
    pub fn new() -> Color {
        Color {
            red:   0,
            green: 0,
            blue:  0,
            alpha: 255
        }
    }

    pub fn rgb(red: u8, green: u8, blue: u8) -> Color {
        Color {
            red:   red,
            green: green,
            blue:  blue,
            alpha: 255
        }
    }

    pub fn rgba(red: u8, green: u8, blue: u8, alpha: u8) -> Color {
        Color {
            red:   red,
            green: green,
            blue:  blue,
            alpha: alpha
        }
    }

    pub fn argb(alpha: u8, red: u8, green: u8, blue: u8) -> Color {
        Color {
            red:   red,
            green: green,
            blue:  blue,
            alpha: alpha
        }
    }

    pub const BLACK: Color = Color {
        red:   0,
        green: 0,
        blue:  0,
        alpha: 255
    };

    pub const WHITE: Color = Color {
        red:   255,
        green: 255,
        blue:  255,
        alpha: 255
    };

    pub const RED: Color = Color {
        red:   255,
        green: 0,
        blue:  0,
        alpha: 255
    };

    pub const GREEN: Color = Color {
        red:   0,
        green: 255,
        blue:  0,
        alpha: 255
    };

    pub const BLUE: Color = Color {
        red:   0,
        green: 0,
        blue:  255,
        alpha: 255
    };

    pub const YELLOW: Color = Color {
        red:   255,
        green: 255,
        blue:  0,
        alpha: 255
    };

    pub const MAGENTA: Color = Color {
        red:   255,
        green: 0,
        blue:  255,
        alpha: 255
    };

    pub const CYAN: Color = Color {
        red:   0,
        green: 255,
        blue:  255,
        alpha: 255
    };

    pub const TRANSPARENT: Color = Color {
        red:   0,
        green: 0,
        blue:  0,
        alpha: 0
    };
}

impl Default for Color {
    fn default() -> Color {
        Color::new()
    }
}

impl Add for Color {
    type Output = Self;

    fn add(self, other: Self) -> Self {
        Self {
            // todo: can we retrieve the type of color components and use their maximum value ??
            red:   cmp::min(self.red as i32   + other.red as i32,   std::u8::MAX as i32) as u8,
            green: cmp::min(self.green as i32 + other.green as i32, std::u8::MAX as i32) as u8,
            blue:  cmp::min(self.blue as i32  + other.blue as i32,  std::u8::MAX as i32) as u8,
            alpha: cmp::min(self.alpha as i32 + other.alpha as i32, std::u8::MAX as i32) as u8
        }
    }
}

impl AddAssign for Color {
    fn add_assign(&mut self, other: Self) {
        *self = *self + other
    }
}