se::RGB Struct Reference

A colour represented as a Red-Green-Blue tuple with 8-bits per channel. More...

#include <rgb.hpp>

Public Attributes
std::uint8_t	r = 0x00
std::uint8_t	g = 0x00
std::uint8_t	b = 0x00

Friends
RGB	operator+ (RGB lhs, const RGB rhs)
	Add lhs and rhs channel-wise.
RGB	operator* (RGB lhs, const float t)
	Scale all channels of rhs by the factor t in the interval [0, 1] inclusive.
RGB	operator* (const float t, RGB rhs)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
bool	operator== (const RGB lhs, const RGB rhs)
bool	operator!= (const RGB lhs, const RGB rhs)
bool	operator< (const RGB lhs, const RGB rhs)
bool	operator> (const RGB lhs, const RGB rhs)
bool	operator<= (const RGB lhs, const RGB rhs)
bool	operator>= (const RGB lhs, const RGB rhs)

Detailed Description

A colour represented as a Red-Green-Blue tuple with 8-bits per channel.

Friends And Related Symbol Documentation

operator+

RGB operator+ ( RGB  lhs, const RGB  rhs  )

friend

Add lhs and rhs channel-wise.

Needed for interpolation.

Warning

Assumes no overflow can happen.

operator* [1/2]

RGB operator* ( RGB  lhs, const float  t  )

friend

Scale all channels of rhs by the factor t in the interval [0, 1] inclusive.

Needed for interpolation.

operator* [2/2]

RGB operator* ( const float  t, RGB  rhs  )

friend

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

operator==

bool operator== ( const RGB  lhs, const RGB  rhs  )

friend

operator!=

bool operator!= ( const RGB  lhs, const RGB  rhs  )

friend

operator<

bool operator< ( const RGB  lhs, const RGB  rhs  )

friend

operator>

bool operator> ( const RGB  lhs, const RGB  rhs  )

friend

operator<=

bool operator<= ( const RGB  lhs, const RGB  rhs  )

friend

operator>=

bool operator>= ( const RGB  lhs, const RGB  rhs  )

friend

Member Data Documentation

r

std::uint8_t se::RGB::r = 0x00

g

std::uint8_t se::RGB::g = 0x00

b

std::uint8_t se::RGB::b = 0x00

---

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

• include/se/common/rgb.hpp