summaryrefslogtreecommitdiffstats
path: root/src/gui/painting/qrgba64.qdoc
blob: 3ee8a355e6395d2c010dea0ccca80c20c5df9d8f (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
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
/****************************************************************************
**
** Copyright (C) 2016 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the documentation of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:FDL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU Free Documentation License Usage
** Alternatively, this file may be used under the terms of the GNU Free
** Documentation License version 1.3 as published by the Free Software
** Foundation and appearing in the file included in the packaging of
** this file. Please review the following information to ensure
** the GNU Free Documentation License version 1.3 requirements
** will be met: https://www.gnu.org/licenses/fdl-1.3.html.
** $QT_END_LICENSE$
**
****************************************************************************/

/*!
    \class QRgba64
    \brief The QRgba64 struct contains a 64-bit RGB color.
    \since 5.6

    \ingroup painting
    \inmodule QtGui

    QRgba64 is a 64-bit data-structure containing four 16-bit color channels: Red, green, blue and alpha.

    QRgba64 can be used as a replacement for QRgb when higher precision is needed. In particular a
    premultiplied QRgba64 can operate on unpremultiplied QRgb without loss of precision except
    for alpha 0.

    \sa QRgb, QColor
*/

/*!
    \fn QRgba64 QRgba64::operator=(quint64 rgba)

    Assigns the value \a rgba to this instance of QRgba64 and returns it.
*/

/*!
    \fn static QRgba64 QRgba64::fromRgba64(quint16 r, quint16 g, quint16 b, quint16 a)

    Returns the QRgba64 quadruplet (\a{r}, \a{g}, \a{b}, \a{a}).

    \sa fromRgba()
*/

/*!
    \fn static QRgba64 QRgba64::fromRgba64(quint64 c)

    Returns \a c as a QRgba64 struct.

    \sa fromArgb32()
*/

/*!
    \fn static QRgba64 QRgba64::fromRgba(quint8 red, quint8 green, quint8 blue, quint8 alpha)

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

    \sa fromArgb32()
*/

/*!
    \fn static QRgba64 QRgba64::fromArgb32(uint rgb)

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

    \sa fromRgba()
*/

/*!
    \fn bool QRgba64::isOpaque() const

    Returns whether the color is fully opaque.

    \sa isTransparent(), alpha()
*/

/*!
    \fn bool QRgba64::isTransparent() const

    Returns whether the color is transparent.

    \sa isOpaque(), alpha()
*/

/*!
    \fn quint16 QRgba64::red() const

    Returns the 16-bit red color component.

    \sa setRed()
*/

/*!
    \fn void QRgba64::setRed(quint16 red)

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

    \sa red()
*/

/*!
    \fn quint16 QRgba64::green() const

    Returns the 16-bit green color component.

    \sa setGreen()
*/

/*!
    \fn void QRgba64::setGreen(quint16 green)

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

    \sa green()
*/

/*!
    \fn quint16 QRgba64::blue() const

    Returns the 16-bit blue color component.

    \sa setBlue()
*/

/*!
    \fn void QRgba64::setBlue(quint16 blue)

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

    \sa blue()
*/

/*!
    \fn quint16 QRgba64::alpha() const

    Returns the 16-bit alpha channel.

    \sa setAlpha()
*/

/*!
    \fn void QRgba64::setAlpha(quint16 alpha)

    Sets the alpha of this color to \a alpha.

    \sa alpha()
*/

/*!
    \fn quint8 QRgba64::red8() const

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

/*!
    \fn quint8 QRgba64::green8() const

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

/*!
    \fn quint8 QRgba64::blue8() const

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

/*!
    \fn quint8 QRgba64::alpha8() const

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

/*!
    \fn uint QRgba64::toArgb32() const

    Returns the color as a 32-bit ARGB value.

    \sa fromArgb32()
*/

/*!
    \fn ushort QRgba64::toRgb16() const

    Returns the color as a 16-bit RGB value.

    \sa toArgb32()
*/

/*!
    \fn QRgba64 QRgba64::premultiplied() const

    Returns the color with the alpha premultiplied.

    \sa unpremultiplied()
*/

/*!
    \fn QRgba64 QRgba64::unpremultiplied() const

    Returns the color with the alpha unpremultiplied.

    \sa premultiplied()
*/

/*!
    \fn QRgba64::operator quint64() const

    Returns the color as a 64bit unsigned integer
*/

/*!
    \fn QRgba64 qRgba64(quint16 r, quint16 g, quint16 b, quint16 a)
    \relates QColor
    \since 5.6

    Returns the QRgba64 quadruplet (\a{r}, \a{g}, \a{b}, \a{a}).

    \sa qRgba()
*/

/*!
    \fn QRgba64 qRgba64(quint64 c)
    \relates QColor
    \since 5.6

    Returns \a c as a QRgba64 struct.

    \sa qRgba()
*/

/*!
    \fn QRgba64 qPremultiply(QRgba64 rgba64)
    \since 5.6
    \relates QColor

    Converts an unpremultiplied QRgba64 quadruplet \a rgba64 into a premultiplied QRgba64 quadruplet.

    \sa QRgba64::premultiplied(), qUnpremultiply()
*/

/*!
    \fn QRgba64 qUnpremultiply(QRgba64 rgba64)
    \since 5.6
    \relates QColor

    Converts a premultiplied QRgba64 quadruplet \a rgba64 into an unpremultiplied QRgba64 quadruplet.

    \sa QRgba64::unpremultiplied(), qPremultiply()
*/

/*!
    \fn uint qRed(QRgba64 rgba64)
    \since 5.6
    \relates QColor

    Returns the red component of \a rgba64 as an 8-bit value.

    \sa QRgba64::red8(), QColor::red()
*/

/*!
    \fn uint qGreen(QRgba64 rgba64)
    \since 5.6
    \relates QColor

    Returns the green component of \a rgba64 as an 8-bit value.

    \sa QRgba64::green8(), QColor::green()
*/

/*!
    \fn uint qBlue(QRgba64 rgba64)
    \since 5.6
    \relates QColor

    Returns the blue component of \a rgba64 as an 8-bit value.

    \sa QRgba64::blue8(), QColor::blue()
*/

/*!
    \fn uint qAlpha(QRgba64 rgba64)
    \since 5.6
    \relates QColor

    Returns the alpha component of \a rgba64 as an 8-bit value.

    \sa QRgba64::alpha8(), QColor::alpha()
*/