src/quick/items/qquickshadereffectnode_p.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
   4 ** All rights reserved.
   5 ** Contact: http://www.qt-project.org/
   6 **
   7 ** This file is part of the QtDeclarative 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 QQUICKSHADEREFFECTNODE_P_H
  43 #define QQUICKSHADEREFFECTNODE_P_H
  44
  45 #include <QtQuick/qsgnode.h>
  46 #include <QtQuick/qsgmaterial.h>
  47 #include <QtQuick/qsgtextureprovider.h>
  48 #include <QtQuick/qquickitem.h>
  49
  50 #include <QtCore/qsharedpointer.h>
  51 #include <QtCore/qpointer.h>
  52
  53 QT_BEGIN_HEADER
  54
  55 QT_BEGIN_NAMESPACE
  56
  57 struct QQuickShaderEffectMaterialKey {
  58     QByteArray vertexCode;
  59     QByteArray fragmentCode;
  60     const char *className;
  61
  62     bool operator == (const QQuickShaderEffectMaterialKey &other) const;
  63 };
  64
  65 uint qHash(const QQuickShaderEffectMaterialKey &key);
  66
  67 // TODO: Implement support for multisampling.
  68 struct QQuickShaderEffectProgram : public QQuickShaderEffectMaterialKey
  69 {
  70     QQuickShaderEffectProgram() : respectsOpacity(false), respectsMatrix(false) {}
  71
  72     QVector<QByteArray> attributeNames;
  73     QSet<QByteArray> uniformNames;
  74
  75     uint respectsOpacity : 1;
  76     uint respectsMatrix : 1;
  77 };
  78
  79
  80 class QQuickCustomMaterialShader;
  81 class QQuickShaderEffectNode;
  82 class QQuickShaderEffectMaterial : public QSGMaterial
  83 {
  84 public:
  85     enum CullMode
  86     {
  87         NoCulling,
  88         BackFaceCulling,
  89         FrontFaceCulling
  90     };
  91
  92     explicit QQuickShaderEffectMaterial(QQuickShaderEffectNode *node = 0);
  93     virtual QSGMaterialType *type() const;
  94     virtual QSGMaterialShader *createShader() const;
  95     virtual int compare(const QSGMaterial *other) const;
  96
  97     void setCullMode(CullMode face);
  98     CullMode cullMode() const;
  99
 100     void setProgramSource(const QQuickShaderEffectProgram &);
 101     void setUniforms(const QVector<QPair<QByteArray, QVariant> > &uniformValues);
 102     void setTextureProviders(const QVector<QPair<QByteArray, QSGTextureProvider *> > &textures);
 103     const QVector<QPair<QByteArray, QSGTextureProvider *> > &textureProviders() const;
 104     void updateTextures() const;
 105
 106 protected:
 107     friend class QQuickCustomMaterialShader;
 108
 109     // The type pointer needs to be unique. It is not safe to let the type object be part of the
 110     // QQuickShaderEffectMaterial, since it can be deleted and a new one constructed on top of the old
 111     // one. The new QQuickShaderEffectMaterial would then get the same type pointer as the old one, and
 112     // CustomMaterialShaders based on the old one would incorrectly be used together with the new
 113     // one. To guarantee that the type pointer is unique, the type object must live as long as
 114     // there are any CustomMaterialShaders of that type.
 115     QSharedPointer<QSGMaterialType> m_type;
 116
 117     QQuickShaderEffectProgram m_source;
 118     QVector<QPair<QByteArray, QVariant> > m_uniformValues;
 119     QVector<QPair<QByteArray, QSGTextureProvider *> > m_textures;
 120     CullMode m_cullMode;
 121     QQuickShaderEffectNode *m_node;
 122     bool m_emittedLogChanged;
 123
 124     static QHash<QQuickShaderEffectMaterialKey, QSharedPointer<QSGMaterialType> > materialMap;
 125 };
 126
 127
 128 class QSGShaderEffectMesh;
 129
 130 class QQuickShaderEffectNode : public QObject, public QSGGeometryNode
 131 {
 132     Q_OBJECT
 133 public:
 134     QQuickShaderEffectNode();
 135     virtual ~QQuickShaderEffectNode();
 136
 137     virtual void preprocess();
 138
 139     QQuickShaderEffectMaterial *shaderMaterial() { return &m_material; }
 140
 141 Q_SIGNALS:
 142     void logAndStatusChanged(const QString &, int status);
 143
 144 private Q_SLOTS:
 145     void markDirtyTexture();
 146
 147 private:
 148     QQuickShaderEffectMaterial m_material;
 149 };
 150
 151 QT_END_NAMESPACE
 152
 153 QT_END_HEADER
 154
 155 #endif // QQUICKSHADEREFFECTNODE_P_H