Differential D24215 Diff 66804 libkwineffects/kwineffectquickview.cpp

Changeset View

Standalone View

View Options

libkwineffects/kwineffectquickview.cpp

  • 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​#include "kwineffectquickview.h"
22​
23​#include "kwinglutils.h"
24​#include "kwineffects.h"
25​
26​#include <QQmlEngine>
27​#include <QQuickItem>
28​#include <QQmlContext>
29​#include <QQmlComponent>
30​#include <QQuickView>
31​#include <QQuickRenderControl>
32​#include <QUrl>
33​
34​#include <QOffscreenSurface>
35​#include <QOpenGLContext>
36​#include <QOpenGLFramebufferObject>
37​#include <QTimer>
38​
39​#include <KDeclarative/QmlObjectSharedEngine>
40​
41​using namespace KWin;
42​
43​static std::unique_ptr<QOpenGLContext> s_shareContext;
44​
45​class Q_DECL_HIDDEN EffectQuickView::Private
46​{
47​public:
48​ QQuickWindow *m_view;
49​ QQuickRenderControl *m_renderControl;
50​ QScopedPointer<QOpenGLContext> m_glcontext;
51​ QScopedPointer<QOffscreenSurface> m_offscreenSurface;
52​ QScopedPointer<QOpenGLFramebufferObject> m_fbo;
53​
54​ // if we should capture a QImage after rendering into our BO.
55​ // Used for either software QtQuick rendering and nonGL kwin rendering
56​ QImage m_image;
57​ QScopedPointer<GLTexture> m_textureExport;
58​ bool m_useBlit = false;
59​ bool m_visible = true;
60​};
61​
62​class Q_DECL_HIDDEN EffectQuickScene::Private
63​{
64​public:
65​ KDeclarative::QmlObjectSharedEngine *qmlObject = nullptr;
66​};
67​
68​EffectQuickView::EffectQuickView(QObject *parent)
69​ : EffectQuickView(parent, effects->isOpenGLCompositing() ? ExportMode::Texture : ExportMode::Image)
70​{
71​}
72​
73​EffectQuickView::EffectQuickView(QObject *parent, ExportMode exportMode)
74​ : QObject(parent)
75​ , d(new EffectQuickView::Private)
76​{
77​ d->m_renderControl = new QQuickRenderControl(this);
78​
79​ d->m_view = new QQuickWindow(d->m_renderControl);
80​ d->m_view->setFlags(Qt::FramelessWindowHint);
81​ d->m_view->setColor(Qt::transparent);
82​
83​ if (exportMode == ExportMode::Image) {
84​ d->m_useBlit = true;
85​ }
86​
87​ bool usingGl = d->m_view->rendererInterface()->graphicsApi() == QSGRendererInterface::OpenGL;
zzagUnsubmitted
Done

Mark as const

zzag: Mark as const
88​
89​ if (!usingGl) {
90​ qDebug() << "QtQuick Software rendering mode detected";
zzagUnsubmitted
Done

Use qCDebug.

zzag: Use qCDebug.
91​ d->m_useBlit = true;
92​ d->m_renderControl->initialize(nullptr);
93​ } else {
94​ QSurfaceFormat format;
95​ format.setOption(QSurfaceFormat::ResetNotification);
96​ format.setDepthBufferSize(16);
97​ format.setStencilBufferSize(8);
98​
99​ d->m_glcontext.reset(new QOpenGLContext);
100​ d->m_glcontext->setShareContext(s_shareContext.get());
101​ d->m_glcontext->setFormat(format);
102​ d->m_glcontext->create();
103​
104​ // and the offscreen surface
105​ d->m_offscreenSurface.reset(new QOffscreenSurface);
106​ d->m_offscreenSurface->setFormat(d->m_glcontext->format());
107​ d->m_offscreenSurface->create();
108​
109​ d->m_glcontext->makeCurrent(d->m_offscreenSurface.data());
110​ d->m_renderControl->initialize(d->m_glcontext.data());
111​ d->m_glcontext->doneCurrent();
112​
113​ if (!d->m_glcontext->shareContext()) {
114​ qDebug() << "Failed to create a shared context, falling back to raster rendering";
115​
116​ qDebug() << "Extra debug:";
117​ qDebug() << "our context: " << d->m_glcontext.data();
zzagUnsubmitted
Done

You don't need to put whitespace after colon.

zzag: You don't need to put whitespace after colon.
118​ qDebug() << "share context: " << s_shareContext.get();
119​
120​ // still render via GL, but blit for presentation
121​ d->m_useBlit = true;
122​ }
123​ }
124​
125​ auto updateSize = [this]() { contentItem()->setSize(d->m_view->size()); };
126​ updateSize();
127​ connect(d->m_view, &QWindow::widthChanged, this, updateSize);
128​ connect(d->m_view, &QWindow::heightChanged, this, updateSize);
129​
130​ QTimer *t = new QTimer(this);
131​ t->setSingleShot(true);
132​ t->setInterval(10);
133​
134​ connect(t, &QTimer::timeout, this, &EffectQuickView::update);
135​ connect(d->m_renderControl, &QQuickRenderControl::renderRequested, t, [t]() { t->start(); });
136​ connect(d->m_renderControl, &QQuickRenderControl::sceneChanged, t, [t]() { t->start(); });
137​}
138​
139​EffectQuickView::~EffectQuickView()
140​{
141​}
142​
143​void EffectQuickView::update()
144​{
145​ if (!d->m_visible) {
146​ return;
147​ }
148​ if (d->m_view->size().isEmpty()) {
149​ return;
150​ }
151​
152​ bool usingGl = d->m_glcontext;
153​
154​ if (usingGl) {
155​ if (!d->m_glcontext->makeCurrent(d->m_offscreenSurface.data())) {
156​ // probably a context loss event, kwin is about to reset all the effects anyway
157​ return;
158​ }
159​
160​ if (d->m_fbo.isNull() || d->m_fbo->size() != d->m_view->size()) {
161​ d->m_textureExport.reset(nullptr);
162​ d->m_fbo.reset(new QOpenGLFramebufferObject(d->m_view->size(), QOpenGLFramebufferObject::CombinedDepthStencil));
163​ if (!d->m_fbo->isValid()) {
164​ d->m_fbo.reset();
165​ d->m_glcontext->doneCurrent();
166​ return;
167​ }
168​ }
169​ d->m_view->setRenderTarget(d->m_fbo.data());
170​ }
171​
172​ d->m_renderControl->polishItems();
173​ d->m_renderControl->sync();
174​
175​ d->m_renderControl->render();
176​ if (usingGl) {
177​ d->m_view->resetOpenGLState();
178​ }
179​
180​ if (d->m_useBlit) {
181​ d->m_image = d->m_renderControl->grab();
182​ }
183​
184​ if (usingGl) {
185​ QOpenGLFramebufferObject::bindDefault();
186​ d->m_glcontext->doneCurrent();
187​ }
188​ emit repaintNeeded();
189​}
190​
191​void EffectQuickView::forwardMouseEvent(QEvent *e)
192​{
193​ if (!d->m_visible) {
194​ return;
195​ }
196​ QMouseEvent *me = dynamic_cast<QMouseEvent *>(e);
zzagUnsubmitted
Done

Use static_cast

zzag: Use static_cast
197​ const QPoint widgetPos = d->m_view->mapFromGlobal(me->pos());
198​
199​ QMouseEvent cloneEvent(me->type(), widgetPos, me->pos(), me->button(), me->buttons(), me->modifiers());
200​ QCoreApplication::sendEvent(d->m_view, &cloneEvent);
201​ e->setAccepted(cloneEvent.isAccepted());
202​}
203​
204​void EffectQuickView::forwardKeyEvent(QKeyEvent *keyEvent)
205​{
206​ if (!d->m_visible) {
207​ return;
208​ }
209​ QCoreApplication::sendEvent(d->m_view, keyEvent);
210​}
211​
212​void EffectQuickView::setShareContext(std::unique_ptr<QOpenGLContext> context)
213​{
214​ s_shareContext = std::move(context);
215​}
216​
217​QRect EffectQuickView::geometry() const
218​{
219​ return d->m_view->geometry();
220​}
221​
222​QQuickItem *EffectQuickView::contentItem() const
223​{
224​ return d->m_view->contentItem();
225​}
226​
227​void EffectQuickView::setVisible(bool visible)
228​{
229​ if (d->m_visible == visible) {
230​ return;
231​ }
232​ d->m_visible = visible;
233​
234​ if (visible) {
235​ if (d->m_glcontext) {
236​ d->m_glcontext->makeCurrent(d->m_offscreenSurface.data());
237​ d->m_renderControl->initialize(d->m_glcontext.data());
238​ d->m_glcontext->doneCurrent();
239​ } else {
240​ d->m_renderControl->initialize(nullptr);
241​ }
242​ update();
243​ } else {
244​ d->m_renderControl->invalidate();
245​ }
246​}
247​
248​bool EffectQuickView::visible() const
249​{
250​ return d->m_visible;
251​}
252​
253​GLTexture *EffectQuickView::bufferAsTexture()
254​{
255​ if (d->m_useBlit) {
256​ if (d->m_image.isNull()) {
257​ return nullptr;
258​ }
259​ d->m_textureExport.reset(new GLTexture(d->m_image));
260​ } else {
261​ if (!d->m_fbo) {
262​ return nullptr;
263​ }
264​ if (!d->m_textureExport) {
265​ d->m_textureExport.reset(new GLTexture(d->m_fbo->texture(), GL_RGBA8, d->m_fbo->size()));
266​ }
267​ }
268​ return d->m_textureExport.data();
269​}
270​
271​QImage EffectQuickView::bufferAsImage() const
272​{
273​ return d->m_image;
274​}
275​
276​QSize EffectQuickView::size() const
277​{
278​ return d->m_view->geometry().size();
279​}
280​
281​void EffectQuickView::setGeometry(const QRect &rect)
282​{
283​ const QRect oldGeometry = d->m_view->geometry();
284​ d->m_view->setGeometry(rect);
285​ emit geometryChanged(oldGeometry, rect);
286​}
287​
288​EffectQuickScene::EffectQuickScene(QObject *parent)
289​ : EffectQuickView(parent)
290​ , d(new EffectQuickScene::Private)
291​{
292​}
293​
294​EffectQuickScene::EffectQuickScene(QObject *parent, EffectQuickView::ExportMode exportMode)
295​ : EffectQuickView(parent, exportMode)
296​ , d(new EffectQuickScene::Private)
297​{
298​}
299​
300​EffectQuickScene::~EffectQuickScene()
301​{
302​}
303​
304​void EffectQuickScene::setSource(const QUrl &source)
305​{
306​ if (!d->qmlObject) {
307​ d->qmlObject = new KDeclarative::QmlObjectSharedEngine(this);
308​ }
309​ d->qmlObject->setSource(source);
310​
311​ QQuickItem *item = rootItem();
312​ if (!item) {
313​ qDebug() << "Could not load effect quick view" << source;
314​ return;
315​ }
316​ item->setParentItem(contentItem());
317​
318​ auto updateSize = [item, this]() { item->setSize(contentItem()->size()); };
319​ updateSize();
320​ connect(contentItem(), &QQuickItem::widthChanged, item, updateSize);
321​ connect(contentItem(), &QQuickItem::heightChanged, item, updateSize);
322​
323​ // trigger immediate render
324​ update();
325​}
326​
327​QQmlContext *EffectQuickScene::rootContext() const
328​{
329​ return d->qmlObject->rootContext();
330​}
331​
332​QQuickItem *EffectQuickScene::rootItem() const
333​{
334​ return qobject_cast<QQuickItem *>(d->qmlObject->rootObject());
335​}