src/declarative/items/qquickcanvas.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).
   4 ** All rights reserved.
   5 ** Contact: Nokia Corporation (qt-info@nokia.com)
   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 QQUICKCANVAS_H
  43 #define QQUICKCANVAS_H
  44
  45 #include <QtCore/qmetatype.h>
  46 #include <QtGui/qopengl.h>
  47 #include <QtGui/qwindow.h>
  48
  49 QT_BEGIN_HEADER
  50
  51 QT_BEGIN_NAMESPACE
  52
  53 QT_MODULE(Declarative)
  54
  55 class QQuickItem;
  56 class QSGEngine;
  57 class QSGTexture;
  58 class QQuickCanvasPrivate;
  59 class QOpenGLFramebufferObject;
  60 class QDeclarativeIncubationController;
  61
  62 class Q_DECLARATIVE_EXPORT QQuickCanvas : public QWindow
  63 {
  64 Q_OBJECT
  65 Q_DECLARE_PRIVATE(QQuickCanvas)
  66 public:
  67     enum CreateTextureOption {
  68         TextureHasAlphaChannel  = 0x0001,
  69         TextureHasMipmaps       = 0x0002,
  70         TextureOwnsGLTexture    = 0x0004
  71     };
  72
  73     Q_DECLARE_FLAGS(CreateTextureOptions, CreateTextureOption)
  74
  75     QQuickCanvas(QWindow *parent = 0);
  76
  77     virtual ~QQuickCanvas();
  78
  79     QQuickItem *rootItem() const;
  80     QQuickItem *activeFocusItem() const;
  81
  82     QQuickItem *mouseGrabberItem() const;
  83
  84     bool sendEvent(QQuickItem *, QEvent *);
  85
  86     QVariant inputMethodQuery(Qt::InputMethodQuery query) const;
  87
  88     QSGEngine *sceneGraphEngine() const;
  89
  90     void setVSyncAnimations(bool enabled);
  91     bool vsyncAnimations() const;
  92
  93     QImage grabFrameBuffer();
  94
  95     void setRenderTarget(QOpenGLFramebufferObject *fbo);
  96     QOpenGLFramebufferObject *renderTarget() const;
  97
  98     QDeclarativeIncubationController *incubationController() const;
  99
 100     // Scene graph specific functions
 101     QSGTexture *createTextureFromImage(const QImage &image) const;
 102     QSGTexture *createTextureFromId(uint id, const QSize &size, CreateTextureOptions options = CreateTextureOption(0)) const;
 103
 104     void setClearBeforeRendering(bool enabled);
 105     bool clearBeforeRendering() const;
 106
 107     void setClearColor(const QColor &color);
 108     QColor clearColor() const;
 109
 110     QOpenGLContext *openglContext() const;
 111
 112 Q_SIGNALS:
 113     void frameSwapped();
 114     void sceneGraphInitialized();
 115     void beforeRendering();
 116     void afterRendering();
 117
 118 protected:
 119     QQuickCanvas(QQuickCanvasPrivate &dd, QWindow *parent = 0);
 120
 121     virtual void exposeEvent(QExposeEvent *);
 122     virtual void resizeEvent(QResizeEvent *);
 123
 124     virtual void showEvent(QShowEvent *);
 125     virtual void hideEvent(QHideEvent *);
 126
 127     virtual void focusInEvent(QFocusEvent *);
 128     virtual void focusOutEvent(QFocusEvent *);
 129
 130     virtual bool event(QEvent *);
 131     virtual void keyPressEvent(QKeyEvent *);
 132     virtual void keyReleaseEvent(QKeyEvent *);
 133     virtual void inputMethodEvent(QInputMethodEvent *);
 134     virtual void mousePressEvent(QMouseEvent *);
 135     virtual void mouseReleaseEvent(QMouseEvent *);
 136     virtual void mouseDoubleClickEvent(QMouseEvent *);
 137     virtual void mouseMoveEvent(QMouseEvent *);
 138 #ifndef QT_NO_WHEELEVENT
 139     virtual void wheelEvent(QWheelEvent *);
 140 #endif
 141
 142 private Q_SLOTS:
 143     void sceneGraphChanged();
 144     void maybeUpdate();
 145     void animationStarted();
 146     void animationStopped();
 147
 148 private:
 149     friend class QQuickItem;
 150     friend class QQuickCanvasRenderLoop;
 151     Q_DISABLE_COPY(QQuickCanvas)
 152 };
 153
 154 QT_END_NAMESPACE
 155
 156 Q_DECLARE_METATYPE(QQuickCanvas *)
 157
 158 QT_END_HEADER
 159
 160 #endif // QQUICKCANVAS_H
 161