Bump version
[libsub.git] / src / colour.h
1 /*
2     Copyright (C) 2014-2018 Carl Hetherington <cth@carlh.net>
3
4     This program is free software; you can redistribute it and/or modify
5     it under the terms of the GNU General Public License as published by
6     the Free Software Foundation; either version 2 of the License, or
7     (at your option) any later version.
8
9     This program is distributed in the hope that it will be useful,
10     but WITHOUT ANY WARRANTY; without even the implied warranty of
11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12     GNU General Public License for more details.
13
14     You should have received a copy of the GNU General Public License
15     along with this program; if not, write to the Free Software
16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
17
18 */
19
20 #ifndef LIBSUB_COLOUR_H
21 #define LIBSUB_COLOUR_H
22
23 #include <dcp/types.h>
24 #include <string>
25 #include <cmath>
26
27 namespace sub {
28
29 /** @class Colour
30  *  @brief An RGB colour.
31  */
32 class Colour
33 {
34 public:
35         Colour ()
36                 : r (0)
37                 , g (0)
38                 , b (0)
39         {}
40
41         Colour (float r, float g, float b)
42                 : r (r)
43                 , g (g)
44                 , b (b)
45         {}
46
47         static Colour from_argb_hex (std::string);
48         static Colour from_rgb_hex (std::string);
49
50         /** red component (from 0 to 1) */
51         float r;
52         /** green component (from 0 to 1) */
53         float g;
54         /** blue component (from 0 to 1) */
55         float b;
56
57         dcp::Colour dcp() const {
58                 return dcp::Colour(lrintf(r * 255), lrintf(g * 255), lrintf(b * 255));
59         }
60 };
61
62 bool
63 operator== (Colour const & a, Colour const & b);
64
65 }
66
67 #endif