TGUI  0.10-dev
Color.hpp
1
2//
3// TGUI - Texus' Graphical User Interface
4// Copyright (C) 2012-2021 Bruno Van de Velde (vdv_b@tgui.eu)
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
26#ifndef TGUI_COLOR_HPP
27#define TGUI_COLOR_HPP
28
29#include <TGUI/String.hpp>
30#include <TGUI/Vertex.hpp>
31#include <cstdint>
32#include <string>
33#include <map>
34
35#if TGUI_HAS_BACKEND_SFML_GRAPHICS
36 #include <SFML/Graphics/Color.hpp>
37#endif
38
40
41namespace tgui
42{
43 class Color;
44 namespace priv
45 {
46 TGUI_API Color constructColorFromString(String string);
47 }
48
49
58#if TGUI_COMPILED_WITH_CPP_VER >= 20
59 class Color
60#else
61 class TGUI_API Color
62#endif
63 {
64 public:
65
69 static TGUI_CONSTEXPR Color applyOpacity(const Color& color, float alpha)
70 {
71 return {color.getRed(), color.getGreen(), color.getBlue(), static_cast<std::uint8_t>(color.getAlpha() * alpha)};
72 }
73
74
75 public:
76
82 TGUI_CONSTEXPR Color() :
83 m_isSet{false},
84 m_red {0},
85 m_green{0},
86 m_blue {0},
87 m_alpha{0}
88 {
89 }
90
91#if TGUI_HAS_BACKEND_SFML_GRAPHICS
97 TGUI_CONSTEXPR Color(const sf::Color& color) :
98 m_isSet{true},
99 m_red {color.r},
100 m_green{color.g},
101 m_blue {color.b},
102 m_alpha{color.a}
103 {
104 }
105#endif
106
115 TGUI_CONSTEXPR Color(std::uint8_t red, std::uint8_t green, std::uint8_t blue, std::uint8_t alpha = 255) :
116 m_isSet{true},
117 m_red {red},
118 m_green{green},
119 m_blue {blue},
120 m_alpha{alpha}
121 {
122 }
123
124
132 Color(const String& string) :
133 Color{priv::constructColorFromString(string)}
134 {
135 }
136
137
145 Color(const char* string) :
146 Color{String{string}}
147 {
148 }
149
150
156 TGUI_CONSTEXPR bool isSet() const
157 {
158 return m_isSet;
159 }
160
161#if TGUI_HAS_BACKEND_SFML_GRAPHICS
167 operator sf::Color() const
168 {
169 return sf::Color(m_red, m_green, m_blue, m_alpha);
170 }
171#endif
172
178 explicit operator Vertex::Color() const
179 {
180 return Vertex::Color{m_red, m_green, m_blue, m_alpha};
181 }
182
183
189 TGUI_CONSTEXPR std::uint8_t getRed() const
190 {
191 return m_red;
192 }
193
194
200 TGUI_CONSTEXPR std::uint8_t getGreen() const
201 {
202 return m_green;
203 }
204
205
211 TGUI_CONSTEXPR std::uint8_t getBlue() const
212 {
213 return m_blue;
214 }
215
216
222 TGUI_CONSTEXPR std::uint8_t getAlpha() const
223 {
224 return m_alpha;
225 }
226
227
231 TGUI_CONSTEXPR bool operator==(const Color& rhs) const
232 {
233 return (m_isSet == rhs.m_isSet)
234 && (m_red == rhs.m_red)
235 && (m_green == rhs.m_green)
236 && (m_blue == rhs.m_blue)
237 && (m_alpha == rhs.m_alpha);
238 }
239
240
244 TGUI_CONSTEXPR bool operator!=(const Color& right) const
245 {
246 return !(*this == right);
247 }
248
249
251 public:
252
253 static const Color Black;
254 static const Color White;
255 static const Color Red;
256 static const Color Green;
257 static const Color Blue;
258 static const Color Yellow;
259 static const Color Magenta;
260 static const Color Cyan;
261 static const Color Transparent;
262
263 static const std::array<std::pair<StringView, Color>, 9> colorNamesMap;
264
265
267 private:
268
269 bool m_isSet = false;
270 std::uint8_t m_red = 0;
271 std::uint8_t m_green = 0;
272 std::uint8_t m_blue = 0;
273 std::uint8_t m_alpha = 0;
274 };
275
277
278 namespace priv
279 {
294 TGUI_API Color constructColorFromString(String string);
295 }
296
298
299
300#if TGUI_COMPILED_WITH_CPP_VER >= 20 // Although technically available since c++17, we put the bar higher to allow building TGUI with c++17 in VS2017
301 inline constexpr const Color Color::Black { 0, 0, 0};
302 inline constexpr const Color Color::White {255, 255, 255};
303 inline constexpr const Color Color::Red {255, 0, 0};
304 inline constexpr const Color Color::Green { 0, 255, 0};
305 inline constexpr const Color Color::Blue { 0, 0, 255};
306 inline constexpr const Color Color::Yellow {255, 255, 0};
307 inline constexpr const Color Color::Magenta {255, 0, 255};
308 inline constexpr const Color Color::Cyan { 0, 255, 255};
309 inline constexpr const Color Color::Transparent{ 0, 0, 0, 0};
310
311 inline constexpr const std::array<std::pair<StringView, Color>, 9> Color::colorNamesMap
312 {
313 {{U"black", Color::Black},
314 {U"white", Color::White},
315 {U"red", Color::Red},
316 {U"yellow", Color::Yellow},
317 {U"green", Color::Green},
318 {U"cyan", Color::Cyan},
319 {U"blue", Color::Blue},
320 {U"magenta", Color::Magenta},
321 {U"transparent", Color::Transparent}}
322 };
323#endif
324
325}
326
328
329#endif // TGUI_COLOR_HPP
Wrapper for colors.
Definition: Color.hpp:63
TGUI_CONSTEXPR Color(const sf::Color &color)
Creates the object from an sf::Color.
Definition: Color.hpp:97
static const Color Transparent
Transparent (black) predefined color.
Definition: Color.hpp:261
TGUI_CONSTEXPR std::uint8_t getGreen() const
Returns the green component of the color.
Definition: Color.hpp:200
static TGUI_CONSTEXPR Color applyOpacity(const Color &color, float alpha)
Returns the color with its alpha channel multiplied with the alpha parameter.
Definition: Color.hpp:69
TGUI_CONSTEXPR std::uint8_t getAlpha() const
Returns the alpha component of the color.
Definition: Color.hpp:222
static const Color Black
Black predefined color.
Definition: Color.hpp:253
static const Color Green
Green predefined color.
Definition: Color.hpp:256
TGUI_CONSTEXPR bool operator==(const Color &rhs) const
Compares the color with another one.
Definition: Color.hpp:231
TGUI_CONSTEXPR bool operator!=(const Color &right) const
Compares the color with another one.
Definition: Color.hpp:244
static const Color White
White predefined color.
Definition: Color.hpp:254
TGUI_CONSTEXPR Color()
Creates the object without a color.
Definition: Color.hpp:82
Color(const char *string)
Creates the object from a string.
Definition: Color.hpp:145
TGUI_CONSTEXPR std::uint8_t getRed() const
Returns the red component of the color.
Definition: Color.hpp:189
static const Color Cyan
Cyan predefined color.
Definition: Color.hpp:260
static const Color Magenta
Magenta predefined color.
Definition: Color.hpp:259
TGUI_CONSTEXPR std::uint8_t getBlue() const
Returns the blue component of the color.
Definition: Color.hpp:211
static const Color Yellow
Yellow predefined color.
Definition: Color.hpp:258
static const Color Red
Red predefined color.
Definition: Color.hpp:255
static const Color Blue
Blue predefined color.
Definition: Color.hpp:257
TGUI_CONSTEXPR bool isSet() const
Checks if a color was set.
Definition: Color.hpp:156
TGUI_CONSTEXPR Color(std::uint8_t red, std::uint8_t green, std::uint8_t blue, std::uint8_t alpha=255)
Creates the object from an the RGB or RGBA values.
Definition: Color.hpp:115
Color(const String &string)
Creates the object from a string.
Definition: Color.hpp:132
Wrapper class to store strings.
Definition: String.hpp:79
Namespace that contains all TGUI functions and classes.
Definition: AbsoluteOrRelativeValue.hpp:36
Definition: Vertex.hpp:39