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