1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
|
/*
* The ManaPlus Client
* Copyright (C) 2011-2017 The ManaPlus Developers
*
* This file is part of The ManaPlus Client.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
/* _______ __ __ __ ______ __ __ _______ __ __
* / _____/\ / /\ / /\ / /\ / ____/\ / /\ / /\ / ___ /\ / |\/ /\
* / /\____\// / // / // / // /\___\// /_// / // /\_/ / // , |/ / /
* / / /__ / / // / // / // / / / ___ / // ___ / // /| ' / /
* / /_// /\ / /_// / // / // /_/_ / / // / // /\_/ / // / | / /
* /______/ //______/ //_/ //_____/\ /_/ //_/ //_/ //_/ //_/ /|_/ /
* \______\/ \______\/ \_\/ \_____\/ \_\/ \_\/ \_\/ \_\/ \_\/ \_\/
*
* Copyright (c) 2004 - 2008 Olof Naessén and Per Larsson
*
*
* Per Larsson a.k.a finalman
* Olof Naessén a.k.a jansem/yakslem
*
* Visit: http://guichan.sourceforge.net
*
* License: (BSD)
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
* 3. Neither the name of Guichan nor the names of its contributors may
* be used to endorse or promote products derived from this software
* without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
* TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
* LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#ifndef GUI_COLOR_H
#define GUI_COLOR_H
#include "utils/cast.h"
#include "localconsts.h"
/**
* Represents a color with red, green, blue and alpha components.
*/
class Color final
{
public:
/**
* Constructor. Initializes the color to black.
*/
constexpr Color() :
r(0U),
g(0U),
b(0U),
a(255U)
{
}
/**
* Constructor. Constructs a color from the bytes in an integer.
* Call it with a hexadecimal constant for HTML-style color
* representation.
* The alpha component is 255 by default.
*
* EXAMPLE: Color(0xff50a0) constructs a very nice pinkish color.
*
* NOTE: Because of this constructor, integers will be automatically
* casted to a color by your compiler.
*
* @param color The color to initialise the object with.
*/
explicit constexpr Color(const unsigned int color) :
r((color >> 16) & 0xFFU),
g((color >> 8) & 0xFFU),
b(color & 0xFFU),
a(255U)
{
}
/**
* Constructor. The default alpha value is 255.
*
* @param ar Red color component (range 0-255).
* @param ag Green color component (range 0-255).
* @param ab Blue color component (range 0-255).
* @param aa Alpha, used for transparency. A value of 0 means
* totaly transparent, 255 is totaly opaque.
*/
constexpr Color(const unsigned int ar,
const unsigned int ag,
const unsigned int ab,
const unsigned int aa = 255) :
r(ar),
g(ag),
b(ab),
a(aa)
{
}
A_DEFAULT_COPY(Color)
/**
* Adds the RGB values of two colors together. The values will be
* clamped if they go out of range.
*
* WARNING: This function will reset the alpha value of the
* returned color to 255.
*
* @param color A color to add to this color.
* @return The added colors with an alpha value set to 255.
*/
constexpr2 Color operator+(const Color& color) const
{
Color result(r + color.r,
g + color.g,
b + color.b,
255U);
result.r = (result.r > 255U ? 255U : result.r);
result.g = (result.g > 255U ? 255U : result.g);
result.b = (result.b > 255U ? 255U : result.b);
return result;
}
/**
* Subtracts the RGB values of one color from another.
* The values will be clamped if they go out of range.
*
* WARNING: This function will reset the alpha value of the
* returned color to 255.
*
* @param color A color to subtract from this color.
* @return The subtracted colors with an alpha value set to 255.
*/
constexpr2 Color operator-(const Color& color) const
{
Color result(r - color.r,
g - color.g,
b - color.b,
255U);
result.r = (result.r > 255U ? 255U : result.r);
result.g = (result.g > 255U ? 255U : result.g);
result.b = (result.b > 255U ? 255U : result.b);
return result;
}
/**
* Multiplies the RGB values of a color with a float value.
* The values will be clamped if they go out of range.
*
* @param value The value to multiply the color with.
* @return The multiplied colors. The alpha value will, unlike
* the add and subtract operations, be multiplied as
* well.
*/
constexpr2 Color operator*(const float value) const
{
Color result(CAST_U32(static_cast<float>(r) * value),
CAST_U32(static_cast<float>(g) * value),
CAST_U32(static_cast<float>(b) * value),
a);
result.r = (result.r > 255U ? 255U : result.r);
result.g = (result.g > 255U ? 255U : result.g);
result.b = (result.b > 255U ? 255U : result.b);
return result;
}
/**
* Compares two colors.
*
* @return True if the two colors have the same RGBA components
* false otherwise.
*/
constexpr bool operator==(const Color& color) const
{
return r == color.r &&
g == color.g &&
b == color.b &&
a == color.a;
}
/**
* Compares two colors.
*
* @return True if the two colors have different RGBA components,
* false otherwise.
*/
constexpr bool operator!=(const Color& color) const
{
return !(r == color.r &&
g == color.g &&
b == color.b &&
a == color.a);
}
/**
* Holds the red color component (range 0-255).
*/
unsigned int r;
/**
* Holds the green color component (range 0-255).
*/
unsigned int g;
/**
* Holds the blue color component (range 0-255).
*/
unsigned int b;
/**
* Holds the alpha color component. A value of 0 means totally
* transparent while a value of 255 is considered opaque.
*/
unsigned int a;
};
#endif // GUI_COLOR_H
|
