Merge remote branch 'staging/master' into refactor
[profile/ivi/qtbase.git] / src / opengl / qglcolormap.h
1 /****************************************************************************
2 **
3 ** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
4 ** All rights reserved.
5 ** Contact: Nokia Corporation (qt-info@nokia.com)
6 **
7 ** This file is part of the QtOpenGL module of the Qt Toolkit.
8 **
9 ** $QT_BEGIN_LICENSE:LGPL$
10 ** GNU Lesser General Public License Usage
11 ** This file may be used under the terms of the GNU Lesser General Public
12 ** License version 2.1 as published by the Free Software Foundation and
13 ** appearing in the file LICENSE.LGPL included in the packaging of this
14 ** file. Please review the following information to ensure the GNU Lesser
15 ** General Public License version 2.1 requirements will be met:
16 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
17 **
18 ** In addition, as a special exception, Nokia gives you certain additional
19 ** rights. These rights are described in the Nokia Qt LGPL Exception
20 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
21 **
22 ** GNU General Public License Usage
23 ** Alternatively, this file may be used under the terms of the GNU General
24 ** Public License version 3.0 as published by the Free Software Foundation
25 ** and appearing in the file LICENSE.GPL included in the packaging of this
26 ** file. Please review the following information to ensure the GNU General
27 ** Public License version 3.0 requirements will be met:
28 ** http://www.gnu.org/copyleft/gpl.html.
29 **
30 ** Other Usage
31 ** Alternatively, this file may be used in accordance with the terms and
32 ** conditions contained in a signed written agreement between you and Nokia.
33 **
34 **
35 **
36 **
37 **
38 ** $QT_END_LICENSE$
39 **
40 ****************************************************************************/
41
42 #ifndef QGLCOLORMAP_H
43 #define QGLCOLORMAP_H
44
45 #include <QtGui/qcolor.h>
46 #include <QtCore/qvector.h>
47
48 QT_BEGIN_HEADER
49
50 QT_BEGIN_NAMESPACE
51
52 QT_MODULE(OpenGL)
53
54 class Q_OPENGL_EXPORT QGLColormap
55 {
56 public:
57     QGLColormap();
58     QGLColormap(const QGLColormap &);
59     ~QGLColormap();
60
61     QGLColormap &operator=(const QGLColormap &);
62
63     bool   isEmpty() const;
64     int    size() const;
65     void   detach();
66
67     void   setEntries(int count, const QRgb * colors, int base = 0);
68     void   setEntry(int idx, QRgb color);
69     void   setEntry(int idx, const QColor & color);
70     QRgb   entryRgb(int idx) const;
71     QColor entryColor(int idx) const;
72     int    find(QRgb color) const;
73     int    findNearest(QRgb color) const;
74
75 protected:
76     Qt::HANDLE handle() { return d ? d->cmapHandle : 0; }
77     void setHandle(Qt::HANDLE ahandle) { d->cmapHandle = ahandle; }
78
79 private:
80     struct QGLColormapData {
81         QBasicAtomicInt ref;
82         QVector<QRgb> *cells;
83         Qt::HANDLE cmapHandle;
84     };
85
86     QGLColormapData *d;
87     static struct QGLColormapData shared_null;
88     static void cleanup(QGLColormapData *x);
89     void detach_helper();
90
91     friend class QGLWidget;
92     friend class QGLWidgetPrivate;
93 };
94
95 inline void QGLColormap::detach()
96 {
97     if (d->ref != 1)
98         detach_helper();
99 }
100
101 QT_END_NAMESPACE
102
103 QT_END_HEADER
104
105 #endif // QGLCOLORMAP_H