summaryrefslogtreecommitdiffstats
path: root/src/threed/surfaces/qglmaskedsurface.cpp
blob: a987df40dd1b503a15cd6d92d3d22421e519bcb0 (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
/****************************************************************************
**
** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
** All rights reserved.
** Contact: Nokia Corporation (qt-info@nokia.com)
**
** This file is part of the QtQuick3D module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** GNU Lesser General Public License Usage
** This file may be used under the terms of the GNU Lesser General Public
** License version 2.1 as published by the Free Software Foundation and
** appearing in the file LICENSE.LGPL included in the packaging of this
** file. Please review the following information to ensure the GNU Lesser
** General Public License version 2.1 requirements will be met:
** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Nokia gives you certain additional
** rights. These rights are described in the Nokia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU General
** Public License version 3.0 as published by the Free Software Foundation
** and appearing in the file LICENSE.GPL included in the packaging of this
** file. Please review the following information to ensure the GNU General
** Public License version 3.0 requirements will be met:
** http://www.gnu.org/copyleft/gpl.html.
**
** Other Usage
** Alternatively, this file may be used in accordance with the terms and
** conditions contained in a signed written agreement between you and Nokia.
**
**
**
**
**
** $QT_END_LICENSE$
**
****************************************************************************/

#include "qglmaskedsurface_p.h"

QT_BEGIN_NAMESPACE

/*!
    \class QGLMaskedSurface
    \brief The QGLMaskedSurface class represents a masked copy of another OpenGL drawing surface.
    \since 4.8
    \ingroup qt3d
    \ingroup qt3d::painting
    \internal

    Masked surfaces are typically used to render red-cyan anaglyph images
    into an underlying surface().  For the left eye image, the mask()
    is set to RedMask | AlphaMask.  Then for the right eye image, the mask()
    is set to GreenMask | BlueMask.
*/

/*!
    \enum QGLMaskedSurface::BufferMaskBit
    This enum defines the channels to mask with QGLMaskedSurface.

    \value RedMask Allow the red channel to be written to the color buffer.
    \value GreenMask Allow the green channel to be written to the color buffer.
    \value BlueMask Allow the blue channel to be written to the color buffer.
    \value AlphaMask Allow the alpha channel to be written to the color buffer.
*/

class QGLMaskedSurfacePrivate
{
public:
    QGLMaskedSurfacePrivate
        (QGLAbstractSurface *surf = 0,
         QGLMaskedSurface::BufferMask msk = QGLMaskedSurface::RedMask |
                                            QGLMaskedSurface::GreenMask |
                                            QGLMaskedSurface::BlueMask |
                                            QGLMaskedSurface::AlphaMask)
            : surface(surf), mask(msk) {}

    QGLAbstractSurface *surface;
    QGLMaskedSurface::BufferMask mask;
};

#define MaskedSurfaceType       501

/*!
    Constructs a masked OpenGL drawing surface with surface() initially
    set to null and mask() initially set to allow all channels to be
    written to the color buffer.
*/
QGLMaskedSurface::QGLMaskedSurface()
    : QGLAbstractSurface(MaskedSurfaceType)
    , d_ptr(new QGLMaskedSurfacePrivate)
{
}

/*!
    Constructs a masked OpenGL drawing surface that applies \a mask
    to \a surface when activate() is called.
*/
QGLMaskedSurface::QGLMaskedSurface
        (QGLAbstractSurface *surface, QGLMaskedSurface::BufferMask mask)
    : QGLAbstractSurface(MaskedSurfaceType)
    , d_ptr(new QGLMaskedSurfacePrivate(surface, mask))
{
}

/*!
    Destroys this masked OpenGL drawing surface.
*/
QGLMaskedSurface::~QGLMaskedSurface()
{
}

/*!
    Returns the underlying surface that mask() will be applied to
    when activate() is called.

    \sa setSurface(), mask()
*/
QGLAbstractSurface *QGLMaskedSurface::surface() const
{
    Q_D(const QGLMaskedSurface);
    return d->surface;
}

/*!
    Sets the underlying \a surface that mask() will be applied to
    when activate() is called.

    \sa surface(), setMask()
*/
void QGLMaskedSurface::setSurface(QGLAbstractSurface *surface)
{
    Q_D(QGLMaskedSurface);
    d->surface = surface;
}

/*!
    Returns the color mask to apply to surface() when activate()
    is called.

    \sa setMask(), surface()
*/
QGLMaskedSurface::BufferMask QGLMaskedSurface::mask() const
{
    Q_D(const QGLMaskedSurface);
    return d->mask;
}

/*!
    Sets the color \a mask to apply to surface() when activate()
    is called.

    \sa mask(), setSurface()
*/
void QGLMaskedSurface::setMask(QGLMaskedSurface::BufferMask mask)
{
    Q_D(QGLMaskedSurface);
    d->mask = mask;
}

/*!
    \reimp
*/
bool QGLMaskedSurface::activate(QGLAbstractSurface *prevSurface)
{
    Q_D(const QGLMaskedSurface);
    if (!d->surface || !d->surface->activate(prevSurface))
        return false;
    glColorMask((d->mask & RedMask) != 0, (d->mask & GreenMask) != 0,
                (d->mask & BlueMask) != 0, (d->mask & AlphaMask) != 0);
    return true;
}

/*!
    \reimp
*/
void QGLMaskedSurface::deactivate(QGLAbstractSurface *nextSurface)
{
    Q_D(QGLMaskedSurface);
    if (d->surface)
        d->surface->deactivate(nextSurface);
    if (nextSurface && nextSurface->surfaceType() == MaskedSurfaceType) {
        // If we are about to switch to another masked surface for
        // the same underlying surface, then don't bother calling
        // glColorMask() for this one.
        QGLMaskedSurface *next = static_cast<QGLMaskedSurface *>(nextSurface);
        if (d->surface == next->surface())
            return;
    }
    glColorMask(GL_TRUE, GL_TRUE, GL_TRUE, GL_TRUE);
}

/*!
    \reimp
*/
QRect QGLMaskedSurface::viewportGL() const
{
    Q_D(const QGLMaskedSurface);
    return d->surface ? d->surface->viewportGL() : QRect();
}

bool QGLMaskedSurface::isValid() const
{
    return QGLAbstractSurface::isValid();
}

QT_END_NAMESPACE