sf::Color Class Reference

Color is an utility class for manipulating colors. More...

#include <Color.hpp>

List of all members.


Public Member Functions

 Color ()
 Default constructor.
 Color (Uint32 ColorRGBA)
 Construct the color from a RGBA 32 bits integer.
 Color (Uint8 R, Uint8 G, Uint8 B, Uint8 A=255)
 Construct the color from its 4 RGBA components.
Uint32 ToRGBA () const
 Get the RGBA representation of the color.
bool operator== (const Color &Other) const
 Compare two colors (for equality).
bool operator!= (const Color &Other) const
 Compare two colors (for difference).

Public Attributes

Uint8 r
 Red component.
Uint8 g
 Green component.
Uint8 b
 Blue component.
Uint8 a
 Alpha (transparency) component.

Static Public Attributes

static const Color Black
 Black predefined color.
static const Color White
 White predefined color.
static const Color Red
 Red predefined color.
static const Color Green
 Green predefined color.
static const Color Blue
 Blue predefined color.
static const Color Yellow
 Yellow predefined color.
static const Color Magenta
 Magenta predefined color.
static const Color Cyan
 Cyan predefined color.

Detailed Description

Color is an utility class for manipulating colors.

Definition at line 39 of file Color.hpp.


Constructor & Destructor Documentation

sf::Color::Color (  ) 

Default constructor.

Definition at line 49 of file Color.cpp.

sf::Color::Color ( Uint32  ColorRGBA  )  [explicit]

Construct the color from a RGBA 32 bits integer.

Parameters:
ColorRGBA : RGBA color

Definition at line 62 of file Color.cpp.

sf::Color::Color ( Uint8  R,
Uint8  G,
Uint8  B,
Uint8  A = 255 
)

Construct the color from its 4 RGBA components.

Parameters:
R : Red component (0 .. 255)
G : Green component (0 .. 255)
B : Blue component (0 .. 255)
A : Alpha component (0 .. 255) (255 by default)

Definition at line 75 of file Color.cpp.


Member Function Documentation

Uint32 sf::Color::ToRGBA (  )  const

Get the RGBA representation of the color.

Returns:
32 bits integer representing the color in RGBA

Definition at line 88 of file Color.cpp.

bool sf::Color::operator== ( const Color Other  )  const

Compare two colors (for equality).

Parameters:
Other : Color to compare
Returns:
True if colors are equal

Definition at line 97 of file Color.cpp.

bool sf::Color::operator!= ( const Color Other  )  const

Compare two colors (for difference).

Parameters:
Other : Color to compare
Returns:
True if colors are different

Definition at line 106 of file Color.cpp.


Member Data Documentation

const Color sf::Color::Black [static]

Black predefined color.

Definition at line 99 of file Color.hpp.

const Color sf::Color::White [static]

White predefined color.

Definition at line 100 of file Color.hpp.

const Color sf::Color::Red [static]

Red predefined color.

Definition at line 101 of file Color.hpp.

const Color sf::Color::Green [static]

Green predefined color.

Definition at line 102 of file Color.hpp.

const Color sf::Color::Blue [static]

Blue predefined color.

Definition at line 103 of file Color.hpp.

const Color sf::Color::Yellow [static]

Yellow predefined color.

Definition at line 104 of file Color.hpp.

const Color sf::Color::Magenta [static]

Magenta predefined color.

Definition at line 105 of file Color.hpp.

const Color sf::Color::Cyan [static]

Cyan predefined color.

Definition at line 106 of file Color.hpp.

Uint8 sf::Color::r

Red component.

Definition at line 111 of file Color.hpp.

Uint8 sf::Color::g

Green component.

Definition at line 112 of file Color.hpp.

Uint8 sf::Color::b

Blue component.

Definition at line 113 of file Color.hpp.

Uint8 sf::Color::a

Alpha (transparency) component.

Definition at line 114 of file Color.hpp.


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