Differential D24215 Diff 66902 libkwineffects/kwineffectquickview.h

Changeset View

Standalone View

libkwineffects/kwineffectquickview.h

This file was added.

1		/********************************************************************
2		KWin - the KDE window manager
3		This file is part of the KDE project.
4
5		Copyright (C) 2019 David Edmundson <davidedmundson@kde.org>
6
7		This program is free software; you can redistribute it and/or modify
8		it under the terms of the GNU General Public License as published by
9		the Free Software Foundation; either version 2 of the License, or
10		(at your option) any later version.
11
12		This program is distributed in the hope that it will be useful,
13		but WITHOUT ANY WARRANTY; without even the implied warranty of
14		MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15		GNU General Public License for more details.
16
17		You should have received a copy of the GNU General Public License
18		along with this program. If not, see <http://www.gnu.org/licenses/>.
19		*********************************************************************/
20
21		#pragma once
22
23		#include <QObject>
24		#include <QUrl>
25		#include <QRect>
26
27		#include <kwineffects_export.h>
28
29		#include "kwineffects.h"
30
31		#include <memory>
32
33		class QKeyEvent;
34		class QMouseEvent;
35		class QOpenGLContext;
36
37		class QMouseEvent;
38		class QKeyEvent;
39
40		class QQmlContext;
41		class QQuickItem;
42
43		namespace KWin
44		{
45		class GLTexture;
46
47		class EffectQuickView;
48
49		/**
50		* @brief The KwinQuickView class provides a convenient API for exporting
51		* QtQuick scenes as buffers that can be composited in any other fashion.
52		*
53		* Contents can be fetched as a GL Texture or as a QImage
54		* If data is to be fetched as an image, it should be specified upfront as
55		* blitting is performed when we update our FBO to keep kwin's render loop
56		* as fast as possible.
57		*/
58		class KWINEFFECTS_EXPORT EffectQuickView : public QObject
59		{
60		Q_OBJECT
61
62		public:
63		static void setShareContext(std::unique_ptr<QOpenGLContext> context);
64
65		enum class ExportMode {
66		/** The contents will be available as a texture in the shared contexts. Image will be blank*/
67		Texture,
68		/** The contents will be blit during the update into a QImage buffer. */
69		Image
70		};
71
72		/**
73		* Construct a new KWinQuickView
74		* Export mode will be determined by the current effectsHandler
75		*/
76		EffectQuickView(QObject *parent);
77
78		/**
79		* Construct a new KWinQuickView explicitly stating an export mode
80		*/
81		EffectQuickView(QObject *parent, ExportMode exportMode);
82
83		/**
84		* Note that this may change the current GL Context
85		*/
86		~EffectQuickView();
87
88		QSize size() const;
	zzagUnsubmitted Done stray semicolon zzag: stray semicolon
89
90		/**
91		* The geometry of the current view
92		* This may be out of sync with the current buffer size if an update is pending
93		*/
94		void setGeometry(const QRect &rect);
95		QRect geometry() const;
96
97		/**
98		* Render the current scene graph into the FBO.
99		* This is typically done automatically when the scene changes
100		* albeit deffered by a timer
101		*
102		* It can be manually invoked to update the contents immediately.
103		* Note this will change the GL context
104		*/
105		void update();
106
107		/** The invisble root item of the window*/
108		QQuickItem *contentItem() const;
109
110		/**
111		* @brief Marks the window as visible/invisible
112		* This can be used to release resources used by the window
113		* The default is true.
114		*/
115		void setVisible(bool visible);
116		bool isVisible() const;
117
118		void show();
119		void hide();
120
121		/**
122		* Returns the current output of the scene graph
123		* @note The render context must valid at the time of calling
124		*/
125		GLTexture *bufferAsTexture();
126
127		/**
128		* Returns the current output of the scene graph
129		*/
130		QImage bufferAsImage() const;
131
132		/**
133		* Inject any mouse event into the QQuickWindow.
134		* Local co-ordinates are transformed
135		* If it is handled the event will be accepted
136		*/
137		void forwardMouseEvent(QEvent *mouseEvent);
138		/**
139		* Inject a key event into the window.
140		* If it is handled the event will be accepted
141		*/
142		void forwardKeyEvent(QKeyEvent *keyEvent);
143
144		Q_SIGNALS:
145		/**
146		* The frame buffer has changed, contents need re-rendering on screen
147		*/
148		void repaintNeeded();
149		void geometryChanged(const QRect &oldGeometry, const QRect &newGeometry);
150
151		private:
152		class Private;
153		QScopedPointer<Private> d;
154		};
155
156		/**
157		* The KWinQuickScene class extends KWinQuickView
158		* adding QML support. This will represent a context
159		* powered by an engine
160		*/
161		class KWINEFFECTS_EXPORT EffectQuickScene : public EffectQuickView
162		{
163		public:
164		EffectQuickScene(QObject *parent);
165		EffectQuickScene(QObject *parent, ExportMode exportMode);
166		~EffectQuickScene();
167
168		QQmlContext *rootContext() const;
169		/** top level item in the given source*/
170		QQuickItem *rootItem() const;
171
172		void setSource(const QUrl &source);
173
174		private:
175		class Private;
176		QScopedPointer<Private> d;
177		};
178
179		}