Public Member Functions | Public Attributes | Static Public Attributes | List of all members
ime::Colour Class Reference

RGBA colour. More...

#include <Colour.h>

Public Member Functions

 Colour ()
 Default constructor. More...
 
 Colour (unsigned int r, unsigned int g, unsigned int b, unsigned alpha=255)
 Construct the color from its 4 RGBA components. More...
 
bool operator== (const Colour &rhs)
 Check if a colour is the same as this colour. More...
 
bool operator!= (const Colour &rhs)
 Check if a colour is not the same as this colour. More...
 

Public Attributes

unsigned int red = 0
 Red component. More...
 
unsigned int green = 0
 Green component. More...
 
unsigned int blue = 0
 Blue component. More...
 
unsigned int opacity = 255
 Opacity. More...
 

Static Public Attributes

static const Colour Black
 Black. More...
 
static const Colour White
 White. More...
 
static const Colour Red
 Red. More...
 
static const Colour Green
 Green. More...
 
static const Colour Blue
 Blue. More...
 
static const Colour Yellow
 Yellow. More...
 
static const Colour Orange
 Orange. More...
 
static const Colour Cyan
 Cyan. More...
 
static const Colour Magenta
 Magenta. More...
 
static const Colour Purple
 Purple. More...
 
static const Colour Pink
 Pink. More...
 
static const Colour Grey
 Grey. More...
 
static const Colour Violet
 Violet. More...
 
static const Colour Turquoise
 Turquoise. More...
 
static const Colour Gold
 Gold. More...
 
static const Colour Transparent
 Transparent. More...
 

Detailed Description

RGBA colour.

Definition at line 34 of file Colour.h.

Constructor & Destructor Documentation

◆ Colour() [1/2]

ime::Colour::Colour ( )

Default constructor.

Constructs an opaque black color

◆ Colour() [2/2]

ime::Colour::Colour ( unsigned int  r,
unsigned int  g,
unsigned int  b,
unsigned  alpha = 255 
)

Construct the color from its 4 RGBA components.

Parameters
rRed component
gGreen component
bBlue component
alphaAlpha component

All components must be in the range [0, 255]

Member Function Documentation

◆ operator!=()

bool ime::Colour::operator!= ( const Colour &  rhs)

Check if a colour is not the same as this colour.

Parameters
rhsRight operand
Returns
True if the colours are not the same, otherwise false

◆ operator==()

bool ime::Colour::operator== ( const Colour &  rhs)

Check if a colour is the same as this colour.

Parameters
rhsRight operand
Returns
True if the colours are the same, otherwise false

Member Data Documentation

◆ Black

const Colour ime::Colour::Black
static

Black.

Definition at line 37 of file Colour.h.

◆ Blue

const Colour ime::Colour::Blue
static

Blue.

Definition at line 41 of file Colour.h.

◆ blue

unsigned int ime::Colour::blue = 0

Blue component.

Definition at line 89 of file Colour.h.

◆ Cyan

const Colour ime::Colour::Cyan
static

Cyan.

Definition at line 44 of file Colour.h.

◆ Gold

const Colour ime::Colour::Gold
static

Gold.

Definition at line 51 of file Colour.h.

◆ Green

const Colour ime::Colour::Green
static

Green.

Definition at line 40 of file Colour.h.

◆ green

unsigned int ime::Colour::green = 0

Green component.

Definition at line 88 of file Colour.h.

◆ Grey

const Colour ime::Colour::Grey
static

Grey.

Definition at line 48 of file Colour.h.

◆ Magenta

const Colour ime::Colour::Magenta
static

Magenta.

Definition at line 45 of file Colour.h.

◆ opacity

unsigned int ime::Colour::opacity = 255

Opacity.

Definition at line 90 of file Colour.h.

◆ Orange

const Colour ime::Colour::Orange
static

Orange.

Definition at line 43 of file Colour.h.

◆ Pink

const Colour ime::Colour::Pink
static

Pink.

Definition at line 47 of file Colour.h.

◆ Purple

const Colour ime::Colour::Purple
static

Purple.

Definition at line 46 of file Colour.h.

◆ Red

const Colour ime::Colour::Red
static

Red.

Definition at line 39 of file Colour.h.

◆ red

unsigned int ime::Colour::red = 0

Red component.

Definition at line 87 of file Colour.h.

◆ Transparent

const Colour ime::Colour::Transparent
static

Transparent.

Definition at line 52 of file Colour.h.

◆ Turquoise

const Colour ime::Colour::Turquoise
static

Turquoise.

Definition at line 50 of file Colour.h.

◆ Violet

const Colour ime::Colour::Violet
static

Violet.

Definition at line 49 of file Colour.h.

◆ White

const Colour ime::Colour::White
static

White.

Definition at line 38 of file Colour.h.

◆ Yellow

const Colour ime::Colour::Yellow
static

Yellow.

Definition at line 42 of file Colour.h.

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