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
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
use num::Float;

use std::ops::{Add, Sub, Mul, Div};
use std::marker::PhantomData;

use {Alpha, Xyz, Yxy};
use {Limited, Mix, Shade, FromColor, Blend, ComponentWise};
use white_point::{WhitePoint, D65};
use {clamp, flt};
use blend::PreAlpha;

///Linear luminance with an alpha component. See the [`Lumaa` implementation in `Alpha`](struct.Alpha.html#Lumaa).
pub type Lumaa<Wp = D65, T = f32> = Alpha<Luma<Wp, T>, T>;

///Linear luminance.
///
///Luma is a purely gray scale color space, which is included more for
///completeness than anything else, and represents how bright a color is
///perceived to be. It's basically the `Y` component of [CIE
///XYZ](struct.Xyz.html). The lack of any form of hue representation limits
///the set of operations that can be performed on it.
#[derive(Debug, PartialEq)]
pub struct Luma<Wp = D65, T = f32>
    where T: Float,
        Wp: WhitePoint<T>
{
    ///The lightness of the color. 0.0 is black and 1.0 is white.
    pub luma: T,

    ///The white point associated with the color's illuminant and observer.
    ///D65 for 2 degree observer is used by default.
    pub white_point: PhantomData<Wp>,

}

impl<Wp, T> Copy for Luma<Wp, T>
    where T: Float,
        Wp: WhitePoint<T>
{}

impl<Wp, T> Clone for Luma<Wp, T>
    where T: Float,
        Wp: WhitePoint<T>
{
    fn clone(&self) -> Luma<Wp, T> { *self }
}

impl<T> Luma<D65, T>
    where T: Float,
{
    ///Linear luminance with white point D65.
    pub fn new(luma: T) -> Luma<D65, T> {
        Luma {
            luma: luma,
            white_point: PhantomData,
        }
    }

    ///Linear luminance from an 8 bit value with white point D65.
    pub fn new_u8(luma: u8) -> Luma<D65, T> {
        Luma {
            luma: flt::<T,_>(luma) / flt(255.0),
            white_point: PhantomData,
        }
    }

}

impl<Wp, T> Luma<Wp, T>
    where T: Float,
        Wp: WhitePoint<T>
{
    ///Linear luminance.
    pub fn with_wp(luma: T) -> Luma<Wp, T> {
        Luma {
            luma: luma,
            white_point: PhantomData,
        }
    }

    ///Linear luminance from an 8 bit value.
    pub fn with_wp_u8(luma: u8) -> Luma<Wp, T> {
        Luma {
            luma: flt::<T,_>(luma) / flt(255.0),
            white_point: PhantomData,
        }
    }
}

///<span id="Lumaa"></span>[`Lumaa`](type.Lumaa.html) implementations.
impl<T> Alpha<Luma<D65, T>, T>
    where T: Float,
{
    ///Linear luminance with transparency and white point D65.
    pub fn new(luma: T, alpha: T) -> Lumaa<D65, T> {
        Alpha {
            color: Luma::new(luma),
            alpha: alpha,
        }
    }

    ///Linear luminance and transparency from 8 bit values and white point D65.
    pub fn new_u8(luma: u8, alpha: u8) -> Lumaa<D65, T> {
        Alpha {
            color: Luma::new_u8(luma),
            alpha: flt::<T,_>(alpha) / flt(255.0),
        }
    }
}

///<span id="Lumaa"></span>[`Lumaa`](type.Lumaa.html) implementations.
impl<Wp, T> Alpha<Luma<Wp, T>, T>
    where T: Float,
        Wp: WhitePoint<T>
{
    ///Linear luminance with transparency.
    pub fn with_wp(luma: T, alpha: T) -> Lumaa<Wp, T> {
        Alpha {
            color: Luma::with_wp(luma),
            alpha: alpha,
        }
    }

    ///Linear luminance and transparency from 8 bit values.
    pub fn with_wp_u8(luma: u8, alpha: u8) -> Lumaa<Wp, T> {
        Alpha {
            color: Luma::with_wp_u8(luma),
            alpha: flt::<T,_>(alpha) / flt(255.0),
        }
    }
}

impl<Wp, T> FromColor<Wp, T> for Luma<Wp, T>
    where T: Float,
        Wp: WhitePoint<T>
{
    fn from_xyz(xyz: Xyz<Wp, T>) -> Self {
        Luma {
            luma: xyz.y,
            white_point: PhantomData,
        }
    }

    fn from_yxy(yxy: Yxy<Wp, T>) -> Self {
        Luma {
            luma: yxy.luma,
            white_point: PhantomData,
        }
    }

    fn from_luma(luma: Luma<Wp, T>) -> Self {
        luma
    }

}

impl<Wp, T> Limited for Luma<Wp, T>
    where T: Float,
        Wp: WhitePoint<T>
{
    fn is_valid(&self) -> bool {
        self.luma >= T::zero() && self.luma <= T::one()
    }

    fn clamp(&self) -> Luma<Wp, T> {
        let mut c = *self;
        c.clamp_self();
        c
    }

    fn clamp_self(&mut self) {
        self.luma = clamp(self.luma, T::zero(), T::one());
    }
}

impl<Wp, T> Mix for Luma<Wp, T>
    where T: Float,
        Wp: WhitePoint<T>
{
    type Scalar = T;

    fn mix(&self, other: &Luma<Wp, T>, factor: T) -> Luma<Wp, T> {
        let factor = clamp(factor, T::zero(), T::one());

        Luma {
            luma: self.luma + factor * (other.luma - self.luma),
            white_point: PhantomData,
        }
    }
}

impl<Wp, T> Shade for Luma<Wp, T>
    where T: Float,
        Wp: WhitePoint<T>
{
    type Scalar = T;

    fn lighten(&self, amount: T) -> Luma<Wp, T> {
        Luma {
            luma: (self.luma + amount).max(T::zero()),
            white_point: PhantomData,
        }
    }
}

impl<Wp, T> Blend for Luma<Wp, T>
    where T: Float,
        Wp: WhitePoint<T>
{
    type Color = Luma<Wp, T>;

    fn into_premultiplied(self) -> PreAlpha<Luma<Wp, T>, T> {
        Lumaa::from(self).into()
    }

    fn from_premultiplied(color: PreAlpha<Luma<Wp, T>, T>) -> Self {
        Lumaa::from(color).into()
    }
}

impl<Wp, T> ComponentWise for Luma<Wp, T>
    where T: Float,
        Wp: WhitePoint<T>
{
    type Scalar = T;

    fn component_wise<F: FnMut(T, T) -> T>(&self, other: &Luma<Wp, T>, mut f: F) -> Luma<Wp, T> {
        Luma {
            luma: f(self.luma, other.luma),
            white_point: PhantomData,
        }
    }

    fn component_wise_self<F: FnMut(T) -> T>(&self, mut f: F) -> Luma<Wp, T> {
        Luma {
            luma: f(self.luma),
            white_point: PhantomData,
        }
    }
}

impl<Wp, T> Default for Luma<Wp, T>
    where T: Float,
        Wp: WhitePoint<T>
{
    fn default() -> Luma<Wp, T> {
        Luma::with_wp(T::zero())
    }
}

impl<Wp, T> Add<Luma<Wp, T>> for Luma<Wp, T>
    where T: Float,
        Wp: WhitePoint<T>
{
    type Output = Luma<Wp, T>;

    fn add(self, other: Luma<Wp, T>) -> Luma<Wp, T> {
        Luma {
            luma: self.luma + other.luma,
            white_point: PhantomData,
        }
    }
}

impl<Wp, T> Add<T> for Luma<Wp, T>
    where T: Float,
        Wp: WhitePoint<T>
{
    type Output = Luma<Wp, T>;

    fn add(self, c: T) -> Luma<Wp, T> {
        Luma {
            luma: self.luma + c,
            white_point: PhantomData,
        }
    }
}

impl<Wp, T> Sub<Luma<Wp, T>> for Luma<Wp, T>
    where T: Float,
        Wp: WhitePoint<T>
{
    type Output = Luma<Wp, T>;

    fn sub(self, other: Luma<Wp, T>) -> Luma<Wp, T> {
        Luma {
            luma: self.luma - other.luma,
            white_point: PhantomData,
        }
    }
}

impl<Wp, T> Sub<T> for Luma<Wp, T>
    where T: Float,
        Wp: WhitePoint<T>
{
    type Output = Luma<Wp, T>;

    fn sub(self, c: T) -> Luma<Wp, T> {
        Luma {
            luma: self.luma - c,
            white_point: PhantomData,
        }
    }
}

impl<Wp, T> Mul<Luma<Wp, T>> for Luma<Wp, T>
    where T: Float,
        Wp: WhitePoint<T>
{
    type Output = Luma<Wp, T>;

    fn mul(self, other: Luma<Wp, T>) -> Luma<Wp, T> {
        Luma {
            luma: self.luma * other.luma,
            white_point: PhantomData,
        }
    }
}

impl<Wp, T> Mul<T> for Luma<Wp, T>
    where T: Float,
        Wp: WhitePoint<T>
{
    type Output = Luma<Wp, T>;

    fn mul(self, c: T) -> Luma<Wp, T> {
        Luma {
            luma: self.luma * c,
            white_point: PhantomData,
        }
    }
}

impl<Wp, T> Div<Luma<Wp, T>> for Luma<Wp, T>
    where T: Float,
        Wp: WhitePoint<T>
{
    type Output = Luma<Wp, T>;

    fn div(self, other: Luma<Wp, T>) -> Luma<Wp, T> {
        Luma {
            luma: self.luma / other.luma,
            white_point: PhantomData,
        }
    }
}

impl<Wp, T> Div<T> for Luma<Wp, T>
    where T: Float,
        Wp: WhitePoint<T>
{
    type Output = Luma<Wp, T>;

    fn div(self, c: T) -> Luma<Wp, T> {
        Luma {
            luma: self.luma / c,
            white_point: PhantomData,
        }
    }
}

#[cfg(test)]
mod test {
    use Luma;

    #[test]
    fn ranges() {
        assert_ranges!{
            Luma;
            limited {
                luma: 0.0 => 1.0
            }
            limited_min {}
            unlimited {}
        }
    }
}