src/colour.h

   1 /*
   2     Copyright (C) 2014 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 <string>
  24
  25 namespace sub {
  26
  27 /** @class Colour
  28  *  @brief An RGB colour.
  29  */
  30 class Colour
  31 {
  32 public:
  33         Colour ()
  34                 : r (0)
  35                 , g (0)
  36                 , b (0)
  37         {}
  38
  39         Colour (float r, float g, float b)
  40                 : r (r)
  41                 , g (g)
  42                 , b (b)
  43         {}
  44
  45         static Colour from_argb_hex (std::string);
  46         static Colour from_rgb_hex (std::string);
  47
  48         /** red component (from 0 to 1) */
  49         float r;
  50         /** green component (from 0 to 1) */
  51         float g;
  52         /** blue component (from 0 to 1) */
  53         float b;
  54 };
  55
  56 bool
  57 operator== (Colour const & a, Colour const & b);
  58
  59 }
  60
  61 #endif