#include <visp3/core/vpRGBa.h>

Inheritance diagram for vpRGBa:

Public Member Functions
	vpRGBa ()

	vpRGBa (const unsigned char &r, const unsigned char &g, const unsigned char &b, const unsigned char &a=0)

	vpRGBa (const unsigned char &v)

	vpRGBa (const vpRGBa &v)

	vpRGBa (const vpColVector &v)

vpRGBa &	operator= (const unsigned char &v)

vpRGBa &	operator= (const vpRGBa &v)

vpRGBa &	operator= (const vpColVector &v)

bool	operator== (const vpRGBa &v)

bool	operator!= (const vpRGBa &v)

vpColVector	operator- (const vpRGBa &v) const

vpRGBa	operator+ (const vpRGBa &v) const

vpColVector	operator- (const vpColVector &v) const

vpColVector	operator+ (const vpColVector &v) const

vpColVector	operator* (const float &v) const

vpColVector	operator* (const double &v) const

bool	operator< (const vpRGBa &v) const

bool	operator> (const vpRGBa &v) const

Public Attributes
unsigned char	R

unsigned char	G

unsigned char	B

unsigned char	A

Friends
VISP_EXPORT vpRGBa	operator* (const double &x, const vpRGBa &rgb)

Detailed Description

Class that defines a RGB 32 bits structure.

Define the object vpRGBa that is used to build color images (it define a RGB 32 bits structure, fourth byte is not used)

See also: vpImage

Examples:: servoMomentImage.cpp, testConversion.cpp, testDisplayRoi.cpp, testImageBinarise.cpp, testPerformanceLUT.cpp, and tutorial-image-manipulation.cpp.

Definition at line 64 of file vpRGBa.h.

Constructor & Destructor Documentation

vpRGBa::vpRGBa ( )

inline

Basic constructor.

Build a black value.

Definition at line 73 of file vpRGBa.h.

vpRGBa::vpRGBa	(	const unsigned char &	r,
		const unsigned char &	g,
		const unsigned char &	b,
		const unsigned char &	a = `0`
	)

inline

Constructor.

Initialize the color with R, G, B, A values.

Parameters

r	: Red value.
g	: Green value.
b	: Blue value.
a	: Additional value.

Definition at line 86 of file vpRGBa.h.

vpRGBa::vpRGBa ( const unsigned char & v )

inline

Constructor.

Initialize all the R, G, B, A components to v.

Parameters

v	: Value to set.

Definition at line 99 of file vpRGBa.h.

vpRGBa::vpRGBa ( const vpRGBa & v )

inline

Copy constructor.

Definition at line 105 of file vpRGBa.h.

vpRGBa::vpRGBa ( const vpColVector & v )

inline

Create a RGBa value from a 4 dimension column vector.

R=v[0] G=v[1] B=v[2] A=v[3]

Definition at line 116 of file vpRGBa.h.

Member Function Documentation

bool vpRGBa::operator!= ( const vpRGBa & v )

Compare two color pixels.

Returns: true if the images are different, false if they are the same.

Definition at line 126 of file vpRGBa.cpp.

References A, B, G, and R.

vpColVector vpRGBa::operator* ( const float & v ) const

Multiplication operator : v * "this".

Parameters

v	: Value to multiply.

Returns: v * "this"

Definition at line 202 of file vpRGBa.cpp.

References A, B, G, and R.

vpColVector vpRGBa::operator* ( const double & v ) const

Multiplication operator : v * "this".

Parameters

v	: Value to multiply.

Returns: v * "this"

Definition at line 218 of file vpRGBa.cpp.

References A, B, G, and R.

vpRGBa vpRGBa::operator+ ( const vpRGBa & v ) const

Addition operator : "this" + v.

Parameters

v	: Color to add to the current object "this".

Returns: "this" + v

Warning: in case of overflow : e.g. 128+128 returns 0 for all 4 channels

Definition at line 154 of file vpRGBa.cpp.

References A, B, G, and R.

vpColVector vpRGBa::operator+ ( const vpColVector & v ) const

Addition operator : "this" + v.

Parameters

v	: Color to add to the current object "this".

Returns: "this" + v

Definition at line 186 of file vpRGBa.cpp.

References A, B, G, and R.

vpColVector vpRGBa::operator- ( const vpRGBa & v ) const

Substraction operator : "this" - v.

Parameters

v	: Color to substract to the current object "this".

Returns: "this" - v

Definition at line 137 of file vpRGBa.cpp.

References A, B, G, and R.

vpColVector vpRGBa::operator- ( const vpColVector & v ) const

Substraction operator : "this" - v.

Parameters

v	: Color to substract to the current object "this".

Returns: "this" - v

Definition at line 170 of file vpRGBa.cpp.

References A, B, G, and R.

bool vpRGBa::operator< ( const vpRGBa & v ) const

Definition at line 229 of file vpRGBa.cpp.

References B, G, and R.

vpRGBa & vpRGBa::operator= ( const unsigned char & v )

Copy operator (from an unsigned char value)

Parameters

v	: Input color ( R = G = B = v )

Definition at line 58 of file vpRGBa.cpp.

References A, B, G, and R.

vpRGBa & vpRGBa::operator= ( const vpRGBa & v )

Copy operator.

Definition at line 71 of file vpRGBa.cpp.

References A, B, G, and R.

vpRGBa & vpRGBa::operator= ( const vpColVector & v )

Cast a vpColVector in a vpRGBa

Parameters

v	: Input vector. v[0], v[1], v[2], v[3] are to make into relation with respectively R, G, B and A.

Exceptions

vpException::dimensionError : If v is not a 4 four dimention vector.

Definition at line 90 of file vpRGBa.cpp.

References A, B, vpException::dimensionError, G, vpArray2D< Type >::getRows(), R, and vpERROR_TRACE.

bool vpRGBa::operator== ( const vpRGBa & v )

Compare two RGBa values.

Returns: true if the values are the same, false otherwise.

Definition at line 108 of file vpRGBa.cpp.

References A, B, G, and R.

bool vpRGBa::operator> ( const vpRGBa & v ) const

Definition at line 238 of file vpRGBa.cpp.

References B, G, and R.

Friends And Related Function Documentation

VISP_EXPORT vpRGBa operator*	(	const double &	x,
		const vpRGBa &	rgb
	)

friend

Definition at line 246 of file vpRGBa.cpp.

Member Data Documentation

unsigned char vpRGBa::A

Additionnal component.

Examples:: testPerformanceLUT.cpp.

Definition at line 145 of file vpRGBa.h.

Referenced by vpImageConvert::convert(), vpDisplayX::getImage(), vpImageConvert::merge(), operator!=(), operator*(), operator+(), operator-(), operator=(), and operator==().

unsigned char vpRGBa::B

Blue component.

Examples:: testPerformanceLUT.cpp.

Definition at line 144 of file vpRGBa.h.

Referenced by vpDisplayX::clearDisplay(), vpImageConvert::convert(), vpDisplayGTK::displayCharString(), vpDisplayX::displayCharString(), vpDisplayOpenCV::displayCharString(), vpDisplayGTK::displayCircle(), vpDisplayX::displayCircle(), vpDisplayOpenCV::displayCircle(), vpDisplayGTK::displayDotLine(), vpDisplayX::displayDotLine(), vpDisplayOpenCV::displayDotLine(), vpDisplayX::displayImage(), vpDisplayGTK::displayLine(), vpDisplayX::displayLine(), vpDisplayOpenCV::displayLine(), vpDisplayGTK::displayPoint(), vpDisplayX::displayPoint(), vpDisplayGTK::displayRectangle(), vpDisplayX::displayRectangle(), vpDisplayOpenCV::displayRectangle(), vpDisplayX::getImage(), vpImageSimulator::getImage(), vpDisplayX::init(), vpDisplayOpenCV::init(), vpImageConvert::merge(), operator!=(), operator*(), operator+(), operator-(), operator<(), operator=(), operator==(), operator>(), vpImageIo::readPPM(), and vpImageIo::writePPM().

unsigned char vpRGBa::G

Green component.

Examples:: testPerformanceLUT.cpp.

Definition at line 143 of file vpRGBa.h.

Referenced by vpDisplayX::clearDisplay(), vpImageConvert::convert(), vpDisplayGTK::displayCharString(), vpDisplayX::displayCharString(), vpDisplayOpenCV::displayCharString(), vpDisplayGTK::displayCircle(), vpDisplayX::displayCircle(), vpDisplayOpenCV::displayCircle(), vpDisplayGTK::displayDotLine(), vpDisplayX::displayDotLine(), vpDisplayOpenCV::displayDotLine(), vpDisplayX::displayImage(), vpDisplayGTK::displayLine(), vpDisplayX::displayLine(), vpDisplayOpenCV::displayLine(), vpDisplayGTK::displayPoint(), vpDisplayX::displayPoint(), vpDisplayGTK::displayRectangle(), vpDisplayX::displayRectangle(), vpDisplayOpenCV::displayRectangle(), vpDisplayX::getImage(), vpImageSimulator::getImage(), vpDisplayX::init(), vpDisplayOpenCV::init(), vpImageConvert::merge(), operator!=(), operator*(), operator+(), operator-(), operator<(), operator=(), operator==(), operator>(), vpImageIo::readPPM(), and vpImageIo::writePPM().

unsigned char vpRGBa::R

Red component.

Examples:: testPerformanceLUT.cpp.

Definition at line 142 of file vpRGBa.h.

Referenced by vpDisplayX::clearDisplay(), vpImageConvert::convert(), vpDisplayGTK::displayCharString(), vpDisplayX::displayCharString(), vpDisplayOpenCV::displayCharString(), vpDisplayGTK::displayCircle(), vpDisplayX::displayCircle(), vpDisplayOpenCV::displayCircle(), vpDisplayGTK::displayDotLine(), vpDisplayX::displayDotLine(), vpDisplayOpenCV::displayDotLine(), vpDisplayX::displayImage(), vpDisplayGTK::displayLine(), vpDisplayX::displayLine(), vpDisplayOpenCV::displayLine(), vpDisplayGTK::displayPoint(), vpDisplayX::displayPoint(), vpDisplayGTK::displayRectangle(), vpDisplayX::displayRectangle(), vpDisplayOpenCV::displayRectangle(), vpDisplayX::getImage(), vpImageSimulator::getImage(), vpDisplayX::init(), vpDisplayOpenCV::init(), vpImageConvert::merge(), operator!=(), operator*(), operator+(), operator-(), operator<(), operator=(), operator==(), operator>(), vpImageIo::readPPM(), and vpImageIo::writePPM().

Public Member Functions

Public Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation