graphics::Color Struct Reference

Class for storing color in 32-bit format. More...

#include <Color.h>

Public Member Functions
constexpr	Color () noexcept
	Constructs a transparent black color. More...
constexpr	Color (const Color &) noexcept=default
constexpr	Color (Color &&) noexcept=default
Color &	operator= (const Color &) noexcept=default
Color &	operator= (Color &&) noexcept=default
constexpr	Color (uint8_t rr, uint8_t gg, uint8_t bb, uint8_t aa=255) noexcept
	Constructs a color from individual components. More...
constexpr Color	WithOpacity (float opacity) const noexcept
	Returns a copy of this color with alpha component scaled by opacity. More...
constexpr Color	WithFloatAlpha (float alpha) const noexcept
	Returns a copy of this color with a new alpha value. Value is clamped to [0, 1]. More...
constexpr Color	WithAlpha (uint8_t alpha) const noexcept
	Returns a copy of this color with a new alpha value. More...
constexpr Color	WithoutAlpha () const noexcept
	Returns a copy of this color with the alpha set to the max. More...
constexpr uint8_t	GetRed () const noexcept
	Returns red component of this color. More...
constexpr uint8_t	GetGreen () const noexcept
	Returns green component of this color. More...
constexpr uint8_t	GetBlue () const noexcept
	Returns blue component of this color. More...
constexpr uint8_t	GetAlpha () const noexcept
	Returns alpha component of this color. More...
constexpr uint32_t	GetRGBA () const noexcept
	Returns color value as RGBA 32-bit integer. More...
constexpr uint32_t	GetABGR () const noexcept
	Returns color value as ABGR 32-bit integer. More...
constexpr uint32_t	GetRGB () const noexcept
	Returns color value as RGB integer. More...
Color &	operator+= (Color rhs) noexcept
Color &	operator-= (Color rhs) noexcept
Color &	operator*= (Color rhs) noexcept
bool	operator== (const Color &rhs) const noexcept
bool	operator!= (const Color &rhs) const noexcept

Static Public Member Functions
static constexpr Color	FromABGR (uint32_t abgr) noexcept
	Constructs a color from ABGR 32-bit integer value. More...
static constexpr Color	FromFloatRGBA (float r, float g, float b, float a) noexcept
	Constructs a color from individual floating point components. This value is clamped to [0, 1]. More...

Private Member Functions
constexpr	Color (uint32_t abgr) noexcept

Static Private Member Functions
static constexpr uint8_t	Add (uint8_t a, uint8_t b) noexcept
static constexpr uint8_t	Sub (uint8_t a, uint8_t b) noexcept
static constexpr uint8_t	Mul (uint8_t a, uint8_t b) noexcept
static constexpr uint8_t	Scale (uint8_t a, float s) noexcept
template<typename ScaleType >
static constexpr uint8_t	Lerp (uint8_t a, uint8_t b, ScaleType t)

Private Attributes
union {
uint32_t   mABGR
struct {
uint8_t   mRed
uint8_t   mGreen
uint8_t   mBlue
uint8_t   mAlpha
}
};

Friends
constexpr Color	operator+ (Color lhs, Color rhs) noexcept
constexpr Color	operator- (Color lhs, Color rhs) noexcept
constexpr Color	operator* (Color lhs, Color rhs) noexcept
template<typename ScaleType >
constexpr Color	lerp (Color lhs, Color rhs, ScaleType t)
	Performs linear interpolation between two colors. More...

Detailed Description

Class for storing color in 32-bit format.

This class is used to store color in 32-bit ABGR format. It allows to munipulate individual color components and to convert to/from other formats.

Additionally, it provides fixed-point arithmetic for color components.

Definition at line 28 of file Color.h.

Constructor & Destructor Documentation

Color() [1/5]

constexpr graphics::Color::Color ( )

inlineconstexprnoexcept

Constructs a transparent black color.

Definition at line 32 of file Color.h.

: mABGR(0) {}

Referenced by FromABGR(), FromFloatRGBA(), WithAlpha(), WithFloatAlpha(), WithOpacity(), and WithoutAlpha().

Here is the caller graph for this function:

Color() [2/5]

constexpr graphics::Color::Color ( const Color &  )

constexprdefaultnoexcept

Color() [3/5]

constexpr graphics::Color::Color ( Color &&  )

constexprdefaultnoexcept

Color() [4/5]

constexpr graphics::Color::Color ( uint8_t  rr, uint8_t  gg, uint8_t  bb, uint8_t  aa = 255  )

inlineconstexprnoexcept

Constructs a color from individual components.

Definition at line 40 of file Color.h.

       : mRed(rr)
       , mGreen(gg)
       , mBlue(bb)
       , mAlpha(aa)
   {
   }

Color() [5/5]

constexpr graphics::Color::Color ( uint32_t  abgr )

inlineexplicitconstexprprivatenoexcept

Definition at line 216 of file Color.h.

       : mABGR(abgr)
   {
   }

Member Function Documentation

Add()

static constexpr uint8_t graphics::Color::Add ( uint8_t  a, uint8_t  b  )

inlinestaticconstexprprivatenoexcept

Definition at line 179 of file Color.h.

   {
      return uint8_t((a + b) & 0xFF);
   }

FromABGR()

static constexpr Color graphics::Color::FromABGR ( uint32_t  abgr )

inlinestaticconstexprnoexcept

Constructs a color from ABGR 32-bit integer value.

Definition at line 49 of file Color.h.

   {
      return Color(abgr);
   }

References Color().

Referenced by graphics::ColorFromABGR().

Here is the call graph for this function:

Here is the caller graph for this function:

FromFloatRGBA()

static constexpr Color graphics::Color::FromFloatRGBA ( float  r, float  g, float  b, float  a  )

inlinestaticconstexprnoexcept

Constructs a color from individual floating point components. This value is clamped to [0, 1].

Definition at line 55 of file Color.h.

   {
      return Color(
         Color::Scale(255, r), Color::Scale(255, g), Color::Scale(255, b),
         Color::Scale(255, a));
   }

References Color(), and Scale().

Referenced by graphics::ColorFromFloatRGBA().

Here is the call graph for this function:

Here is the caller graph for this function:

GetABGR()

constexpr uint32_t graphics::Color::GetABGR ( ) const

inlineconstexprnoexcept

Returns color value as ABGR 32-bit integer.

Definition at line 118 of file Color.h.

   {
      return mABGR;
   }

References mABGR.

GetAlpha()

constexpr uint8_t graphics::Color::GetAlpha ( ) const

inlineconstexprnoexcept

Returns alpha component of this color.

Definition at line 105 of file Color.h.

   {
      return mAlpha;
   }

References mAlpha.

GetBlue()

constexpr uint8_t graphics::Color::GetBlue ( ) const

inlineconstexprnoexcept

Returns blue component of this color.

Definition at line 99 of file Color.h.

   {
      return mBlue;
   }

References mBlue.

Referenced by Triplet::SetColor().

Here is the caller graph for this function:

GetGreen()

constexpr uint8_t graphics::Color::GetGreen ( ) const

inlineconstexprnoexcept

Returns green component of this color.

Definition at line 93 of file Color.h.

   {
      return mGreen;
   }

References mGreen.

Referenced by Triplet::SetColor().

Here is the caller graph for this function:

GetRed()

constexpr uint8_t graphics::Color::GetRed ( ) const

inlineconstexprnoexcept

Returns red component of this color.

Definition at line 87 of file Color.h.

   {
      return mRed;
   }

References mRed.

Referenced by Triplet::SetColor().

Here is the caller graph for this function:

GetRGB()

constexpr uint32_t graphics::Color::GetRGB ( ) const

inlineconstexprnoexcept

Returns color value as RGB integer.

Definition at line 124 of file Color.h.

   {
      return (uint32_t(mRed) << 16) + (uint32_t(mGreen) << 8) +
             (uint32_t(mBlue));
   }

References mBlue, mGreen, and mRed.

GetRGBA()

constexpr uint32_t graphics::Color::GetRGBA ( ) const

inlineconstexprnoexcept

Returns color value as RGBA 32-bit integer.

Definition at line 111 of file Color.h.

   {
      return (uint32_t(mRed) << 24) + (uint32_t(mGreen) << 16) +
             (uint32_t(mBlue) << 8) + (uint32_t(mAlpha));
   }

References mAlpha, mBlue, mGreen, and mRed.

Lerp()

template<typename ScaleType >

static constexpr uint8_t graphics::Color::Lerp ( uint8_t  a, uint8_t  b, ScaleType  t  )

inlinestaticconstexprprivate

Definition at line 200 of file Color.h.

   {
      static_assert(std::is_floating_point<ScaleType>::value);
 
      const auto lerpValue = (a + (b - a) * t);
 
      const auto roundLerpValue =
         static_cast<int16_t>(lerpValue + ScaleType(0.5));
 
      const auto ui8LerpValue =
         static_cast<uint8_t>(std::max<decltype(roundLerpValue)>(
            0, std::min<decltype(roundLerpValue)>(255, roundLerpValue)));
 
      return ui8LerpValue;
   }

References min().

Here is the call graph for this function:

Mul()

static constexpr uint8_t graphics::Color::Mul ( uint8_t  a, uint8_t  b  )

inlinestaticconstexprprivatenoexcept

Definition at line 189 of file Color.h.

   {
      return uint8_t((uint16_t(a) * uint16_t(b) / 255) & 0xFF);
   }

operator!=()

bool graphics::Color::operator!= ( const Color &  rhs ) const

inlinenoexcept

Definition at line 173 of file Color.h.

   {
      return mABGR != rhs.mABGR;
   }

References mABGR.

operator*=()

Color & graphics::Color::operator*= ( Color  rhs )

inlinenoexcept

Definition at line 164 of file Color.h.

   {
      return *this = *this * rhs;
   }

operator+=()

Color & graphics::Color::operator+= ( Color  rhs )

inlinenoexcept

Definition at line 154 of file Color.h.

   {
      return *this = *this + rhs;
   }

operator-=()

Color & graphics::Color::operator-= ( Color  rhs )

inlinenoexcept

Definition at line 159 of file Color.h.

   {
      return *this = *this - rhs;
   }

operator=() [1/2]

Color & graphics::Color::operator= ( Color &&  )

defaultnoexcept

operator=() [2/2]

Color & graphics::Color::operator= ( const Color &  )

defaultnoexcept

operator==()

bool graphics::Color::operator== ( const Color &  rhs ) const

inlinenoexcept

Definition at line 169 of file Color.h.

   {
      return mABGR == rhs.mABGR;
   }

References mABGR.

Scale()

static constexpr uint8_t graphics::Color::Scale ( uint8_t  a, float  s  )

inlinestaticconstexprprivatenoexcept

Definition at line 194 of file Color.h.

   {
      return uint8_t(a * std::max(0.0f, std::min(1.0f, s)) + 0.5f);
   }

References min().

Referenced by FromFloatRGBA(), WithFloatAlpha(), and WithOpacity().

Here is the call graph for this function:

Here is the caller graph for this function:

Sub()

static constexpr uint8_t graphics::Color::Sub ( uint8_t  a, uint8_t  b  )

inlinestaticconstexprprivatenoexcept

Definition at line 184 of file Color.h.

   {
      return (a > b) ? a - b : 0;
   }

WithAlpha()

constexpr Color graphics::Color::WithAlpha ( uint8_t  alpha ) const

inlineconstexprnoexcept

Returns a copy of this color with a new alpha value.

Definition at line 75 of file Color.h.

   {
      return Color(mRed, mGreen, mBlue, alpha);
   }

References Color(), mBlue, mGreen, and mRed.

Here is the call graph for this function:

WithFloatAlpha()

constexpr Color graphics::Color::WithFloatAlpha ( float  alpha ) const

inlineconstexprnoexcept

Returns a copy of this color with a new alpha value. Value is clamped to [0, 1].

Definition at line 69 of file Color.h.

   {
      return Color(mRed, mGreen, mBlue, Scale(255, alpha));
   }

References Color(), mBlue, mGreen, mRed, and Scale().

Here is the call graph for this function:

WithOpacity()

constexpr Color graphics::Color::WithOpacity ( float  opacity ) const

inlineconstexprnoexcept

Returns a copy of this color with alpha component scaled by opacity.

Definition at line 63 of file Color.h.

   {
      return Color(mRed, mGreen, mBlue, Scale(mAlpha, opacity));
   }

References Color(), mAlpha, mBlue, mGreen, mRed, and Scale().

Here is the call graph for this function:

WithoutAlpha()

constexpr Color graphics::Color::WithoutAlpha ( ) const

inlineconstexprnoexcept

Returns a copy of this color with the alpha set to the max.

Definition at line 81 of file Color.h.

   {
      return Color(mRed, mGreen, mBlue, uint8_t(255));
   }

References Color(), mBlue, mGreen, and mRed.

Here is the call graph for this function:

Friends And Related Function Documentation

lerp

template<typename ScaleType >

constexpr Color lerp ( Color  lhs, Color  rhs, ScaleType  t  )

friend

Performs linear interpolation between two colors.

Definition at line 233 of file Color.h.

{
   return { Color::Lerp(lhs.mRed, rhs.mRed, t),
            Color::Lerp(lhs.mGreen, rhs.mGreen, t),
            Color::Lerp(lhs.mBlue, rhs.mBlue, t),
            Color::Lerp(lhs.mAlpha, rhs.mAlpha, t) };
}

operator*

constexpr Color operator* ( Color  lhs, Color  rhs  )

friend

Definition at line 144 of file Color.h.

   {
      return Color(
         Mul(lhs.mRed, rhs.mRed), Mul(lhs.mGreen, rhs.mGreen),
         Mul(lhs.mBlue, rhs.mBlue), Mul(lhs.mAlpha, rhs.mAlpha));
   }

operator+

constexpr Color operator+ ( Color  lhs, Color  rhs  )

friend

Definition at line 130 of file Color.h.

   {
      return Color(
         Add(lhs.mRed, rhs.mRed), Add(lhs.mGreen, rhs.mGreen),
         Add(lhs.mBlue, rhs.mBlue), Add(lhs.mAlpha, rhs.mAlpha));
   }

operator-

constexpr Color operator- ( Color  lhs, Color  rhs  )

friend

Definition at line 137 of file Color.h.

   {
      return Color(
         Sub(lhs.mRed, rhs.mRed), Sub(lhs.mGreen, rhs.mGreen),
         Sub(lhs.mBlue, rhs.mBlue), Sub(lhs.mAlpha, rhs.mAlpha));
   }

Member Data Documentation

union { ... } graphics::Color::@111

mABGR

uint32_t graphics::Color::mABGR

Definition at line 223 of file Color.h.

Referenced by GetABGR(), operator!=(), and operator==().

mAlpha

uint8_t graphics::Color::mAlpha

Definition at line 226 of file Color.h.

Referenced by GetAlpha(), GetRGBA(), and WithOpacity().

mBlue

uint8_t graphics::Color::mBlue

Definition at line 226 of file Color.h.

Referenced by GetBlue(), GetRGB(), GetRGBA(), WithAlpha(), WithFloatAlpha(), WithOpacity(), and WithoutAlpha().

mGreen

uint8_t graphics::Color::mGreen

Definition at line 226 of file Color.h.

Referenced by GetGreen(), GetRGB(), GetRGBA(), WithAlpha(), WithFloatAlpha(), WithOpacity(), and WithoutAlpha().

mRed

uint8_t graphics::Color::mRed

Definition at line 226 of file Color.h.

Referenced by GetRed(), GetRGB(), GetRGBA(), WithAlpha(), WithFloatAlpha(), WithOpacity(), and WithoutAlpha().

---

The documentation for this struct was generated from the following file:

• Color.h