rayimg 0.1.2

Renders image of some scene using ray tracing.
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
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165

use std::ops::{Add, Sub, Mul, Div, Neg, AddAssign, SubAssign, MulAssign};

/// Color structure with components in interval `0.0..=1.0`.
/// ```
/// use rayimg::RGB;
///
/// let light_green = RGB(0.0, 1.0, 0.5);
/// let brown = RGB::new(0.39, 0.26, 0.13);
///
/// assert_eq!(light_green.as_bytes(), [0, 255, 128]);
/// assert_eq!(brown.as_bytes(), [99, 66, 33]);
/// ```
#[derive(Debug, Default, Clone, PartialEq)]
pub struct RGB(pub f64, pub f64, pub f64);

impl RGB {
    const ALMOST_BYTE_MAX: f64 = 256.0 - f64::EPSILON;

    /// Creates new `RGB`.
    /// ```
    /// # use rayimg::RGB;
    /// let light_green = RGB::new(0.0, 1.0, 0.5);
    /// assert!(light_green.r() == 0.0 && light_green.g() == 1.0 && light_green.b() == 0.5);
    /// ```
    pub fn new(r: f64, g: f64, b: f64) -> Self {
        RGB(r, g, b)
    }

    /// Returns red component of color.
    /// ```
    /// # use rayimg::RGB;
    /// let brown = RGB::new(0.39, 0.26, 0.13);
    /// assert_eq!(brown.r(), 0.39);
    /// ```
    pub fn r(&self) -> f64 {
        self.0
    }

    /// Returns green component of color.
    /// ```
    /// # use rayimg::RGB;
    /// let brown = RGB::new(0.39, 0.26, 0.13);
    /// assert_eq!(brown.g(), 0.26);
    /// ```
    pub fn g(&self) -> f64 {
        self.1
    }

    /// Returns blue component color.
    /// ```
    /// # use rayimg::RGB;
    /// let brown = RGB::new(0.39, 0.26, 0.13);
    /// assert_eq!(brown.b(), 0.13);
    /// ```
    pub fn b(&self) -> f64 {
        self.2
    }

    /// Corrects color based on gamma value, i.e. raises each component to the power camera/gamma.
    /// ```
    /// # use rayimg::RGB;
    /// let some_color = RGB(0.01, 0.25, 0.64);
    /// assert_eq!(some_color.correct_gamma(2.0), RGB(0.1, 0.5, 0.8));
    /// ```
    pub fn correct_gamma(&self, gamma: f64) -> RGB {
        let one_over_gamma = 1.0 / gamma;
        Self(self.0.powf(one_over_gamma), self.1.powf(one_over_gamma), self.2.powf(one_over_gamma))
    }

    /// Return slice of 3 elements converted from `0.0..=1.0` to `0..=255`.
    /// ```
    /// # use rayimg::RGB;
    /// let light_green = RGB::new(1.0, 1.0, 0.5);
    /// assert_eq!(light_green.as_bytes(), [255, 255, 128]);
    /// ```
    pub fn as_bytes(&self) -> [u8; 3] {
        [(self.0 * Self::ALMOST_BYTE_MAX) as u8, (self.1 * Self::ALMOST_BYTE_MAX) as u8, (self.2 * Self::ALMOST_BYTE_MAX) as u8]
    }
}

impl Add<f64> for RGB {
    type Output = Self;

    fn add(self, scalar: f64) -> Self::Output {
        Self(self.0 + scalar, self.1 + scalar, self.2 + scalar)
    }
}

impl Sub<f64> for RGB {
    type Output = Self;

    fn sub(self, scalar: f64) -> Self::Output {
        self + (-scalar)
    }
}

impl Mul<f64> for RGB {
    type Output = Self;

    fn mul(self, scalar: f64) -> Self::Output {
        Self(self.0 * scalar, self.1 * scalar, self.2 * scalar)
    }
}

impl Div<f64> for RGB {
    type Output = Self;

    fn div(self, scalar: f64) -> Self::Output {
        self * (1.0 / scalar)
    }
}

impl Add<RGB> for RGB {
    type Output = Self;

    fn add(self, rhs: Self) -> Self::Output {
        Self(self.0 + rhs.0, self.1 + rhs.1, self.2 + rhs.2)
    }
}

impl Sub<RGB> for RGB {
    type Output = Self;

    fn sub(self, rhs: Self) -> Self::Output {
        self + (-rhs)
    }
}

impl Mul<RGB> for RGB {
    type Output = Self;

    fn mul(self, rhs: Self) -> Self::Output {
        Self(self.0 * rhs.0, self.1 * rhs.1, self.2 * rhs.2)
    }
}

impl Neg for RGB {
    type Output = Self;

    fn neg(self) -> Self::Output {
        Self(-self.0, -self.1, -self.2)
    }
}

impl AddAssign<RGB> for RGB {
    fn add_assign(&mut self, rhs: Self) {
        self.0 += rhs.0;
        self.1 += rhs.1;
        self.2 += rhs.2;
    }
}

impl SubAssign<RGB> for RGB {
    fn sub_assign(&mut self, rhs: Self) {
        *self += -rhs;
    }
}

impl MulAssign<RGB> for RGB {
    fn mul_assign(&mut self, rhs: Self) {
        self.0 *= rhs.0;
        self.1 *= rhs.1;
        self.2 *= rhs.2;
    }
}