1 /****************************************************************************
3 ** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
4 ** Contact: http://www.qt-project.org/
6 ** This file is part of the QtDeclarative module of the Qt Toolkit.
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.
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.
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.
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.
40 ****************************************************************************/
42 #ifndef QQUICKCANVAS_H
43 #define QQUICKCANVAS_H
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>
58 class QInputMethodEvent;
59 class QQuickCanvasPrivate;
60 class QOpenGLFramebufferObject;
61 class QDeclarativeIncubationController;
62 class QInputMethodEvent;
64 class Q_QUICK_EXPORT QQuickCanvas : public QWindow
67 Q_PRIVATE_PROPERTY(QQuickCanvas::d_func(), QDeclarativeListProperty<QObject> data READ data DESIGNABLE false)
68 Q_PROPERTY(QColor color READ clearColor WRITE setClearColor NOTIFY clearColorChanged)
69 Q_CLASSINFO("DefaultProperty", "data")
70 Q_DECLARE_PRIVATE(QQuickCanvas)
72 enum CreateTextureOption {
73 TextureHasAlphaChannel = 0x0001,
74 TextureHasMipmaps = 0x0002,
75 TextureOwnsGLTexture = 0x0004
78 Q_DECLARE_FLAGS(CreateTextureOptions, CreateTextureOption)
80 QQuickCanvas(QWindow *parent = 0);
82 virtual ~QQuickCanvas();
84 QQuickItem *rootItem() const;
85 QQuickItem *activeFocusItem() const;
86 QObject *focusObject() const;
88 QQuickItem *mouseGrabberItem() const;
90 bool sendEvent(QQuickItem *, QEvent *);
92 QSGEngine *sceneGraphEngine() const;
94 QImage grabFrameBuffer();
96 void setRenderTarget(QOpenGLFramebufferObject *fbo);
97 QOpenGLFramebufferObject *renderTarget() const;
99 void setRenderTarget(uint fboId, const QSize &size);
100 uint renderTargetId() const;
101 QSize renderTargetSize() const;
103 QDeclarativeIncubationController *incubationController() const;
105 virtual QAccessibleInterface *accessibleRoot() const;
107 // Scene graph specific functions
108 QSGTexture *createTextureFromImage(const QImage &image) const;
109 QSGTexture *createTextureFromId(uint id, const QSize &size, CreateTextureOptions options = CreateTextureOption(0)) const;
111 void setClearBeforeRendering(bool enabled);
112 bool clearBeforeRendering() const;
114 void setClearColor(const QColor &color);
115 QColor clearColor() const;
117 QOpenGLContext *openglContext() const;
121 void sceneGraphInitialized();
122 void sceneGraphInvalidated();
123 void beforeRendering();
124 void afterRendering();
125 void clearColorChanged(const QColor &);
128 QQuickCanvas(QQuickCanvasPrivate &dd, QWindow *parent = 0);
130 virtual void exposeEvent(QExposeEvent *);
131 virtual void resizeEvent(QResizeEvent *);
133 virtual void showEvent(QShowEvent *);
134 virtual void hideEvent(QHideEvent *);
136 virtual void focusInEvent(QFocusEvent *);
137 virtual void focusOutEvent(QFocusEvent *);
139 virtual bool event(QEvent *);
140 virtual void keyPressEvent(QKeyEvent *);
141 virtual void keyReleaseEvent(QKeyEvent *);
142 virtual void mousePressEvent(QMouseEvent *);
143 virtual void mouseReleaseEvent(QMouseEvent *);
144 virtual void mouseDoubleClickEvent(QMouseEvent *);
145 virtual void mouseMoveEvent(QMouseEvent *);
146 #ifndef QT_NO_WHEELEVENT
147 virtual void wheelEvent(QWheelEvent *);
152 void cleanupSceneGraph();
155 friend class QQuickItem;
156 friend class QQuickCanvasRenderLoop;
157 Q_DISABLE_COPY(QQuickCanvas)
162 Q_DECLARE_METATYPE(QQuickCanvas *)
166 #endif // QQUICKCANVAS_H