Bial::Color Union Reference

#include <Color.hpp>

Collaboration diagram for Bial::Color:

Public Member Functions
	Color ()
	Constructor. All zero values. More...
	Color (uint val)
	Constructor. More...
	Color (uchar alpha, uchar red, uchar green, uchar blue)
	Constructor. More...
	Color (const Color &other)
	Copy Constructor. More...
	Color (Color &&other)
	Move Constructor. More...
	~Color ()
	Destructor. More...
	Color (const RealColor &other)
	Copy Constructor. More...
Color &	operator= (const Color &other)
	Copies color to this color. More...
Color &	operator= (Color &&other)
	moves color to this color. More...
const uchar &	operator[] (size_t chl) const
	Returns a constant reference of data pointed by channel chl. Same as operator()( chl ). More...
uchar &	operator[] (size_t chl)
	Returns the reference for data pointed by channle chl. Same as operator()( chl ). More...
const uchar &	operator() (size_t chl) const
	Returns a constant reference of data pointed by channel chl. Same as operator[]( chl ). More...
uchar &	operator() (size_t chl)
	Returns the reference for data pointed by channle chl. Same as operator[]( chl ). More...
void	Value (uint val)
	Updates color value with val. More...
uint	Value () const
	Returns current color value. More...
template<class O >
void	Print (O &os) const
	Prints color containts to output stream os. More...

Public Attributes
Array< uchar, 4 >	channel
uint	value

Detailed Description

Definition at line 19 of file Color.hpp.

Constructor & Destructor Documentation

Bial::Color::Color ( )

explicit

Constructor. All zero values.

Date

2015/Oct/06

Parameters

none.

Returns

none.

Warning

none.

Bial::Color::Color ( uint  val )

explicit

Constructor.

Date

2015/Oct/06

Parameters

val	The color value.

Returns

none.

Warning

none.

Bial::Color::Color	(	uchar	alpha,
		uchar	red,
		uchar	green,
		uchar	blue
	)

Constructor.

Date

2015/Oct/06

Parameters

chl	The color channels.

Returns

none.

Warning

none.

Bial::Color::Color

(

const Color &

other

)

Copy Constructor.

Date

2015/Oct/06

Version

1.0.00

Parameters

other

Other Color.

Returns

none.

Warning

none.

Bial::Color::Color

(

Color &&

other

)

Move Constructor.

Date

2015/Oct/06

Version

1.0.00

Parameters

unamed

Other Color.

Returns

none.

Warning

none.

Bial::Color::~Color ( )

inline

Destructor.

Date

2015/Oct/06

Version

1.0.00

Parameters

unamed

Other Color.

Returns

none.

Warning

none.

Definition at line 82 of file Color.hpp.

Bial::Color::Color

(

const RealColor &

other

)

Copy Constructor.

Date

2015/Oct/27

Version

1.0.00

Parameters

other

Other RealColor.

Returns

none.

Warning

none.

Member Function Documentation

const uchar& Bial::Color::operator()

(

size_t

chl

)

const

Returns a constant reference of data pointed by channel chl. Same as operator[]( chl ).

Date

2015/Oct/06

Parameters

chl	a channel to be acessed.

Returns

Constant reference of data pointed by channel chl.

Warning

Channel bounds are not verified.

uchar& Bial::Color::operator()

(

size_t

chl

)

Returns the reference for data pointed by channle chl. Same as operator[]( chl ).

Date

2015/Oct/06

Parameters

chl	a channel to be acessed.

Returns

Reference of data pointed by channel chl.

Warning

Channel bounds are not verified.

Color& Bial::Color::operator=

(

const Color &

other

)

Copies color to this color.

Date

2015/Oct/06

Parameters

unamed

Color to be assigned to this.

Returns

none.

Warning

none.

Color& Bial::Color::operator=

(

Color &&

other

)

moves color to this color.

Date

2015/Oct/06

Parameters

unamed

Color to be assigned to this.

Returns

none.

Warning

none.

const uchar& Bial::Color::operator[]

(

size_t

chl

)

const

Returns a constant reference of data pointed by channel chl. Same as operator()( chl ).

Date

2015/Oct/06

Parameters

chl	a channel to be acessed.

Returns

Constant reference of data pointed by channel chl.

Warning

Channel bounds are not verified.

uchar& Bial::Color::operator[]

(

size_t

chl

)

Returns the reference for data pointed by channle chl. Same as operator()( chl ).

Date

2015/Oct/06

Parameters

chl	a channel to be acessed.

Returns

Reference of data pointed by channel chl.

Warning

Channel bounds are not verified.

template<class O >

void Bial::Color::Print

(

O &

os

)

const

Prints color containts to output stream os.

Date

2015/Oct/21

Parameters

os	an output stream.

Returns

none.

Warning

none.

Definition at line 369 of file Color.hpp.

void Bial::Color::Value

(

uint

val

)

Updates color value with val.

Date

2015/Oct/06

Parameters

val	Color new value.

Returns

none.

Warning

none.

uint Bial::Color::Value

(

)

const

Returns current color value.

Date

2015/Oct/06

Parameters

none.

Returns

Current color value.

Warning

none.

Member Data Documentation

Array< uchar, 4 > Bial::Color::channel

Definition at line 21 of file Color.hpp.

uint Bial::Color::value

Definition at line 22 of file Color.hpp.

---

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

• bial/inc/Color.hpp