lv_color.h

/* Libvisual - The audio visualisation framework.
 *
 * Copyright (C) 2012      Libvisual team
 *               2004-2006 Dennis Smit
 *
 * Authors: Chong Kai Xiong <kaixiong@codeleft.sg>
 *          Dennis Smit <ds@nerds-incorporated.org>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 */

#ifndef _LV_COLOR_H
#define _LV_COLOR_H

#include <libvisual/lv_types.h>

#ifdef __cplusplus

namespace LV {

  struct LV_API Color
  {
      uint8_t r;    
      uint8_t g;    
      uint8_t b;    
      uint8_t a;    
      Color ()
          : r (0), g (0), b (0), a (0)
      {}

      Color (uint8_t r_, uint8_t g_, uint8_t b_, uint8_t a_ = 255)
          : r (r_), g(g_), b(b_), a(a_)
      {}

      friend bool operator== (Color const& c1, Color const& c2)
      {
          return ( c1.r == c2.r && c1.g == c2.g && c1.b == c2.b);
      }

      void set (uint8_t r_, uint8_t g_, uint8_t b_, uint8_t a_ = 255)
      {
          r = r_; g = g_; b = b_; a = a_;
      }

      void set_hsv (float h, float s, float v);

      void get_hsv (float& h, float& s, float& v) const;

      void set_from_uint16 (uint16_t rgb);
      void set_from_uint32 (uint32_t rgba);

      uint32_t to_uint32 () const;
      uint16_t to_uint16 () const;

      static Color const& white()
      {
          static Color color(255, 255, 255);
          return color;
      }

      static Color const& black()
      {
          static Color color(0, 0, 0);
          return color;
      }
  };

} // LV namespace

#endif // __cplusplus

LV_BEGIN_DECLS

#ifdef __cplusplus
typedef ::LV::Color VisColor;
#else
typedef struct _VisColor VisColor;
struct _VisColor
{
    uint8_t r, g, b, a; // NOTE: this must be synced with LV::Color
};
#endif

LV_API VisColor *visual_color_new   (void);
LV_API VisColor *visual_color_clone (VisColor *color);
LV_API void      visual_color_free  (VisColor *color);

LV_API int visual_color_compare (VisColor *src1, VisColor *src2);

LV_API void visual_color_copy     (VisColor *dest, VisColor *src);
LV_API void visual_color_set      (VisColor *color, uint8_t r, uint8_t g, uint8_t b);
LV_API void visual_color_set_rgba (VisColor *color, uint8_t r, uint8_t g, uint8_t b, uint8_t a);
LV_API void visual_color_set_hsv  (VisColor *color, float h, float s, float v);
LV_API void visual_color_get_hsv  (VisColor *color, float *h, float *s, float *v);

LV_API void visual_color_set_from_uint32 (VisColor *color, uint32_t rgb);
LV_API void visual_color_set_from_uint16 (VisColor *color, uint16_t rgb);

LV_API uint32_t visual_color_to_uint32 (VisColor *color);
LV_API uint16_t visual_color_to_uint16 (VisColor *color);

LV_API VisColor *visual_color_black (void);
LV_API VisColor *visual_color_white (void);

LV_END_DECLS

#endif /* _LV_COLOR_H */