Public Member Functions | Public Attributes | Friends | List of all members
sdf::v9::Color Class Reference

Defines a color. More...

#include <Types.hh>

Public Member Functions

 Color (float _r=0.0f, float _g=0.0f, float _b=0.0f, float _a=1.0f)
 Constructor. More...
 
bool operator== (const Color &_clr) const
 Equality operator. More...
 

Public Attributes

float a
 Alpha value. More...
 
float b
 Blue value. More...
 
float g
 Green value. More...
 
float r
 Red value. More...
 

Friends

std::ostream & operator<< (std::ostream &_out, const Color &_pt)
 Stream insertion operator. More...
 
std::istream & operator>> (std::istream &_in, Color &_pt)
 Stream insertion operator. More...
 

Detailed Description

Defines a color.

Constructor & Destructor Documentation

◆ Color()

sdf::v9::Color::Color ( float  _r = 0.0f,
float  _g = 0.0f,
float  _b = 0.0f,
float  _a = 1.0f 
)
inline

Constructor.

Parameters
[in]_rRed value (range 0 to 1)
[in]_gGreen value (range 0 to 1
[in]_bBlue value (range 0 to 1
[in]_aAlpha value (0=transparent, 1=opaque)
Deprecated:
Use ignition::math::Color

Member Function Documentation

◆ operator==()

bool sdf::v9::Color::operator== ( const Color _clr) const
inline

Equality operator.

Parameters
[in]_clrThe color to check for equality
Returns
True if the this color equals _clf

References a, b, sdf::v9::equal(), g, and r.

Friends And Related Function Documentation

◆ operator<<

std::ostream& operator<< ( std::ostream &  _out,
const Color _pt 
)
friend

Stream insertion operator.

Parameters
[in]_outthe output stream
[in]_ptthe color
Returns
the output stream

◆ operator>>

std::istream& operator>> ( std::istream &  _in,
Color _pt 
)
friend

Stream insertion operator.

Parameters
[in]_inthe input stream
[in]_pt

Member Data Documentation

◆ a

float sdf::v9::Color::a

Alpha value.

Referenced by operator==().

◆ b

float sdf::v9::Color::b

Blue value.

Referenced by operator==().

◆ g

float sdf::v9::Color::g

Green value.

Referenced by operator==().

◆ r

float sdf::v9::Color::r

Red value.

Referenced by operator==().


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