-
Jani Heikkinen authored
Qt copyrights are now in The Qt Company, so we could update the source code headers accordingly. In the same go we should also fix the links to point to qt.io. Outdated header.LGPL removed (use header.LGPL21 instead) Old header.LGPL3 renamed to header.LGPL3-COMM to match actual licensing combination. New header.LGPL-COMM taken in the use file which were using old header.LGPL3 (src/plugins/platforms/android/extract.cpp) Added new header.LGPL3 containing Commercial + LGPLv3 + GPLv2 license combination Change-Id: I6f49b819a8a20cc4f88b794a8f6726d975e8ffbe Reviewed-by:Matti Paaso <matti.paaso@theqtcompany.com>
83a5694d
/******************************************************************************** Copyright (C) 2015 The Qt Company Ltd.** Contact: http://www.qt.io/licensing/**** This file is part of the QtOpenGL module of the Qt Toolkit.**** $QT_BEGIN_LICENSE:LGPL21$** 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 http://www.qt.io/terms-conditions. For further** information use the contact form at http://www.qt.io/contact-us.**** GNU Lesser General Public License Usage** Alternatively, this file may be used under the terms of the GNU Lesser** General Public License version 2.1 or version 3 as published by the Free** Software Foundation and appearing in the file LICENSE.LGPLv21 and** LICENSE.LGPLv3 included in the packaging of this file. Please review the** following information to ensure the GNU Lesser General Public License** requirements will be met: https://www.gnu.org/licenses/lgpl.html and** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.**** As a special exception, The Qt Company gives you certain additional** rights. These rights are described in The Qt Company LGPL Exception** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.**** $QT_END_LICENSE$******************************************************************************/#include "qgraphicsshadereffect_p.h"#ifndef QT_NO_GRAPHICSEFFECT#include "qglshaderprogram.h"#include "gl2paintengineex/qglcustomshaderstage_p.h"#define QGL_HAVE_CUSTOM_SHADERS 1#include <QtGui/qpainter.h>#include <QtWidgets/qgraphicsitem.h>#include <private/qgraphicseffect_p.h>QT_BEGIN_NAMESPACE/*# \class QGraphicsShaderEffect \inmodule QtOpenGL \brief The QGraphicsShaderEffect class is the base class for creating custom GLSL shader effects in a QGraphicsScene. \since 4.6 \ingroup multimedia \ingroup graphicsview-api The specific effect is defined by a fragment of GLSL source code supplied to setPixelShaderFragment(). This source code must define a function with the signature \c{lowp vec4 customShader(lowp sampler2D imageTexture, highp vec2 textureCoords)} that returns the source pixel value to use in the paint engine's shader program. The shader fragment is linked with the regular shader code used by the GL2 paint engine to construct a complete QGLShaderProgram. The following example shader converts the incoming pixmap to grayscale and then applies a colorize operation using the \c effectColor value: \code static char const colorizeShaderCode[] =7172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140
"uniform lowp vec4 effectColor;\n"
"lowp vec4 customShader(lowp sampler2D imageTexture, highp vec2 textureCoords) {\n"
" vec4 src = texture2D(imageTexture, textureCoords);\n"
" float gray = dot(src.rgb, vec3(0.212671, 0.715160, 0.072169));\n"
" vec4 colorize = 1.0-((1.0-gray)*(1.0-effectColor));\n"
" return vec4(colorize.rgb, src.a);\n"
"}";
\endcode
To use this shader code, it is necessary to define a subclass
of QGraphicsShaderEffect as follows:
\code
class ColorizeEffect : public QGraphicsShaderEffect
{
Q_OBJECT
public:
ColorizeEffect(QObject *parent = 0)
: QGraphicsShaderEffect(parent), color(Qt::black)
{
setPixelShaderFragment(colorizeShaderCode);
}
QColor effectColor() const { return color; }
void setEffectColor(const QColor& c)
{
color = c;
setUniformsDirty();
}
protected:
void setUniforms(QGLShaderProgram *program)
{
program->setUniformValue("effectColor", color);
}
private:
QColor color;
};
\endcode
The setUniforms() function is called when the effect is about
to be used for drawing to give the subclass the opportunity to
set effect-specific uniform variables.
QGraphicsShaderEffect is only supported when the GL2 paint engine
is in use. When any other paint engine is in use (GL1, raster, etc),
the drawItem() method will draw its item argument directly with
no effect applied.
\sa QGraphicsEffect
*/
static const char qglslDefaultImageFragmentShader[] = "\
lowp vec4 customShader(lowp sampler2D imageTexture, highp vec2 textureCoords) { \
return texture2D(imageTexture, textureCoords); \
}\n";
#ifdef QGL_HAVE_CUSTOM_SHADERS
class QGLCustomShaderEffectStage : public QGLCustomShaderStage
{
public:
QGLCustomShaderEffectStage
(QGraphicsShaderEffect *e, const QByteArray& source)
: QGLCustomShaderStage(),
effect(e)
{
setSource(source);
}
141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210
void setUniforms(QGLShaderProgram *program) Q_DECL_OVERRIDE;
QGraphicsShaderEffect *effect;
};
void QGLCustomShaderEffectStage::setUniforms(QGLShaderProgram *program)
{
effect->setUniforms(program);
}
#endif
class QGraphicsShaderEffectPrivate : public QGraphicsEffectPrivate
{
Q_DECLARE_PUBLIC(QGraphicsShaderEffect)
public:
QGraphicsShaderEffectPrivate()
: pixelShaderFragment(qglslDefaultImageFragmentShader)
#ifdef QGL_HAVE_CUSTOM_SHADERS
, customShaderStage(0)
#endif
{
}
QByteArray pixelShaderFragment;
#ifdef QGL_HAVE_CUSTOM_SHADERS
QGLCustomShaderEffectStage *customShaderStage;
#endif
};
/*#
Constructs a shader effect and attaches it to \a parent.
*/
QGraphicsShaderEffect::QGraphicsShaderEffect(QObject *parent)
: QGraphicsEffect(*new QGraphicsShaderEffectPrivate(), parent)
{
}
/*#
Destroys this shader effect.
*/
QGraphicsShaderEffect::~QGraphicsShaderEffect()
{
#ifdef QGL_HAVE_CUSTOM_SHADERS
Q_D(QGraphicsShaderEffect);
delete d->customShaderStage;
#endif
}
/*#
Returns the source code for the pixel shader fragment for
this shader effect. The default is a shader that copies
its incoming pixmap directly to the output with no effect
applied.
\sa setPixelShaderFragment()
*/
QByteArray QGraphicsShaderEffect::pixelShaderFragment() const
{
Q_D(const QGraphicsShaderEffect);
return d->pixelShaderFragment;
}
/*#
Sets the source code for the pixel shader fragment for
this shader effect to \a code.
The \a code must define a GLSL function with the signature
\c{lowp vec4 customShader(lowp sampler2D imageTexture, highp vec2 textureCoords)}
211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280
that returns the source pixel value to use in the paint engine's
shader program. The following is the default pixel shader fragment,
which draws a pixmap with no effect applied:
\code
lowp vec4 customShader(lowp sampler2D imageTexture, highp vec2 textureCoords) {
return texture2D(imageTexture, textureCoords);
}
\endcode
\sa pixelShaderFragment(), setUniforms()
*/
void QGraphicsShaderEffect::setPixelShaderFragment(const QByteArray& code)
{
Q_D(QGraphicsShaderEffect);
if (d->pixelShaderFragment != code) {
d->pixelShaderFragment = code;
#ifdef QGL_HAVE_CUSTOM_SHADERS
delete d->customShaderStage;
d->customShaderStage = 0;
#endif
}
}
/*#
\reimp
*/
void QGraphicsShaderEffect::draw(QPainter *painter)
{
Q_D(QGraphicsShaderEffect);
#ifdef QGL_HAVE_CUSTOM_SHADERS
// Set the custom shader on the paint engine. The setOnPainter()
// call may fail if the paint engine is not GL2. In that case,
// we fall through to drawing the pixmap normally.
if (!d->customShaderStage) {
d->customShaderStage = new QGLCustomShaderEffectStage
(this, d->pixelShaderFragment);
}
bool usingShader = d->customShaderStage->setOnPainter(painter);
QPoint offset;
if (sourceIsPixmap()) {
// No point in drawing in device coordinates (pixmap will be scaled anyways).
const QPixmap pixmap = sourcePixmap(Qt::LogicalCoordinates, &offset);
painter->drawPixmap(offset, pixmap);
} else {
// Draw pixmap in device coordinates to avoid pixmap scaling.
const QPixmap pixmap = sourcePixmap(Qt::DeviceCoordinates, &offset);
QTransform restoreTransform = painter->worldTransform();
painter->setWorldTransform(QTransform());
painter->drawPixmap(offset, pixmap);
painter->setWorldTransform(restoreTransform);
}
// Remove the custom shader to return to normal painting operations.
if (usingShader)
d->customShaderStage->removeFromPainter(painter);
#else
drawSource(painter);
#endif
}
/*#
Sets the custom uniform variables on this shader effect to
be dirty. The setUniforms() function will be called the next
time the shader program corresponding to this effect is used.
This function is typically called by subclasses when an
effect-specific parameter is changed by the application.
281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311
\sa setUniforms()
*/
void QGraphicsShaderEffect::setUniformsDirty()
{
#ifdef QGL_HAVE_CUSTOM_SHADERS
Q_D(QGraphicsShaderEffect);
if (d->customShaderStage)
d->customShaderStage->setUniformsDirty();
#endif
}
/*#
Sets custom uniform variables on the current GL context when
\a program is about to be used by the paint engine.
This function should be overridden if the shader set with
setPixelShaderFragment() has additional parameters beyond
those that the paint engine normally sets itself.
\sa setUniformsDirty()
*/
void QGraphicsShaderEffect::setUniforms(QGLShaderProgram *program)
{
Q_UNUSED(program);
}
QT_END_NAMESPACE
#endif // QT_NO_GRAPHICSEFFECT