TwiceAsNice  2019-02-18
Public Member Functions | Public Attributes | List of all members
Basda::RgbPixel Struct Reference

A RGB color with byte representations of red, green and blue. More...

#include <Image.h>

Collaboration diagram for Basda::RgbPixel:
Collaboration graph

Public Member Functions

 RgbPixel ()
 ctor as a black pixel. All three componets are set to zero. More...
 
 RgbPixel (Nice::U8 _r, Nice::U8 _g, Nice::U8 _b)
 ctor with full specification. More...
 
RgbPixeloperator= (Nice::U8 _rhs)
 copy ctor. More...
 
RgbPixeloperator= (const RgbPixel &_rhs)
 assignment More...
 
RgbPixeloperator+= (const RgbPixel &_rhs)
 Increase the brightness. More...
 
RgbPixeloperator+= (Nice::U8 _rhs)
 Increase the brightness. More...
 
template<typename SrcType >
 operator SrcType () const
 
 RgbPixel ()
 ctor as a black pixel. All three componets are set to zero. More...
 
 RgbPixel (Nice::U8 _r, Nice::U8 _g, Nice::U8 _b)
 ctor with full specification. More...
 
RgbPixeloperator= (Nice::U8 _rhs)
 copy ctor. More...
 
RgbPixeloperator= (const RgbPixel &_rhs)
 assignment More...
 
RgbPixeloperator+= (const RgbPixel &_rhs)
 Increase the brightness. More...
 
RgbPixeloperator+= (Nice::U8 _rhs)
 Increase the brightness. More...
 
template<typename SrcType >
 operator SrcType () const
 
 RgbPixel ()
 ctor as a black pixel. All three componets are set to zero. More...
 
 RgbPixel (Nice::U8 _r, Nice::U8 _g, Nice::U8 _b)
 ctor with full specification. More...
 
RgbPixeloperator= (Nice::U8 _rhs)
 copy ctor. More...
 
RgbPixeloperator= (const RgbPixel &_rhs)
 assignment More...
 
RgbPixeloperator+= (const RgbPixel &_rhs)
 Increase the brightness. More...
 
RgbPixeloperator+= (Nice::U8 _rhs)
 Increase the brightness. More...
 
template<typename SrcType >
 operator SrcType () const
 

Public Attributes

Nice::U8 b
 blue component (as a 8bit integer) More...
 
Nice::U8 g
 green component (as a 8bit integer) More...
 
Nice::U8 r
 red component (as a 8bit integer) More...
 

Detailed Description

A RGB color with byte representations of red, green and blue.


Constructor & Destructor Documentation

◆ RgbPixel() [1/6]

Basda::RgbPixel::RgbPixel ( )
inline

ctor as a black pixel. All three componets are set to zero.


◆ RgbPixel() [2/6]

Basda::RgbPixel::RgbPixel ( Nice::U8  _r,
Nice::U8  _g,
Nice::U8  _b 
)
inline

ctor with full specification.


Parameters
_rThe red component in the range 0..255
_gThe green component in the range 0..255
_bThe blue component in the range 0..255

◆ RgbPixel() [3/6]

Basda::RgbPixel::RgbPixel ( )
inline

ctor as a black pixel. All three componets are set to zero.


◆ RgbPixel() [4/6]

Basda::RgbPixel::RgbPixel ( Nice::U8  _r,
Nice::U8  _g,
Nice::U8  _b 
)
inline

ctor with full specification.


Parameters
_rThe red component in the range 0..255
_gThe green component in the range 0..255
_bThe blue component in the range 0..255

◆ RgbPixel() [5/6]

Basda::RgbPixel::RgbPixel ( )
inline

ctor as a black pixel. All three componets are set to zero.


◆ RgbPixel() [6/6]

Basda::RgbPixel::RgbPixel ( Nice::U8  _r,
Nice::U8  _g,
Nice::U8  _b 
)
inline

ctor with full specification.


Parameters
_rThe red component in the range 0..255
_gThe green component in the range 0..255
_bThe blue component in the range 0..255

Member Function Documentation

◆ operator SrcType() [1/3]

template<typename SrcType >
Basda::RgbPixel::operator SrcType ( ) const
inline

◆ operator SrcType() [2/3]

template<typename SrcType >
Basda::RgbPixel::operator SrcType ( ) const
inline

◆ operator SrcType() [3/3]

template<typename SrcType >
Basda::RgbPixel::operator SrcType ( ) const
inline

◆ operator+=() [1/6]

RgbPixel& Basda::RgbPixel::operator+= ( const RgbPixel _rhs)
inline

Increase the brightness.


Parameters
_rhsThe intensities of the three colors to be added to this.
Returns
The color which is the arithmetic sum of this and _rhs.

◆ operator+=() [2/6]

RgbPixel& Basda::RgbPixel::operator+= ( const RgbPixel _rhs)
inline

Increase the brightness.


Parameters
_rhsThe intensities of the three colors to be added to this.
Returns
The color which is the arithmetic sum of this and _rhs.

◆ operator+=() [3/6]

RgbPixel& Basda::RgbPixel::operator+= ( const RgbPixel _rhs)
inline

Increase the brightness.


Parameters
_rhsThe intensities of the three colors to be added to this.
Returns
The color which is the arithmetic sum of this and _rhs.

◆ operator+=() [4/6]

RgbPixel& Basda::RgbPixel::operator+= ( Nice::U8  _rhs)
inline

Increase the brightness.


Parameters
_rhsThe intensities of the three colors to be added to this.
Returns
The color which is the arithmetic sum of this and _rhs.

◆ operator+=() [5/6]

RgbPixel& Basda::RgbPixel::operator+= ( Nice::U8  _rhs)
inline

Increase the brightness.


Parameters
_rhsThe intensities of the three colors to be added to this.
Returns
The color which is the arithmetic sum of this and _rhs.

◆ operator+=() [6/6]

RgbPixel& Basda::RgbPixel::operator+= ( Nice::U8  _rhs)
inline

Increase the brightness.


Parameters
_rhsThe intensities of the three colors to be added to this.
Returns
The color which is the arithmetic sum of this and _rhs.

◆ operator=() [1/6]

RgbPixel& Basda::RgbPixel::operator= ( Nice::U8  _rhs)
inline

copy ctor.


Parameters
_rhsThe color to be copied.

◆ operator=() [2/6]

RgbPixel& Basda::RgbPixel::operator= ( Nice::U8  _rhs)
inline

copy ctor.


Parameters
_rhsThe color to be copied.

◆ operator=() [3/6]

RgbPixel& Basda::RgbPixel::operator= ( Nice::U8  _rhs)
inline

copy ctor.


Parameters
_rhsThe color to be copied.

◆ operator=() [4/6]

RgbPixel& Basda::RgbPixel::operator= ( const RgbPixel _rhs)
inline

assignment


Parameters
_rhsThe color to be assigned.

◆ operator=() [5/6]

RgbPixel& Basda::RgbPixel::operator= ( const RgbPixel _rhs)
inline

assignment


Parameters
_rhsThe color to be assigned.

◆ operator=() [6/6]

RgbPixel& Basda::RgbPixel::operator= ( const RgbPixel _rhs)
inline

assignment


Parameters
_rhsThe color to be assigned.

Member Data Documentation

◆ b

Nice::U8 Basda::RgbPixel::b

blue component (as a 8bit integer)


◆ g

Nice::U8 Basda::RgbPixel::g

green component (as a 8bit integer)


◆ r

Nice::U8 Basda::RgbPixel::r

red component (as a 8bit integer)



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