summaryrefslogtreecommitdiffstats
path: root/src/gui/painting/qrgbafloat.qdoc
blob: f41064df384308e9f2aa5ee4946e9ff8abad99d1 (plain)
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
// Copyright (C) 2021 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only

/*!
    \class QRgbaFloat
    \brief The QRgbaFloat struct contains a four part RGBA floating-point color.
    \since 6.2

    \ingroup painting
    \inmodule QtGui

    \sa QRgb, QRgba64, QColor
*/

/*!
    \typealias QRgbaFloat::FastType

    Alias for \e float.
*/

/*!
    \typedef QRgbaFloat16
    \relates QRgbaFloat

    A 64-bit data-structure containing four 16-bit floating point color channels: Red, green, blue and alpha.
*/

/*!
    \typedef QRgbaFloat32
    \relates QRgbaFloat

    A 128-bit data-structure containing four 32-bit floating point color channels: Red, green, blue and alpha.
*/

/*!
    \fn template<typename F> QRgbaFloat<F>::fromRgba64(quint16 r, quint16 g, quint16 b, quint16 a)

    Constructs a QRgbaFloat  value from the four 16-bit integer color channels \a red, \a green, \a blue and \a alpha.

    \sa fromRgba()
*/

/*!
    \fn template<typename F> QRgbaFloat<F>::fromRgba(quint8 red, quint8 green, quint8 blue, quint8 alpha)

    Constructs a QRgbaFloat  value from the four 8-bit color channels \a red, \a green, \a blue and \a alpha.

    \sa fromArgb32()
*/

/*!
    \fn template<typename F> QRgbaFloat<F>::fromArgb32(uint rgb)

    Constructs a QRgbaFloat  value from the 32bit ARGB value \a rgb.

    \sa fromRgba(), toArgb32()
*/

/*!
    \fn template<typename F> bool QRgbaFloat<F>::isOpaque() const

    Returns whether the color is fully opaque.

    \sa isTransparent(), alpha()
*/

/*!
    \fn template<typename F> bool QRgbaFloat<F>::isTransparent() const

    Returns whether the color is fully transparent.

    \sa isOpaque(), alpha()
*/

/*!
    \fn template<typename F> float QRgbaFloat<F>::red() const

    Returns the red color component.

    \sa setRed()
*/

/*!
    \fn template<typename F> void QRgbaFloat<F>::setRed(QRgbaFloat::FastType red)

    Sets the red color component of this color to \a red.

    \sa red()
*/

/*!
    \fn template<typename F> float QRgbaFloat<F>::green() const

    Returns the green color component.

    \sa setGreen()
*/

/*!
    \fn template<typename F> void QRgbaFloat<F>::setGreen(QRgbaFloat::FastType green)

    Sets the green color component of this color to \a green.

    \sa green()
*/

/*!
    \fn template<typename F> float QRgbaFloat<F>::blue() const

    Returns the blue color component.

    \sa setBlue()
*/

/*!
    \fn template<typename F> void QRgbaFloat<F>::setBlue(QRgbaFloat::FastType blue)

    Sets the blue color component of this color to \a blue.

    \sa blue()
*/

/*!
    \fn template<typename F> float QRgbaFloat<F>::alpha() const

    Returns the alpha channel.

    \sa setAlpha()
*/

/*!
    \fn template<typename F> void QRgbaFloat<F>::setAlpha(QRgbaFloat::FastType alpha)

    Sets the alpha of this color to \a alpha.

    \sa alpha()
*/

/*!
    \fn template<typename F> float QRgbaFloat<F>::redNormalized() const

    Returns the red color component normalized to values between \c 0.0f and \c 1.0f.

    \sa setRed()
*/

/*!
    \fn template<typename F> float QRgbaFloat<F>::greenNormalized() const

    Returns the green color component normalized to values between \c 0.0f and \c 1.0f.

    \sa setGreen()
*/

/*!
    \fn template<typename F> float QRgbaFloat<F>::blueNormalized() const

    Returns the blue color component normalized to values between \c 0.0f and \c 1.0f.

    \sa setBlue()
*/

/*!
    \fn template<typename F> float QRgbaFloat<F>::alphaNormalized() const

    Returns the alpha channel normalized to values between \c 0.0f and \c 1.0f.

    \sa alpha()
*/

/*!
    \fn template<typename F> quint8 QRgbaFloat<F>::red8() const

    Returns the red color component as an 8-bit.
*/

/*!
    \fn template<typename F> quint8 QRgbaFloat<F>::green8() const

    Returns the green color component as an 8-bit.
*/

/*!
    \fn template<typename F> quint8 QRgbaFloat<F>::blue8() const

    Returns the blue color component as an 8-bit.
*/

/*!
    \fn template<typename F> quint8 QRgbaFloat<F>::alpha8() const

    Returns the alpha channel as an 8-bit.
*/

/*!
    \fn template<typename F> uint QRgbaFloat<F>::toArgb32() const

    Returns the color as a 32-bit ARGB value.

    \sa fromArgb32()
*/

/*!
    \fn template<typename F> quint16 QRgbaFloat<F>::red16() const

    Returns the red color component as a 16-bit integer.
*/

/*!
    \fn template<typename F> quint16 QRgbaFloat<F>::green16() const

    Returns the green color component as a 16-bit integer.
*/

/*!
    \fn template<typename F> quint16 QRgbaFloat<F>::blue16() const

    Returns the blue color component as a 16-bit integer.
*/

/*!
    \fn template<typename F> quint16 QRgbaFloat<F>::alpha16() const

    Returns the alpha channel as a 16-bit integer.
*/

/*!
    \fn template<typename F> QRgbaFloat QRgbaFloat<F>::premultiplied() const

    Returns the color with the alpha premultiplied.

    \sa unpremultiplied()
*/

/*!
    \fn template<typename F> QRgbaFloat QRgbaFloat<F>::unpremultiplied() const

    Returns the color with the alpha unpremultiplied.

    \sa premultiplied()
*/