FIFE::Color Class Reference

#include <color.h>

Collaboration diagram for FIFE::Color:

Public Member Functions
	Color (uint8_t r=0, uint8_t g=0, uint8_t b=0, uint8_t alpha=255)
	Constructor. More...
	~Color ()
	Destructor. More...
bool	operator== (const Color &color) const
	Compares equality of two colors. More...
bool	operator!= (const Color &color) const
	Compares unequality of two colors. More...
bool	operator< (const Color &rhs) const
	Overload less operator. More...
void	set (uint8_t r, uint8_t g, uint8_t b, uint8_t alpha)
	Set all color channel values. More...
void	setR (uint8_t r)
	Set red channel value. More...
void	setG (uint8_t g)
	Set green channel value. More...
void	setB (uint8_t b)
	Set blue channel value. More...
void	setAlpha (uint8_t alpha)
	Set alpha channel value. More...
uint8_t	getR () const
uint8_t	getG () const
uint8_t	getB () const
uint8_t	getAlpha () const

Private Attributes
uint8_t	m_r
uint8_t	m_g
uint8_t	m_b
uint8_t	m_a

Detailed Description

Definition at line 40 of file color.h.

Constructor & Destructor Documentation

FIFE::Color::Color	(	uint8_t	r = 0,
		uint8_t	g = 0,
		uint8_t	b = 0,
		uint8_t	alpha = 255
	)

Constructor.

Parameters

r	Red channel value.
g	Green channel value.
b	Blue channel value.
alpha	Alpha channel value.

Definition at line 38 of file color.cpp.

FIFE::Color::~Color

(

)

Destructor.

Definition at line 46 of file color.cpp.

Member Function Documentation

uint8_t FIFE::Color::getAlpha

(

)

const

Returns

Alpha channel value.

Definition at line 84 of file color.cpp.

References m_a.

Referenced by FIFE::OverlayColors::changeColor().

Here is the caller graph for this function:

uint8_t FIFE::Color::getB

(

)

const

Returns

Blue channel value.

Definition at line 80 of file color.cpp.

References m_b.

Referenced by FIFE::OverlayColors::changeColor().

Here is the caller graph for this function:

uint8_t FIFE::Color::getG

(

)

const

Returns

Green channel value.

Definition at line 76 of file color.cpp.

References m_g.

Referenced by FIFE::OverlayColors::changeColor().

Here is the caller graph for this function:

uint8_t FIFE::Color::getR

(

)

const

Returns

Red channel value.

Definition at line 72 of file color.cpp.

References m_r.

Referenced by FIFE::OverlayColors::changeColor().

Here is the caller graph for this function:

bool FIFE::Color::operator!= ( const Color &  color ) const

inline

Compares unequality of two colors.

Definition at line 64 of file color.h.

bool FIFE::Color::operator< ( const Color &  rhs ) const

inline

Overload less operator.

Definition at line 70 of file color.h.

References m_a, m_b, m_g, and m_r.

bool FIFE::Color::operator== ( const Color &  color ) const

inline

Compares equality of two colors.

Definition at line 58 of file color.h.

References m_a, m_b, m_g, and m_r.

void FIFE::Color::set	(	uint8_t	r,
		uint8_t	g,
		uint8_t	b,
		uint8_t	alpha
	)

Set all color channel values.

Parameters

r	Red channel value.
g	Green channel value.
b	Blue channel value.
alpha	Alpha channel value.

Definition at line 49 of file color.cpp.

References m_a, m_b, m_g, and m_r.

Referenced by FIFE::OverlayColors::changeColor(), and FIFE::LibRocketRenderInterface::RenderGeometry().

Here is the caller graph for this function:

void FIFE::Color::setAlpha

(

uint8_t

alpha

)

Set alpha channel value.

Parameters

alpha

New value.

Definition at line 68 of file color.cpp.

References m_a.

void FIFE::Color::setB

(

uint8_t

b

)

Set blue channel value.

Parameters

b	New value.

Definition at line 64 of file color.cpp.

References m_b.

void FIFE::Color::setG

(

uint8_t

g

)

Set green channel value.

Parameters

g	New value.

Definition at line 60 of file color.cpp.

References m_g.

void FIFE::Color::setR

(

uint8_t

r

)

Set red channel value.

Parameters

r	New value.

Definition at line 56 of file color.cpp.

References m_r.

Member Data Documentation

uint8_t FIFE::Color::m_a

private

Definition at line 135 of file color.h.

Referenced by getAlpha(), operator<(), operator==(), set(), and setAlpha().

uint8_t FIFE::Color::m_b

private

Definition at line 134 of file color.h.

Referenced by getB(), operator<(), operator==(), set(), and setB().

uint8_t FIFE::Color::m_g

private

Definition at line 133 of file color.h.

Referenced by getG(), operator<(), operator==(), set(), and setG().

uint8_t FIFE::Color::m_r

private

Definition at line 132 of file color.h.

Referenced by getR(), operator<(), operator==(), set(), and setR().

---

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

• engine/core/video/color.h
• engine/core/video/color.cpp