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 QtQml 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>
57 class QInputMethodEvent;
58 class QQuickCanvasPrivate;
59 class QOpenGLFramebufferObject;
60 class QQmlIncubationController;
61 class QInputMethodEvent;
63 class Q_QUICK_EXPORT QQuickCanvas : public QWindow
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)
71 enum CreateTextureOption {
72 TextureHasAlphaChannel = 0x0001,
73 TextureHasMipmaps = 0x0002,
74 TextureOwnsGLTexture = 0x0004
77 Q_DECLARE_FLAGS(CreateTextureOptions, CreateTextureOption)
79 QQuickCanvas(QWindow *parent = 0);
81 virtual ~QQuickCanvas();
83 QQuickItem *rootItem() const;
84 QQuickItem *activeFocusItem() const;
85 QObject *focusObject() const;
87 QQuickItem *mouseGrabberItem() const;
89 bool sendEvent(QQuickItem *, QEvent *);
91 QImage grabFrameBuffer();
93 void setRenderTarget(QOpenGLFramebufferObject *fbo);
94 QOpenGLFramebufferObject *renderTarget() const;
96 void setRenderTarget(uint fboId, const QSize &size);
97 uint renderTargetId() const;
98 QSize renderTargetSize() const;
100 QQmlIncubationController *incubationController() const;
102 #ifndef QT_NO_ACCESSIBILITY
103 virtual QAccessibleInterface *accessibleRoot() const;
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;
110 void setClearBeforeRendering(bool enabled);
111 bool clearBeforeRendering() const;
113 void setClearColor(const QColor &color);
114 QColor clearColor() const;
116 void setPersistentOpenGLContext(bool persistent);
117 bool isPersistentOpenGLContext() const;
119 void setPersistentSceneGraph(bool persistent);
120 bool isPersistentSceneGraph() const;
122 QOpenGLContext *openglContext() const;
126 void sceneGraphInitialized();
127 void sceneGraphInvalidated();
128 void beforeRendering();
129 void afterRendering();
130 void clearColorChanged(const QColor &);
133 void releaseResources();
136 QQuickCanvas(QQuickCanvasPrivate &dd, QWindow *parent = 0);
138 virtual void exposeEvent(QExposeEvent *);
139 virtual void resizeEvent(QResizeEvent *);
141 virtual void showEvent(QShowEvent *);
142 virtual void hideEvent(QHideEvent *);
144 virtual void focusInEvent(QFocusEvent *);
145 virtual void focusOutEvent(QFocusEvent *);
147 virtual bool event(QEvent *);
148 virtual void keyPressEvent(QKeyEvent *);
149 virtual void keyReleaseEvent(QKeyEvent *);
150 virtual void mousePressEvent(QMouseEvent *);
151 virtual void mouseReleaseEvent(QMouseEvent *);
152 virtual void mouseDoubleClickEvent(QMouseEvent *);
153 virtual void mouseMoveEvent(QMouseEvent *);
154 #ifndef QT_NO_WHEELEVENT
155 virtual void wheelEvent(QWheelEvent *);
160 void cleanupSceneGraph();
163 friend class QQuickItem;
164 friend class QQuickCanvasRenderLoop;
165 Q_DISABLE_COPY(QQuickCanvas)
170 Q_DECLARE_METATYPE(QQuickCanvas *)
174 #endif // QQUICKCANVAS_H