Documentation of SFML 2.2

Warning: this page refers to an old version of SFML. Click here to switch to the latest version.
Color.hpp
1 //
3 // SFML - Simple and Fast Multimedia Library
4 // Copyright (C) 2007-2014 Laurent Gomila (laurent.gom@gmail.com)
5 //
6 // This software is provided 'as-is', without any express or implied warranty.
7 // In no event will the authors be held liable for any damages arising from the use of this software.
8 //
9 // Permission is granted to anyone to use this software for any purpose,
10 // including commercial applications, and to alter it and redistribute it freely,
11 // subject to the following restrictions:
12 //
13 // 1. The origin of this software must not be misrepresented;
14 // you must not claim that you wrote the original software.
15 // If you use this software in a product, an acknowledgment
16 // in the product documentation would be appreciated but is not required.
17 //
18 // 2. Altered source versions must be plainly marked as such,
19 // and must not be misrepresented as being the original software.
20 //
21 // 3. This notice may not be removed or altered from any source distribution.
22 //
24 
25 #ifndef SFML_COLOR_HPP
26 #define SFML_COLOR_HPP
27 
29 // Headers
31 #include <SFML/Graphics/Export.hpp>
32 
33 
34 namespace sf
35 {
40 class SFML_GRAPHICS_API Color
41 {
42 public:
43 
51  Color();
52 
62  Color(Uint8 red, Uint8 green, Uint8 blue, Uint8 alpha = 255);
63 
65  // Static member data
67  static const Color Black;
68  static const Color White;
69  static const Color Red;
70  static const Color Green;
71  static const Color Blue;
72  static const Color Yellow;
73  static const Color Magenta;
74  static const Color Cyan;
75  static const Color Transparent;
76 
78  // Member data
80  Uint8 r;
81  Uint8 g;
82  Uint8 b;
83  Uint8 a;
84 };
85 
98 SFML_GRAPHICS_API bool operator ==(const Color& left, const Color& right);
99 
112 SFML_GRAPHICS_API bool operator !=(const Color& left, const Color& right);
113 
127 SFML_GRAPHICS_API Color operator +(const Color& left, const Color& right);
128 
142 SFML_GRAPHICS_API Color operator -(const Color& left, const Color& right);
143 
159 SFML_GRAPHICS_API Color operator *(const Color& left, const Color& right);
160 
175 SFML_GRAPHICS_API Color& operator +=(Color& left, const Color& right);
176 
191 SFML_GRAPHICS_API Color& operator -=(Color& left, const Color& right);
192 
209 SFML_GRAPHICS_API Color& operator *=(Color& left, const Color& right);
210 
211 } // namespace sf
212 
213 
214 #endif // SFML_COLOR_HPP
215 
216 
static const Color White
White predefined color.
Definition: Color.hpp:68
Uint8 g
Green component.
Definition: Color.hpp:81
Utility class for manipulating RGBA colors.
Definition: Color.hpp:40
Definition: Listener.hpp:35
Uint8 b
Blue component.
Definition: Color.hpp:82
static const Color Blue
Blue predefined color.
Definition: Color.hpp:71
static const Color Red
Red predefined color.
Definition: Color.hpp:69
static const Color Green
Green predefined color.
Definition: Color.hpp:70
Uint8 r
Red component.
Definition: Color.hpp:80
static const Color Transparent
Transparent (black) predefined color.
Definition: Color.hpp:75
static const Color Cyan
Cyan predefined color.
Definition: Color.hpp:74
Uint8 a
Alpha (opacity) component.
Definition: Color.hpp:83
static const Color Black
Black predefined color.
Definition: Color.hpp:67
static const Color Yellow
Yellow predefined color.
Definition: Color.hpp:72
static const Color Magenta
Magenta predefined color.
Definition: Color.hpp:73