src/quick/items/qquickcanvas.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 QtQml 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 QQUICKCANVAS_H
  43 #define QQUICKCANVAS_H
  44
  45 #include <QtQuick/qtquickglobal.h>
  46 #include <QtCore/qmetatype.h>
  47 #include <QtGui/qopengl.h>
  48 #include <QtGui/qwindow.h>
  49 #include <QtGui/qevent.h>
  50
  51 QT_BEGIN_HEADER
  52
  53 QT_BEGIN_NAMESPACE
  54
  55 class QQuickItem;
  56 class QSGTexture;
  57 class QInputMethodEvent;
  58 class QQuickCanvasPrivate;
  59 class QOpenGLFramebufferObject;
  60 class QQmlIncubationController;
  61 class QInputMethodEvent;
  62
  63 class Q_QUICK_EXPORT QQuickCanvas : public QWindow
  64 {
  65     Q_OBJECT
  66     Q_PRIVATE_PROPERTY(QQuickCanvas::d_func(), QQmlListProperty<QObject> data READ data DESIGNABLE false)
  67     Q_PROPERTY(QColor color READ clearColor WRITE setClearColor NOTIFY clearColorChanged)
  68     Q_CLASSINFO("DefaultProperty", "data")
  69     Q_DECLARE_PRIVATE(QQuickCanvas)
  70 public:
  71     enum CreateTextureOption {
  72         TextureHasAlphaChannel  = 0x0001,
  73         TextureHasMipmaps       = 0x0002,
  74         TextureOwnsGLTexture    = 0x0004
  75     };
  76
  77     Q_DECLARE_FLAGS(CreateTextureOptions, CreateTextureOption)
  78
  79     QQuickCanvas(QWindow *parent = 0);
  80
  81     virtual ~QQuickCanvas();
  82
  83     QQuickItem *rootItem() const;
  84     QQuickItem *activeFocusItem() const;
  85     QObject *focusObject() const;
  86
  87     QQuickItem *mouseGrabberItem() const;
  88
  89     bool sendEvent(QQuickItem *, QEvent *);
  90
  91     QImage grabFrameBuffer();
  92
  93     void setRenderTarget(QOpenGLFramebufferObject *fbo);
  94     QOpenGLFramebufferObject *renderTarget() const;
  95
  96     void setRenderTarget(uint fboId, const QSize &size);
  97     uint renderTargetId() const;
  98     QSize renderTargetSize() const;
  99
 100     QQmlIncubationController *incubationController() const;
 101
 102 #ifndef QT_NO_ACCESSIBILITY
 103     virtual QAccessibleInterface *accessibleRoot() const;
 104 #endif
 105
 106     // Scene graph specific functions
 107     QSGTexture *createTextureFromImage(const QImage &image) const;
 108     QSGTexture *createTextureFromId(uint id, const QSize &size, CreateTextureOptions options = CreateTextureOption(0)) const;
 109
 110     void setClearBeforeRendering(bool enabled);
 111     bool clearBeforeRendering() const;
 112
 113     void setClearColor(const QColor &color);
 114     QColor clearColor() const;
 115
 116     void setPersistentOpenGLContext(bool persistent);
 117     bool isPersistentOpenGLContext() const;
 118
 119     void setPersistentSceneGraph(bool persistent);
 120     bool isPersistentSceneGraph() const;
 121
 122     QOpenGLContext *openglContext() const;
 123
 124 Q_SIGNALS:
 125     void frameSwapped();
 126     void sceneGraphInitialized();
 127     void sceneGraphInvalidated();
 128     void beforeSynchronizing();
 129     void beforeRendering();
 130     void afterRendering();
 131     void clearColorChanged(const QColor &);
 132
 133 public Q_SLOTS:
 134     void update();
 135     void releaseResources();
 136
 137 protected:
 138     QQuickCanvas(QQuickCanvasPrivate &dd, QWindow *parent = 0);
 139
 140     virtual void exposeEvent(QExposeEvent *);
 141     virtual void resizeEvent(QResizeEvent *);
 142
 143     virtual void showEvent(QShowEvent *);
 144     virtual void hideEvent(QHideEvent *);
 145
 146     virtual void focusInEvent(QFocusEvent *);
 147     virtual void focusOutEvent(QFocusEvent *);
 148
 149     virtual bool event(QEvent *);
 150     virtual void keyPressEvent(QKeyEvent *);
 151     virtual void keyReleaseEvent(QKeyEvent *);
 152     virtual void mousePressEvent(QMouseEvent *);
 153     virtual void mouseReleaseEvent(QMouseEvent *);
 154     virtual void mouseDoubleClickEvent(QMouseEvent *);
 155     virtual void mouseMoveEvent(QMouseEvent *);
 156 #ifndef QT_NO_WHEELEVENT
 157     virtual void wheelEvent(QWheelEvent *);
 158 #endif
 159
 160 private Q_SLOTS:
 161     void maybeUpdate();
 162     void cleanupSceneGraph();
 163
 164 private:
 165     friend class QQuickItem;
 166     friend class QQuickCanvasRenderLoop;
 167     Q_DISABLE_COPY(QQuickCanvas)
 168 };
 169
 170 QT_END_NAMESPACE
 171
 172 Q_DECLARE_METATYPE(QQuickCanvas *)
 173
 174 QT_END_HEADER
 175
 176 #endif // QQUICKCANVAS_H
 177