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
|
/*
* This source file is part of libRocket, the HTML/CSS Interface Middleware
*
* For the latest information, see http://www.librocket.com
*
* Copyright (c) 2008-2010 CodePoint Ltd, Shift Technology Ltd
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*
*/
#ifndef ROCKETCORECOLOUR_H
#define ROCKETCORECOLOUR_H
#include "Header.h"
namespace Rocket {
namespace Core {
/**
Templated class for a four-component RGBA colour.
@author Peter Curry
*/
template < typename ColourType, int AlphaDefault >
class Colour
{
public:
/// Lightweight, non-initialising constructor.
inline Colour();
/// Initialising constructor.
/// @param[in] red Initial red value of the colour.
/// @param[in] green Initial green value of the colour.
/// @param[in] blue Initial blue value of the colour.
/// @param[in] alpha Initial alpha value of the colour.
inline Colour(ColourType red, ColourType green, ColourType blue, ColourType alpha = AlphaDefault);
/// Returns the sum of this colour and another. This does not saturate the channels.
/// @param[in] rhs The colour to add this to.
/// @return The sum of the two colours.
inline Colour operator+(const Colour& rhs) const;
/// Returns the result of subtracting another colour from this colour.
/// @param[in] rhs The colour to subtract from this colour.
/// @return The result of the subtraction.
inline Colour operator-(const Colour& rhs) const;
/// Returns the result of multiplying this colour by another.
/// @param[in] rhs The colour to multiply by.
/// @return The result of the multiplication.
Colour operator*(const Colour& rhs) const;
/// Returns the result of multiplying this colour component-wise by a scalar.
/// @param[in] rhs The scalar value to multiply by.
/// @return The result of the scale.
inline Colour operator*(float rhs) const;
/// Returns the result of dividing this colour component-wise by a scalar.
/// @param[in] rhs The scalar value to divide by.
/// @return The result of the scale.
inline Colour operator/(float rhs) const;
/// Adds another colour to this in-place. This does not saturate the channels.
/// @param[in] rhs The colour to add.
inline void operator+=(const Colour& rhs);
/// Subtracts another colour from this in-place.
/// @param[in] rhs The colour to subtract.
inline void operator-=(const Colour& rhs);
/// Multiplies this colour component-wise with another in-place.
/// @param[in] rhs The colour to multiply by.
/// @return This colour, post-operation.
void operator*=(const Colour& rhs);
/// Scales this colour component-wise in-place.
/// @param[in] rhs The value to scale this colours's components by.
inline void operator*=(float rhs);
/// Scales this colour component-wise in-place by the inverse of a value.
/// @param[in] rhs The value to divide this colour's components by.
inline void operator/=(float rhs);
/// Equality operator.
/// @param[in] rhs The colour to compare this against.
/// @return True if the two colours are equal, false otherwise.
inline bool operator==(const Colour& rhs) { return red == rhs.red && green == rhs.green && blue == rhs.blue && alpha == rhs.alpha; }
/// Inequality operator.
/// @param[in] rhs The colour to compare this against.
/// @return True if the two colours are not equal, false otherwise.
inline bool operator!=(const Colour& rhs) { return red != rhs.red || green != rhs.green || blue != rhs.blue || alpha != rhs.alpha; }
/// Auto-cast operator.
/// @return A pointer to the first value.
inline operator const ColourType*() const { return &red; }
/// Constant auto-cast operator.
/// @return A constant pointer to the first value.
inline operator ColourType*() { return &red; }
ColourType red, green, blue, alpha;
};
}
}
namespace Rocket {
namespace Core {
#include "Colour.inl"
}
}
#endif
|
