RgbColour.hpp File Reference

Classes
class	castor::RgbColourT< ComponentType >
	RGB colour representation. More...

Namespaces
namespace	castor

Functions
static String	castor::getPredefinedName (PredefinedRgbColour predefined)
	Retrieves predefined colour name.
static PredefinedRgbColour	castor::getPredefinedRgb (String const &name)
	Retrieves predefined colour from a name.
template<typename ComponentType >
bool	castor::operator== (RgbColourT< ComponentType > const &lhs, RgbColourT< ComponentType > const &rhs)
	Equality operator.
template<typename ComponentType >
bool	castor::operator!= (RgbColourT< ComponentType > const &lhs, RgbColourT< ComponentType > const &rhs)
	Inequality operator.
template<typename ComponentType >
RgbColourT< ComponentType >	castor::operator+ (RgbColourT< ComponentType > const &lhs, RgbColourT< ComponentType > const &rhs)
	addition operator
template<typename ComponentType >
RgbColourT< ComponentType >	castor::operator- (RgbColourT< ComponentType > const &lhs, RgbColourT< ComponentType > const &rhs)
	Substraction operator.
template<typename ComponentType , typename T >
RgbColourT< ComponentType >	castor::operator+ (RgbColourT< ComponentType > const &lhs, T rhs)
	addition operator
template<typename ComponentType , typename T >
RgbColourT< ComponentType >	castor::operator- (RgbColourT< ComponentType > const &lhs, T rhs)
	Subtraction operator.
template<typename ComponentType , typename T >
RgbColourT< ComponentType >	castor::operator* (RgbColourT< ComponentType > const &lhs, T rhs)
	Multiplication operator.
template<typename ComponentType , typename T >
RgbColourT< ComponentType >	castor::operator/ (RgbColourT< ComponentType > const &lhs, T rhs)
	Division operator.
Point3ub	castor::toRGBByte (RgbColourT< ColourComponent > const &colour)
	Stores a colour's components into a point in RGB format.
Point3ub	castor::toBGRByte (RgbColourT< ColourComponent > const &colour)
	Stores a colour's components into a point in BGR format.
Point4ub	castor::toRGBAByte (RgbColourT< ColourComponent > const &colour)
	Stores a colour's components into a point in RGBA format.
Point4ub	castor::toBGRAByte (RgbColourT< ColourComponent > const &colour)
	Stores a colour's components into a point in BGRA format.
Point4ub	castor::toARGBByte (RgbColourT< ColourComponent > const &colour)
	Stores a colour's components into a point in ARGB format.
Point4ub	castor::toABGRByte (RgbColourT< ColourComponent > const &colour)
	Stores a colour's components into a point in ABGR format.
template<typename ComponentType >
Point3f	castor::toRGBFloat (RgbColourT< ComponentType > const &colour)
	Stores a colour's components into a point in RGB format.
template<typename ComponentType >
Point3f	castor::toBGRFloat (RgbColourT< ComponentType > const &colour)
	Stores a colour's components into a point in BGR format.
template<typename ComponentType >
Point4f	castor::toRGBAFloat (RgbColourT< ComponentType > const &colour)
	Stores a colour's components into a point in RGBA format.
template<typename ComponentType >
Point4f	castor::toARGBFloat (RgbColourT< ComponentType > const &colour)
	Stores a colour's components into a point in ARGB format.
template<typename ComponentType >
Point4f	castor::toABGRFloat (RgbColourT< ComponentType > const &colour)
	Stores a colour's components into a point in ABGR format.
template<typename ComponentType >
Point4f	castor::toBGRAFloat (RgbColourT< ComponentType > const &colour)
	Stores a colour's components into a point in BGRA format.
uint32_t	castor::toRGBPacked (RgbColourT< ColourComponent > const &colour)
	Packs a colour's components into an uint32_t in the RGB format (0x00RRGGBB).
uint32_t	castor::toBGRPacked (RgbColourT< ColourComponent > const &colour)
	Packs a colour's components into an uint32_t in the BGR format (0x00BBGGRR).
uint32_t	castor::toARGBPacked (RgbColourT< ColourComponent > const &colour)
	Packs a colour's components into an uint32_t in the ARGB format (0xAARRGGBB).
uint32_t	castor::toRGBAPacked (RgbColourT< ColourComponent > const &colour)
	Packs a colour's components into an uint32_t in the RGBA format (0xRRGGBBAA).
uint32_t	castor::toABGRPacked (RgbColourT< ColourComponent > const &colour)
	Packs a colour's components into an uint32_t in the ABGR format (0xAABBGGRR).
uint32_t	castor::toBGRAPacked (RgbColourT< ColourComponent > const &colour)
	Packs a colour's components into an uint32_t in the BGRA format (0xBBGGRRAA).