src/quick/scenegraph/coreapi/qsgmaterial.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
   4 ** Contact: http://www.qt-project.org/
   5 **
   6 ** This file is part of the QtDeclarative module of the Qt Toolkit.
   7 **
   8 ** $QT_BEGIN_LICENSE:LGPL$
   9 ** GNU Lesser General Public License Usage
  10 ** This file may be used under the terms of the GNU Lesser General Public
  11 ** License version 2.1 as published by the Free Software Foundation and
  12 ** appearing in the file LICENSE.LGPL included in the packaging of this
  13 ** file. Please review the following information to ensure the GNU Lesser
  14 ** General Public License version 2.1 requirements will be met:
  15 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  16 **
  17 ** In addition, as a special exception, Nokia gives you certain additional
  18 ** rights. These rights are described in the Nokia Qt LGPL Exception
  19 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  20 **
  21 ** GNU General Public License Usage
  22 ** Alternatively, this file may be used under the terms of the GNU General
  23 ** Public License version 3.0 as published by the Free Software Foundation
  24 ** and appearing in the file LICENSE.GPL included in the packaging of this
  25 ** file. Please review the following information to ensure the GNU General
  26 ** Public License version 3.0 requirements will be met:
  27 ** http://www.gnu.org/copyleft/gpl.html.
  28 **
  29 ** Other Usage
  30 ** Alternatively, this file may be used in accordance with the terms and
  31 ** conditions contained in a signed written agreement between you and Nokia.
  32 **
  33 **
  34 **
  35 **
  36 **
  37 **
  38 ** $QT_END_LICENSE$
  39 **
  40 ****************************************************************************/
  41
  42 #ifndef MATERIAL_H
  43 #define MATERIAL_H
  44
  45 #include <QtQuick/qtquickglobal.h>
  46 #include <qopenglshaderprogram.h>
  47
  48 QT_BEGIN_HEADER
  49
  50 QT_BEGIN_NAMESPACE
  51
  52 class QSGMaterial;
  53
  54 class Q_QUICK_EXPORT QSGMaterialShader
  55 {
  56 public:
  57     class Q_QUICK_EXPORT RenderState {
  58     public:
  59         enum DirtyState
  60         {
  61             DirtyMatrix         = 0x0001,
  62             DirtyOpacity        = 0x0002
  63         };
  64         Q_DECLARE_FLAGS(DirtyStates, DirtyState)
  65
  66         inline DirtyStates dirtyStates() const { return m_dirty; }
  67
  68         inline bool isMatrixDirty() const { return m_dirty & DirtyMatrix; }
  69         inline bool isOpacityDirty() const { return m_dirty & DirtyOpacity; }
  70
  71         float opacity() const;
  72         QMatrix4x4 combinedMatrix() const;
  73         QMatrix4x4 modelViewMatrix() const;
  74         QRect viewportRect() const;
  75         QRect deviceRect() const;
  76
  77         QOpenGLContext *context() const;
  78
  79     private:
  80         friend class QSGRenderer;
  81         DirtyStates m_dirty;
  82         const void *m_data;
  83     };
  84
  85     QSGMaterialShader();
  86
  87     virtual void activate();
  88     virtual void deactivate();
  89     // First time a material is used, oldMaterial is null.
  90     virtual void updateState(const RenderState &state, QSGMaterial *newMaterial, QSGMaterial *oldMaterial);
  91     virtual char const *const *attributeNames() const = 0; // Array must end with null.
  92
  93     inline QOpenGLShaderProgram *program() { return &m_program; }
  94
  95 protected:
  96
  97     friend class QSGContext;
  98
  99     virtual void compile();
 100     virtual void initialize() { }
 101
 102     virtual const char *vertexShader() const = 0;
 103     virtual const char *fragmentShader() const = 0;
 104
 105 private:
 106     QOpenGLShaderProgram m_program;
 107     void *m_reserved;
 108 };
 109
 110 struct QSGMaterialType { };
 111
 112 class Q_QUICK_EXPORT QSGMaterial
 113 {
 114 public:
 115     enum Flag {
 116         Blending            = 0x0001,
 117         RequiresDeterminant = 0x0002,
 118         RequiresFullMatrix  = 0x0004 | RequiresDeterminant
 119     };
 120     Q_DECLARE_FLAGS(Flags, Flag)
 121
 122     QSGMaterial();
 123     virtual ~QSGMaterial();
 124
 125     virtual QSGMaterialType *type() const = 0;
 126     virtual QSGMaterialShader *createShader() const = 0;
 127     virtual int compare(const QSGMaterial *other) const;
 128
 129     QSGMaterial::Flags flags() const { return m_flags; }
 130     void setFlag(Flags flags, bool on = true);
 131
 132 private:
 133     Flags m_flags;
 134     void *m_reserved;
 135     Q_DISABLE_COPY(QSGMaterial)
 136 };
 137
 138 Q_DECLARE_OPERATORS_FOR_FLAGS(QSGMaterial::Flags)
 139 Q_DECLARE_OPERATORS_FOR_FLAGS(QSGMaterialShader::RenderState::DirtyStates)
 140
 141 QT_END_NAMESPACE
 142
 143 QT_END_HEADER
 144
 145 #endif