Pixel.h

Go to the documentation of this file.

// Copyright (c) 2025 Optris GmbH Co. KG

 
#pragma once
 
#include <string>
#include <ostream>
 
 
namespace optris
{

class Pixel
{
public:
  Pixel() noexcept;

  Pixel(unsigned char red, unsigned char green, unsigned char blue) noexcept;
 

   unsigned char getRed() const noexcept;

   unsigned char getGreen() const noexcept;

   unsigned char getBlue() const noexcept;
 

  bool operator==(const Pixel& rhs) const noexcept;
  bool operator!=(const Pixel& rhs) const noexcept;
 

  std::string toString() const noexcept;
 
 
private:
  unsigned char _red;
  unsigned char _green;
  unsigned char _blue;
};
 
 
// Utility functions
std::ostream& operator<<(std::ostream& out, const Pixel& pixel) noexcept;
 
 
// Inline implementations
inline Pixel::Pixel() noexcept
  : _red{0U}
  , _green{0U}
  , _blue{0U}
{ }
 
inline Pixel::Pixel(unsigned char red, unsigned char green, unsigned char blue) noexcept
  : _red{red}
  , _green{green}
  , _blue{blue}
{ }
 
inline unsigned char Pixel::getRed() const noexcept
{
  return _red;
}
 
inline unsigned char Pixel::getGreen() const noexcept
{
  return _green;
}
 
inline unsigned char Pixel::getBlue() const noexcept
{ 
  return _blue;
}
 
inline bool Pixel::operator==(const Pixel& rhs) const noexcept
{
  return _red   == rhs._red   && 
         _green == rhs._green &&
         _blue  == rhs._blue;
}
 
inline bool Pixel::operator!=(const Pixel& rhs) const noexcept
{
  return !operator==(rhs);
}
 
inline std::string Pixel::toString() const noexcept
{
  return "(" + std::to_string(_red) + ", " + std::to_string(_green) + ", " + std::to_string(_blue) + ")";
}
 
inline std::ostream& operator<<(std::ostream& out, const Pixel& pixel) noexcept
{
  out << pixel.toString();
 
  return out;
}
 
} // namespace optris