vpRGBa.h

/*
 * ViSP, open source Visual Servoing Platform software.
 * Copyright (C) 2005 - 2024 by Inria. All rights reserved.
 *
 * This software is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 * See the file LICENSE.txt at the root directory of this source
 * distribution for additional information about the GNU GPL.
 *
 * For using ViSP with software that can not be combined with the GNU
 * GPL, please contact Inria about acquiring a ViSP Professional
 * Edition License.
 *
 * See https://visp.inria.fr for more information.
 *
 * This software was developed at:
 * Inria Rennes - Bretagne Atlantique
 * Campus Universitaire de Beaulieu
 * 35042 Rennes Cedex
 * France
 *
 * If you have questions regarding the use of this file, please contact
 * Inria at visp@inria.fr
 *
 * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
 * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
 *
 * Description:
 * RGBA pixel.
 */
 
#ifndef VP_RGBA_H
#define VP_RGBA_H
 
#include <assert.h>
 
#include <visp3/core/vpConfig.h>
#include <visp3/core/vpColVector.h>
 
BEGIN_VISP_NAMESPACE
class VISP_EXPORT vpRGBa
{
public:
  enum AlphaDefault { alpha_default = 255 };
 
  inline vpRGBa() : R(0), G(0), B(0), A(vpRGBa::alpha_default) { }
 
  inline vpRGBa(unsigned char r, unsigned char g, unsigned char b, unsigned char a = vpRGBa::alpha_default)
    : R(r), G(g), B(b), A(a)
  { }
 
  VP_EXPLICIT inline vpRGBa(unsigned char v) : R(v), G(v), B(v), A(v) { }
 
  VP_EXPLICIT inline vpRGBa(unsigned int v) : R(v), G(v), B(v), A(v)
  {
    assert(v < 256);
  }
 
  VP_EXPLICIT inline vpRGBa(int v) : R(v), G(v), B(v), A(v)
  {
    assert(v < 256);
  }
 
  inline vpRGBa(const vpRGBa &v) : R(v.R), G(v.G), B(v.B), A(v.A) { }
 
  VP_EXPLICIT inline vpRGBa(const vpColVector &v) : R(0), G(0), B(0), A(vpRGBa::alpha_default) { *this = v; }
 
  // We cannot add here the following destructor without changing the
  // hypothesis that the size of this class is 4. With the destructor it
  // becomes 16 that does break a lot of things around image conversions
  // virtual ~vpRGBa() {}; // Not to implement
 
  vpRGBa &operator=(const unsigned char &v);
  vpRGBa &operator=(const unsigned int &v);
  vpRGBa &operator=(const int &v);
  vpRGBa &operator=(const vpRGBa &v);
#if (VISP_CXX_STANDARD >= VISP_CXX_STANDARD_11)
  vpRGBa &operator=(const vpRGBa &&v);
#endif
  vpRGBa &operator=(const vpColVector &v);
  bool operator==(const vpRGBa &v) const;
  bool operator!=(const vpRGBa &v) const;
 
  vpColVector operator-(const vpRGBa &v) const;
  vpRGBa operator+(const vpRGBa &v) const;
  vpColVector operator-(const vpColVector &v) const;
  vpColVector operator+(const vpColVector &v) const;
  vpColVector operator*(const float &v) const;
  vpColVector operator*(const double &v) const;
 
  bool operator<(const vpRGBa &v) const;
  bool operator>(const vpRGBa &v) const;
 
  friend VISP_EXPORT std::ostream &operator<<(std::ostream &os, const vpRGBa &rgba);
 
public:
  unsigned char R; 
  unsigned char G; 
  unsigned char B; 
  unsigned char A; 
 
  friend VISP_EXPORT vpRGBa operator*(const double &x, const vpRGBa &rgb);
};
END_VISP_NAMESPACE
#endif