CColor Struct Reference

RGBA Color structure. More...

#include <ccolor.h>

Public Member Functions
constexpr	CColor ()=default
constexpr	CColor (uint8_t red, uint8_t green, uint8_t blue, uint8_t alpha=255)
constexpr	CColor (const CColor &inColor)
Operator Methods
CColor &	operator() (uint8_t _red, uint8_t _green, uint8_t _blue, uint8_t _alpha)
CColor &	operator= (const CColor &newColor)
bool	operator!= (const CColor &other) const
bool	operator== (const CColor &other) const

Convert Methods
uint8_t	red {255}
	red component [0..255]
uint8_t	green {255}
	green component [0..255]
uint8_t	blue {255}
	blue component [0..255]
uint8_t	alpha {255}
	alpha component [0..255]
void	toHSV (double &hue, double &saturation, double &value) const
	convert to hue, saturation and value
void	fromHSV (double hue, double saturation, double value)
	convert from hue, saturation and value
void	toHSL (double &hue, double &saturation, double &lightness) const
	convert to hue, saturation and lightness
void	fromHSL (double hue, double saturation, double lightness)
	convert from hue, saturation and lightness
constexpr uint8_t	getLuma () const
	get the luma of the color
uint8_t	getLightness () const
	get the lightness of the color
template<typename T>
constexpr T	normRed () const
	get the normalized red value
template<typename T>
constexpr T	normGreen () const
	get the normalized green value
template<typename T>
constexpr T	normBlue () const
	get the normalized blue value
template<typename T>
constexpr T	normAlpha () const
	get the normalized alpha value
template<typename T>
void	setNormRed (T v)
	set the red value normalized
template<typename T>
void	setNormGreen (T v)
	set the green value normalized
template<typename T>
void	setNormBlue (T v)
	set the blue value normalized
template<typename T>
void	setNormAlpha (T v)
	set the alpha value normalized
bool	fromString (UTF8StringPtr str)
UTF8String	toString () const
static bool	isColorRepresentation (UTF8StringPtr str)

Detailed Description

RGBA Color structure.

Constructor & Destructor Documentation

CColor() [1/3]

CColor ( )

constexprdefault

CColor() [2/3]

CColor ( uint8_t red, uint8_t green, uint8_t blue, uint8_t alpha = 255 )

inlineconstexpr

CColor() [3/3]

CColor ( const CColor & inColor )

inlineconstexpr

Member Function Documentation

fromHSL()

void fromHSL	(	double	hue,
		double	saturation,
		double	lightness )

convert from hue, saturation and lightness

Parameters

hue	in degree [0..360]
saturation	normalized [0..1]
lightness	normalized [0..1]

fromHSV()

void fromHSV	(	double	hue,
		double	saturation,
		double	value )

convert from hue, saturation and value

Parameters

hue	in degree [0..360]
saturation	normalized [0..1]
value	normalized [0..1]

fromString()

bool fromString

(

UTF8StringPtr

str

)

getLightness()

uint8_t getLightness

(

)

const

get the lightness of the color

getLuma()

uint8_t getLuma ( ) const

inlineconstexpr

get the luma of the color

isColorRepresentation()

bool isColorRepresentation ( UTF8StringPtr str )

static

normAlpha()

template<typename T>

T normAlpha ( ) const

constexpr

get the normalized alpha value

normBlue()

template<typename T>

T normBlue ( ) const

constexpr

get the normalized blue value

normGreen()

template<typename T>

T normGreen ( ) const

constexpr

get the normalized green value

normRed()

template<typename T>

T normRed ( ) const

constexpr

get the normalized red value

operator!=()

bool operator!= ( const CColor & other ) const

inline

operator()()

CColor & operator() ( uint8_t _red, uint8_t _green, uint8_t _blue, uint8_t _alpha )

inline

operator=()

CColor & operator= ( const CColor & newColor )

inline

operator==()

bool operator== ( const CColor & other ) const

inline

setNormAlpha()

template<typename T>

void setNormAlpha

(

T

v

)

set the alpha value normalized

setNormBlue()

template<typename T>

void setNormBlue

(

T

v

)

set the blue value normalized

setNormGreen()

template<typename T>

void setNormGreen

(

T

v

)

set the green value normalized

setNormRed()

template<typename T>

void setNormRed

(

T

v

)

set the red value normalized

toHSL()

void toHSL	(	double &	hue,
		double &	saturation,
		double &	lightness ) const

convert to hue, saturation and lightness

Parameters

hue	in degree [0..360]
saturation	normalized [0..1]
lightness	normalized [0..1]

toHSV()

void toHSV	(	double &	hue,
		double &	saturation,
		double &	value ) const

convert to hue, saturation and value

Parameters

hue	in degree [0..360]
saturation	normalized [0..1]
value	normalized [0..1]

toString()

UTF8String toString

(

)

const

Member Data Documentation

alpha

uint8_t alpha {255}

alpha component [0..255]

blue

uint8_t blue {255}

blue component [0..255]

green

uint8_t green {255}

green component [0..255]

red

uint8_t red {255}

red component [0..255]

---

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

• ccolor.h
• ccolor.cpp