Color.h

#pragma once
 
#include <Foundation/Math/Math.h>
#include <Foundation/Math/Vec4.h>
 
class PL_FOUNDATION_DLL plColor
{
public:
  PL_DECLARE_POD_TYPE();
 
  // *** Predefined Colors ***
public:
  static const plColor AliceBlue;            
  static const plColor AntiqueWhite;         
  static const plColor Aqua;                 
  static const plColor Aquamarine;           
  static const plColor Azure;                
  static const plColor Beige;                
  static const plColor Bisque;               
  static const plColor Black;                
  static const plColor BlanchedAlmond;       
  static const plColor Blue;                 
  static const plColor BlueViolet;           
  static const plColor Brown;                
  static const plColor BurlyWood;            
  static const plColor CadetBlue;            
  static const plColor Chartreuse;           
  static const plColor Chocolate;            
  static const plColor Coral;                
  static const plColor CornflowerBlue;       
  static const plColor Cornsilk;             
  static const plColor Crimson;              
  static const plColor Cyan;                 
  static const plColor DarkBlue;             
  static const plColor DarkCyan;             
  static const plColor DarkGoldenRod;        
  static const plColor DarkGray;             
  static const plColor DarkGrey;             
  static const plColor DarkGreen;            
  static const plColor DarkKhaki;            
  static const plColor DarkMagenta;          
  static const plColor DarkOliveGreen;       
  static const plColor DarkOrange;           
  static const plColor DarkOrchid;           
  static const plColor DarkRed;              
  static const plColor DarkSalmon;           
  static const plColor DarkSeaGreen;         
  static const plColor DarkSlateBlue;        
  static const plColor DarkSlateGray;        
  static const plColor DarkSlateGrey;        
  static const plColor DarkTurquoise;        
  static const plColor DarkViolet;           
  static const plColor DeepPink;             
  static const plColor DeepSkyBlue;          
  static const plColor DimGray;              
  static const plColor DimGrey;              
  static const plColor DodgerBlue;           
  static const plColor FireBrick;            
  static const plColor FloralWhite;          
  static const plColor ForestGreen;          
  static const plColor Fuchsia;              
  static const plColor Gainsboro;            
  static const plColor GhostWhite;           
  static const plColor Gold;                 
  static const plColor GoldenRod;            
  static const plColor Gray;                 
  static const plColor Grey;                 
  static const plColor Green;                
  static const plColor GreenYellow;          
  static const plColor HoneyDew;             
  static const plColor HotPink;              
  static const plColor IndianRed;            
  static const plColor Indigo;               
  static const plColor Ivory;                
  static const plColor Khaki;                
  static const plColor Lavender;             
  static const plColor LavenderBlush;        
  static const plColor LawnGreen;            
  static const plColor LemonChiffon;         
  static const plColor LightBlue;            
  static const plColor LightCoral;           
  static const plColor LightCyan;            
  static const plColor LightGoldenRodYellow; 
  static const plColor LightGray;            
  static const plColor LightGrey;            
  static const plColor LightGreen;           
  static const plColor LightPink;            
  static const plColor LightSalmon;          
  static const plColor LightSeaGreen;        
  static const plColor LightSkyBlue;         
  static const plColor LightSlateGray;       
  static const plColor LightSlateGrey;       
  static const plColor LightSteelBlue;       
  static const plColor LightYellow;          
  static const plColor Lime;                 
  static const plColor LimeGreen;            
  static const plColor Linen;                
  static const plColor Magenta;              
  static const plColor Maroon;               
  static const plColor MediumAquaMarine;     
  static const plColor MediumBlue;           
  static const plColor MediumOrchid;         
  static const plColor MediumPurple;         
  static const plColor MediumSeaGreen;       
  static const plColor MediumSlateBlue;      
  static const plColor MediumSpringGreen;    
  static const plColor MediumTurquoise;      
  static const plColor MediumVioletRed;      
  static const plColor MidnightBlue;         
  static const plColor MintCream;            
  static const plColor MistyRose;            
  static const plColor Moccasin;             
  static const plColor NavajoWhite;          
  static const plColor Navy;                 
  static const plColor OldLace;              
  static const plColor Olive;                
  static const plColor OliveDrab;            
  static const plColor Orange;               
  static const plColor OrangeRed;            
  static const plColor Orchid;               
  static const plColor PaleGoldenRod;        
  static const plColor PaleGreen;            
  static const plColor PaleTurquoise;        
  static const plColor PaleVioletRed;        
  static const plColor PapayaWhip;           
  static const plColor PeachPuff;            
  static const plColor Peru;                 
  static const plColor Pink;                 
  static const plColor Plum;                 
  static const plColor PowderBlue;           
  static const plColor Purple;               
  static const plColor RebeccaPurple;        
  static const plColor Red;                  
  static const plColor RosyBrown;            
  static const plColor RoyalBlue;            
  static const plColor SaddleBrown;          
  static const plColor Salmon;               
  static const plColor SandyBrown;           
  static const plColor SeaGreen;             
  static const plColor SeaShell;             
  static const plColor Sienna;               
  static const plColor Silver;               
  static const plColor SkyBlue;              
  static const plColor SlateBlue;            
  static const plColor SlateGray;            
  static const plColor SlateGrey;            
  static const plColor Snow;                 
  static const plColor SpringGreen;          
  static const plColor SteelBlue;            
  static const plColor Tan;                  
  static const plColor Teal;                 
  static const plColor Thistle;              
  static const plColor Tomato;               
  static const plColor Turquoise;            
  static const plColor Violet;               
  static const plColor Wheat;                
  static const plColor White;                
  static const plColor WhiteSmoke;           
  static const plColor Yellow;               
  static const plColor YellowGreen;          
 
  // *** Data ***
public:
  float r;
  float g;
  float b;
  float a;
 
  // *** Static Functions ***
public:
  [[nodiscard]] static plColor MakeNaN();
 
  [[nodiscard]] static plColor MakeZero();
 
  [[nodiscard]] static plColor MakeRGBA(float fLinearRed, float fLinearGreen, float fLinearBlue, float fLinearAlpha = 1.0f);
 
  // *** Constructors ***
public:
  plColor(); // [tested]
 
  constexpr plColor(float fLinearRed, float fLinearGreen, float fLinearBlue, float fLinearAlpha = 1.0f); // [tested]
 
  plColor(const plColorLinearUB& cc); // [tested]
 
  plColor(const plColorGammaUB& cc); // [tested]
 
#if PL_ENABLED(PL_MATH_CHECK_FOR_NAN)
  void AssertNotNaN() const
  {
    PL_ASSERT_ALWAYS(!IsNaN(), "This object contains NaN values. This can happen when you forgot to initialize it before using it. Please check that "
                               "all code-paths properly initialize this object.");
  }
#endif
 
  void SetRGB(float fLinearRed, float fLinearGreen, float fLinearBlue); // [tested]
 
  void SetRGBA(float fLinearRed, float fLinearGreen, float fLinearBlue, float fLinearAlpha = 1.0f); // [tested]
 
  // *** Conversion Operators/Functions ***
public:
  static plColor MakeFromKelvin(plUInt32 uiKelvin);
 
  [[nodiscard]] static plColor MakeHSV(float fHue, float fSat, float fVal); // [tested]
 
  void GetHSV(float& out_fHue, float& out_fSat, float& out_fValue) const; // [tested]
 
  const float* GetData() const { return &r; }
 
  float* GetData() { return &r; }
 
  const plVec4 GetAsVec4() const;
 
  static float GammaToLinear(float fGamma); // [tested]
  static float LinearToGamma(float fGamma); // [tested]
 
  static plVec3 GammaToLinear(const plVec3& vGamma); // [tested]
  static plVec3 LinearToGamma(const plVec3& vGamma); // [tested]
 
  // *** Color specific functions ***
public:
  bool IsNormalized() const; // [tested]
 
  float CalcAverageRGB() const;
 
  float GetSaturation() const; // [tested]
 
  float GetLuminance() const; 
 
  plColor GetInvertedColor() const; // [tested]
 
  plColor GetComplementaryColor() const; // [tested]
 
  void ScaleRGB(float fFactor);
 
  void ScaleRGBA(float fFactor);
 
  float ComputeHdrMultiplier() const;
 
  float ComputeHdrExposureValue() const;
 
  void ApplyHdrExposureValue(float fEv);
 
  void NormalizeToLdrRange();
 
  plColor GetDarker(float fFactor = 2.0f) const;
 
  // *** Numeric properties ***
public:
  bool IsNaN() const; // [tested]
 
  bool IsValid() const; // [tested]
 
  // *** Operators ***
public:
  void operator=(const plColorLinearUB& cc); // [tested]
 
  void operator=(const plColorGammaUB& cc); // [tested]
 
  void operator+=(const plColor& rhs); // [tested]
 
  void operator-=(const plColor& rhs); // [tested]
 
  void operator*=(const plColor& rhs); // [tested]
 
  void operator*=(float f); // [tested]
 
  void operator/=(float f); // [tested]
 
  void operator*=(const plMat4& rhs); // [tested]
 
  bool IsIdenticalRGB(const plColor& rhs) const; // [tested]
 
  bool IsIdenticalRGBA(const plColor& rhs) const; // [tested]
 
  bool IsEqualRGB(const plColor& rhs, float fEpsilon) const; // [tested]
 
  bool IsEqualRGBA(const plColor& rhs, float fEpsilon) const; // [tested]
 
  plColor WithAlpha(float fAlpha) const;
 
  [[nodiscard]] plUInt32 ToRGBA8() const;
 
  [[nodiscard]] plUInt32 ToABGR8() const;
};
 
// *** Operators ***
 
const plColor operator+(const plColor& c1, const plColor& c2); // [tested]
 
const plColor operator-(const plColor& c1, const plColor& c2); // [tested]
 
const plColor operator*(const plColor& c1, const plColor& c2); // [tested]
 
const plColor operator*(float f, const plColor& c); // [tested]
 
const plColor operator*(const plColor& c, float f); // [tested]
 
const plColor operator/(const plColor& c, float f); // [tested]
 
const plColor operator*(const plMat4& lhs, const plColor& rhs); // [tested]
 
bool operator==(const plColor& c1, const plColor& c2); // [tested]
 
bool operator!=(const plColor& c1, const plColor& c2); // [tested]
 
bool operator<(const plColor& c1, const plColor& c2); // [tested]
 
static_assert(sizeof(plColor) == 16);
 
#include <Foundation/Math/Implementation/Color_inl.h>