MyGUI  3.2.0
Public Member Functions | Static Public Member Functions | Data Fields | Static Public Attributes | Friends
MyGUI::Colour Struct Reference

#include <MyGUI_Colour.h>

Public Member Functions

 Colour ()
 Colour (float _red, float _green, float _blue, float _alpha=1)
 Colour (const std::string &_value)
Colouroperator= (Colour const &_value)
bool operator== (Colour const &_value) const
bool operator!= (Colour const &_value) const
void set (float _red, float _green, float _blue, float _alpha=1)
void clear ()
std::string print () const

Static Public Member Functions

static Colour parse (const std::string &_value)
static std::ostream & operatorShiftLeft (std::ostream &_stream, const Colour &_value)
static std::istream & operatorShiftRight (std::istream &_stream, Colour &_value)

Data Fields

float red
float green
float blue
float alpha

Static Public Attributes

static const Colour Zero = Colour(0, 0, 0, 0)
static const Colour Black = Colour(0, 0, 0, 1)
static const Colour White = Colour(1, 1, 1, 1)
static const Colour Red = Colour(1, 0, 0, 1)
static const Colour Green = Colour(0, 1, 0, 1)
static const Colour Blue = Colour(0, 0, 1, 1)

Friends

std::ostream & operator<< (std::ostream &_stream, const Colour &_value)
std::istream & operator>> (std::istream &_stream, Colour &_value)

Detailed Description

Definition at line 31 of file MyGUI_Colour.h.

Constructor & Destructor Documentation

MyGUI::Colour::Colour ( )

Definition at line 35 of file MyGUI_Colour.cpp.

MyGUI::Colour::Colour ( float  _red,
float  _green,
float  _blue,
float  _alpha = 1 
)

Definition at line 43 of file MyGUI_Colour.cpp.

MyGUI::Colour::Colour ( const std::string &  _value)
explicit

Definition at line 51 of file MyGUI_Colour.cpp.

Member Function Documentation

void MyGUI::Colour::clear ( )

Definition at line 83 of file MyGUI_Colour.cpp.

bool MyGUI::Colour::operator!= ( Colour const &  _value) const

Definition at line 70 of file MyGUI_Colour.cpp.

Colour & MyGUI::Colour::operator= ( Colour const &  _value)

Definition at line 56 of file MyGUI_Colour.cpp.

bool MyGUI::Colour::operator== ( Colour const &  _value) const

Definition at line 65 of file MyGUI_Colour.cpp.

std::ostream & MyGUI::Colour::operatorShiftLeft ( std::ostream &  _stream,
const Colour _value 
)
static

Definition at line 126 of file MyGUI_Colour.cpp.

std::istream & MyGUI::Colour::operatorShiftRight ( std::istream &  _stream,
Colour _value 
)
static

Definition at line 132 of file MyGUI_Colour.cpp.

Colour MyGUI::Colour::parse ( const std::string &  _value)
static

Definition at line 95 of file MyGUI_Colour.cpp.

std::string MyGUI::Colour::print ( ) const

Definition at line 88 of file MyGUI_Colour.cpp.

void MyGUI::Colour::set ( float  _red,
float  _green,
float  _blue,
float  _alpha = 1 
)

Definition at line 75 of file MyGUI_Colour.cpp.

Friends And Related Function Documentation

std::ostream& operator<< ( std::ostream &  _stream,
const Colour _value 
)
friend

Definition at line 50 of file MyGUI_Colour.h.

std::istream& operator>> ( std::istream &  _stream,
Colour _value 
)
friend

Definition at line 55 of file MyGUI_Colour.h.

Field Documentation

float MyGUI::Colour::alpha

Definition at line 67 of file MyGUI_Colour.h.

const Colour MyGUI::Colour::Black = Colour(0, 0, 0, 1)
static

Definition at line 70 of file MyGUI_Colour.h.

float MyGUI::Colour::blue

Definition at line 66 of file MyGUI_Colour.h.

const Colour MyGUI::Colour::Blue = Colour(0, 0, 1, 1)
static

Definition at line 74 of file MyGUI_Colour.h.

float MyGUI::Colour::green

Definition at line 65 of file MyGUI_Colour.h.

const Colour MyGUI::Colour::Green = Colour(0, 1, 0, 1)
static

Definition at line 73 of file MyGUI_Colour.h.

float MyGUI::Colour::red

Definition at line 64 of file MyGUI_Colour.h.

const Colour MyGUI::Colour::Red = Colour(1, 0, 0, 1)
static

Definition at line 72 of file MyGUI_Colour.h.

const Colour MyGUI::Colour::White = Colour(1, 1, 1, 1)
static

Definition at line 71 of file MyGUI_Colour.h.

const Colour MyGUI::Colour::Zero = Colour(0, 0, 0, 0)
static

Definition at line 69 of file MyGUI_Colour.h.


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