src/quick/scenegraph/util/qsgengine.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 QSGENGINE_H
  43 #define QSGENGINE_H
  44
  45 #include <QObject>
  46
  47 #include <QtQuick/qsgtexture.h>
  48
  49 QT_BEGIN_HEADER
  50
  51 QT_BEGIN_NAMESPACE
  52
  53 class QSGEnginePrivate;
  54
  55 class QQuickCanvas;
  56
  57 class Q_QUICK_EXPORT QSGEngine : public QObject
  58 {
  59     Q_OBJECT
  60
  61     Q_DECLARE_PRIVATE(QSGEngine)
  62
  63 public:
  64
  65     enum TextureOption {
  66         TextureHasAlphaChannel  = 0x0001,
  67         TextureHasMipmaps       = 0x0002,
  68         TextureOwnsGLTexture    = 0x0004
  69     };
  70     Q_DECLARE_FLAGS(TextureOptions, TextureOption)
  71
  72     QSGTexture *createTextureFromImage(const QImage &image) const;
  73     QSGTexture *createTextureFromId(uint id, const QSize &size, TextureOptions options = TextureOption(0)) const;
  74
  75     void setClearBeforeRendering(bool enabled);
  76     bool clearBeforeRendering() const;
  77
  78     void setClearColor(const QColor &color);
  79     QColor clearColor() const;
  80
  81 Q_SIGNALS:
  82     void beforeRendering();
  83     void afterRendering();
  84
  85 private:
  86     QSGEngine(QObject *parent = 0);
  87     ~QSGEngine();
  88
  89     friend class QSGContext;
  90     friend class QSGContextPrivate;
  91     friend class QQuickCanvasPrivate;
  92     void setCanvas(QQuickCanvas *canvas);
  93
  94 };
  95
  96 QT_END_NAMESPACE
  97
  98 QT_END_HEADER
  99
 100 #endif // QSGENGINE_H