Merge lp:~gerboland/qtubuntu/rasterGLSurface into lp:qtubuntu

[Gerry Boland]

Fix rendering of apps using QQuickWidget

Based on a branch by Daniel d'Andrada
- Advertise RasterGLSurface capability
- Implement proper offscreen rendering support using EGL pixel buffers.
- Don't create mir surfaces for Qt::Desktop QWindows. Proper implementation still pending
- Add BackingStore toImage method, fixes render of QQuick and Widget content

Tested working correctly on Desktop (Mesa), Nexus 4 & 7, Meizu MX4, Bq Aquaris 4.5.
M10 has rendering problems, still unresolved.

Good test is the "quickwidget" demo in qtdeclarative5-examples as it uses QQuickWidget, which combines QML and Widget content in a single window. You can also test QtCreator

[Unity8 CI Bot (unity8-ci-bot)]

PASSED: Continuous integration, rev:335
https://unity8-jenkins.ubuntu.com/job/lp-qtubuntu-ci/124/
Executed test runs:
    SUCCESS: https://unity8-jenkins.ubuntu.com/job/build/2973
    SUCCESS: https://unity8-jenkins.ubuntu.com/job/build-0-fetch/3001
    SUCCESS: https://unity8-jenkins.ubuntu.com/job/build-2-binpkg/arch=amd64,release=vivid+overlay/2859
        deb: https://unity8-jenkins.ubuntu.com/job/build-2-binpkg/arch=amd64,release=vivid+overlay/2859/artifact/output/*zip*/output.zip
    SUCCESS: https://unity8-jenkins.ubuntu.com/job/build-2-binpkg/arch=amd64,release=xenial+overlay/2859
        deb: https://unity8-jenkins.ubuntu.com/job/build-2-binpkg/arch=amd64,release=xenial+overlay/2859/artifact/output/*zip*/output.zip
    SUCCESS: https://unity8-jenkins.ubuntu.com/job/build-2-binpkg/arch=amd64,release=yakkety/2859
        deb: https://unity8-jenkins.ubuntu.com/job/build-2-binpkg/arch=amd64,release=yakkety/2859/artifact/output/*zip*/output.zip
    SUCCESS: https://unity8-jenkins.ubuntu.com/job/build-2-binpkg/arch=armhf,release=vivid+overlay/2859
        deb: https://unity8-jenkins.ubuntu.com/job/build-2-binpkg/arch=armhf,release=vivid+overlay/2859/artifact/output/*zip*/output.zip
    SUCCESS: https://unity8-jenkins.ubuntu.com/job/build-2-binpkg/arch=armhf,release=xenial+overlay/2859
        deb: https://unity8-jenkins.ubuntu.com/job/build-2-binpkg/arch=armhf,release=xenial+overlay/2859/artifact/output/*zip*/output.zip
    SUCCESS: https://unity8-jenkins.ubuntu.com/job/build-2-binpkg/arch=armhf,release=yakkety/2859
        deb: https://unity8-jenkins.ubuntu.com/job/build-2-binpkg/arch=armhf,release=yakkety/2859/artifact/output/*zip*/output.zip
    SUCCESS: https://unity8-jenkins.ubuntu.com/job/build-2-binpkg/arch=i386,release=vivid+overlay/2859
        deb: https://unity8-jenkins.ubuntu.com/job/build-2-binpkg/arch=i386,release=vivid+overlay/2859/artifact/output/*zip*/output.zip
    SUCCESS: https://unity8-jenkins.ubuntu.com/job/build-2-binpkg/arch=i386,release=xenial+overlay/2859
        deb: https://unity8-jenkins.ubuntu.com/job/build-2-binpkg/arch=i386,release=xenial+overlay/2859/artifact/output/*zip*/output.zip
    SUCCESS: https://unity8-jenkins.ubuntu.com/job/build-2-binpkg/arch=i386,release=yakkety/2859
        deb: https://unity8-jenkins.ubuntu.com/job/build-2-binpkg/arch=i386,release=yakkety/2859/artifact/output/*zip*/output.zip

Click here to trigger a rebuild:
https://unity8-jenkins.ubuntu.com/job/lp-qtubuntu-ci/124/rebuild

review: Approve (continuous-integration)

[Unity8 CI Bot (unity8-ci-bot)]

PASSED: Continuous integration, rev:337
https://unity8-jenkins.ubuntu.com/job/lp-qtubuntu-ci/125/
Executed test runs:
    SUCCESS: https://unity8-jenkins.ubuntu.com/job/build/2974
    SUCCESS: https://unity8-jenkins.ubuntu.com/job/build-0-fetch/3002
    SUCCESS: https://unity8-jenkins.ubuntu.com/job/build-2-binpkg/arch=amd64,release=vivid+overlay/2860
        deb: https://unity8-jenkins.ubuntu.com/job/build-2-binpkg/arch=amd64,release=vivid+overlay/2860/artifact/output/*zip*/output.zip
    SUCCESS: https://unity8-jenkins.ubuntu.com/job/build-2-binpkg/arch=amd64,release=xenial+overlay/2860
        deb: https://unity8-jenkins.ubuntu.com/job/build-2-binpkg/arch=amd64,release=xenial+overlay/2860/artifact/output/*zip*/output.zip
    SUCCESS: https://unity8-jenkins.ubuntu.com/job/build-2-binpkg/arch=amd64,release=yakkety/2860
        deb: https://unity8-jenkins.ubuntu.com/job/build-2-binpkg/arch=amd64,release=yakkety/2860/artifact/output/*zip*/output.zip
    SUCCESS: https://unity8-jenkins.ubuntu.com/job/build-2-binpkg/arch=armhf,release=vivid+overlay/2860
        deb: https://unity8-jenkins.ubuntu.com/job/build-2-binpkg/arch=armhf,release=vivid+overlay/2860/artifact/output/*zip*/output.zip
    SUCCESS: https://unity8-jenkins.ubuntu.com/job/build-2-binpkg/arch=armhf,release=xenial+overlay/2860
        deb: https://unity8-jenkins.ubuntu.com/job/build-2-binpkg/arch=armhf,release=xenial+overlay/2860/artifact/output/*zip*/output.zip
    SUCCESS: https://unity8-jenkins.ubuntu.com/job/build-2-binpkg/arch=armhf,release=yakkety/2860
        deb: https://unity8-jenkins.ubuntu.com/job/build-2-binpkg/arch=armhf,release=yakkety/2860/artifact/output/*zip*/output.zip
    SUCCESS: https://unity8-jenkins.ubuntu.com/job/build-2-binpkg/arch=i386,release=vivid+overlay/2860
        deb: https://unity8-jenkins.ubuntu.com/job/build-2-binpkg/arch=i386,release=vivid+overlay/2860/artifact/output/*zip*/output.zip
    SUCCESS: https://unity8-jenkins.ubuntu.com/job/build-2-binpkg/arch=i386,release=xenial+overlay/2860
        deb: https://unity8-jenkins.ubuntu.com/job/build-2-binpkg/arch=i386,release=xenial+overlay/2860/artifact/output/*zip*/output.zip
    SUCCESS: https://unity8-jenkins.ubuntu.com/job/build-2-binpkg/arch=i386,release=yakkety/2860
        deb: https://unity8-jenkins.ubuntu.com/job/build-2-binpkg/arch=i386,release=yakkety/2860/artifact/output/*zip*/output.zip

Click here to trigger a rebuild:
https://unity8-jenkins.ubuntu.com/job/lp-qtubuntu-ci/125/rebuild

review: Approve (continuous-integration)

[Daniel d'Andrada (dandrader)]

Shouldn't it supersede https://code.launchpad.net/~nick-dedekind/qtubuntu/lp1596524.use-pbuffers/+merge/303151 ?

review: Needs Information

[lp:~gerboland/qtubuntu/rasterGLSurface]

295. By Gerry Boland on 2016-10-04

Merge trunk

296. By Gerry Boland on 2016-10-04

Fix rendering of apps using QQuickWidget

Based on a branch by Daniel d'Andrada
- Advertise RasterGLSurface capability
- Don't create mir surfaces for Qt::Desktop QWindows. Proper implementation still pending
- Add BackingStore toImage method, fixes render of QQuick and Widget content

Unmerged revisions

=== modified file 'src/ubuntumirclient/backingstore.cpp'
--- src/ubuntumirclient/backingstore.cpp	2016-04-20 16:10:06 +0000
+++ src/ubuntumirclient/backingstore.cpp	2016-09-28 10:56:31 +0000
@@ -35,9 +35,7 @@
     window->setSurfaceType(QSurface::OpenGLSurface);
 }
 
-UbuntuBackingStore::~UbuntuBackingStore()
-{
-}
+UbuntuBackingStore::~UbuntuBackingStore() = default;
 
 void UbuntuBackingStore::flush(QWindow* window, const QRegion& region, const QPoint& offset)
 {
@@ -125,3 +123,9 @@
 {
     return &mImage;
 }
+
+QImage UbuntuBackingStore::toImage() const
+{
+    // used by QPlatformBackingStore::composeAndFlush
+    return mImage;
+}

=== modified file 'src/ubuntumirclient/backingstore.h'
--- src/ubuntumirclient/backingstore.h	2014-11-11 14:34:12 +0000
+++ src/ubuntumirclient/backingstore.h	2016-09-28 10:56:31 +0000
@@ -34,6 +34,7 @@
     void flush(QWindow* window, const QRegion& region, const QPoint& offset) override;
     void resize(const QSize& size, const QRegion& staticContents) override;
     QPaintDevice* paintDevice() override;
+    QImage toImage() const override;
 
 protected:
     void updateTexture();

=== added file 'src/ubuntumirclient/desktopwindow.cpp'
--- src/ubuntumirclient/desktopwindow.cpp	1970-01-01 00:00:00 +0000
+++ src/ubuntumirclient/desktopwindow.cpp	2016-09-28 10:56:31 +0000
@@ -0,0 +1,26 @@
+/*
+ * Copyright (C) 2016 Canonical, Ltd.
+ *
+ * This program is free software: you can redistribute it and/or modify it under
+ * the terms of the GNU Lesser General Public License version 3, as published by
+ * the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranties of MERCHANTABILITY,
+ * SATISFACTORY QUALITY, or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#include "desktopwindow.h"
+
+// local
+#include "logging.h"
+
+UbuntuDesktopWindow::UbuntuDesktopWindow(QWindow *window)
+    : QPlatformWindow(window)
+{
+    qCDebug(ubuntumirclient, "UbuntuDesktopWindow(window=%p)", window);
+}

=== added file 'src/ubuntumirclient/desktopwindow.h'
--- src/ubuntumirclient/desktopwindow.h	1970-01-01 00:00:00 +0000
+++ src/ubuntumirclient/desktopwindow.h	2016-09-28 10:56:31 +0000
@@ -0,0 +1,29 @@
+/*
+ * Copyright (C) 2016 Canonical, Ltd.
+ *
+ * This program is free software: you can redistribute it and/or modify it under
+ * the terms of the GNU Lesser General Public License version 3, as published by
+ * the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranties of MERCHANTABILITY,
+ * SATISFACTORY QUALITY, or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#ifndef UBUNTU_DESKTOP_WINDOW_H
+#define UBUNTU_DESKTOP_WINDOW_H
+
+#include <qpa/qplatformwindow.h>
+
+// TODO Implement it. For now it's just an empty, dummy class.
+class UbuntuDesktopWindow : public QPlatformWindow
+{
+public:
+    UbuntuDesktopWindow(QWindow*);
+};
+
+#endif // UBUNTU_DESKTOP_WINDOW_H

=== modified file 'src/ubuntumirclient/glcontext.cpp'
--- src/ubuntumirclient/glcontext.cpp	2016-08-09 23:00:32 +0000
+++ src/ubuntumirclient/glcontext.cpp	2016-09-28 10:56:31 +0000
@@ -16,11 +16,11 @@
 
 #include "glcontext.h"
 #include "logging.h"
-#include "offscreensurface.h"
 #include "window.h"
 
 #include <QOpenGLFramebufferObject>
 #include <QtPlatformSupport/private/qeglconvenience_p.h>
+#include <QtPlatformSupport/private/qeglpbuffer_p.h>
 #include <QtGui/private/qopenglcontext_p.h>
 
 Q_LOGGING_CATEGORY(ubuntumirclientGraphics, "ubuntumirclient.graphics", QtWarningMsg)
@@ -74,42 +74,35 @@
 
 bool UbuntuOpenGLContext::makeCurrent(QPlatformSurface* surface)
 {
-    Q_ASSERT(surface->surface()->surfaceType() == QSurface::OpenGLSurface);
-
-    if (surface->surface()->surfaceClass() == QSurface::Offscreen) {
-        auto offscreen = static_cast<UbuntuOffscreenSurface *>(surface);
-        if (!offscreen->buffer()) {
-            auto buffer = new QOpenGLFramebufferObject(surface->surface()->size());
-            offscreen->setBuffer(buffer);
-        }
-        return offscreen->buffer()->bind();
-    } else {
-        const bool ret = QEGLPlatformContext::makeCurrent(surface);
-
-        if (Q_LIKELY(ret)) {
-            QOpenGLContextPrivate *ctx_d = QOpenGLContextPrivate::get(context());
-            if (!ctx_d->workaround_brokenFBOReadBack && needsFBOReadBackWorkaround()) {
-                ctx_d->workaround_brokenFBOReadBack = true;
-            }
-        }
-
-        return ret;
+    const bool ret = QEGLPlatformContext::makeCurrent(surface);
+
+    if (Q_LIKELY(ret)) {
+        QOpenGLContextPrivate *ctx_d = QOpenGLContextPrivate::get(context());
+        if (!ctx_d->workaround_brokenFBOReadBack && needsFBOReadBackWorkaround()) {
+            ctx_d->workaround_brokenFBOReadBack = true;
+        }
     }
+    return ret;
 }
 
 // Following method used internally in the base class QEGLPlatformContext to access
 // the egl surface of a QPlatformSurface/UbuntuWindow
 EGLSurface UbuntuOpenGLContext::eglSurfaceForPlatformSurface(QPlatformSurface *surface)
 {
-    auto ubuntuWindow = static_cast<UbuntuWindow *>(surface);
-    return ubuntuWindow->eglSurface();
+    if (surface->surface()->surfaceClass() == QSurface::Window) {
+        return static_cast<UbuntuWindow *>(surface)->eglSurface();
+    } else {
+        return static_cast<QEGLPbuffer *>(surface)->pbuffer();
+    }
 }
 
 void UbuntuOpenGLContext::swapBuffers(QPlatformSurface *surface)
 {
     QEGLPlatformContext::swapBuffers(surface);
 
-    // notify window on swap completion
-    auto ubuntuWindow = static_cast<UbuntuWindow *>(surface);
-    ubuntuWindow->onSwapBuffersDone();
+    if (surface->surface()->surfaceClass() == QSurface::Window) {
+        // notify window on swap completion
+        auto ubuntuWindow = static_cast<UbuntuWindow *>(surface);
+        ubuntuWindow->onSwapBuffersDone();
+    }
 }

=== modified file 'src/ubuntumirclient/integration.cpp'
--- src/ubuntumirclient/integration.cpp	2016-08-24 12:40:30 +0000
+++ src/ubuntumirclient/integration.cpp	2016-09-28 10:56:31 +0000
@@ -18,11 +18,11 @@
 #include "integration.h"
 #include "backingstore.h"
 #include "clipboard.h"
+#include "desktopwindow.h"
 #include "glcontext.h"
 #include "input.h"
 #include "logging.h"
 #include "nativeinterface.h"
-#include "offscreensurface.h"
 #include "screen.h"
 #include "theme.h"
 #include "window.h"
@@ -30,13 +30,16 @@
 // Qt
 #include <QFileInfo>
 #include <QGuiApplication>
+#include <private/qeglpbuffer_p.h>
 #include <qpa/qplatformnativeinterface.h>
 #include <qpa/qplatforminputcontextfactory_p.h>
 #include <qpa/qplatforminputcontext.h>
 #include <QtPlatformSupport/private/qeglconvenience_p.h>
 #include <QtPlatformSupport/private/qgenericunixfontdatabase_p.h>
 #include <QtPlatformSupport/private/qgenericunixeventdispatcher_p.h>
+#include <QtPlatformSupport/private/qeglpbuffer_p.h>
 #include <QOpenGLContext>
+#include <QOffscreenSurface>
 
 // platform-api
 #include <ubuntu/application/lifecycle_delegate.h>
@@ -210,21 +213,17 @@
 
 QPlatformWindow* UbuntuClientIntegration::createPlatformWindow(QWindow* window) const
 {
-    return new UbuntuWindow(window, mInput, mNativeInterface, mEglDisplay, mMirConnection);
+    if (window->type() == Qt::Desktop) {
+        // Desktop windows should not be backed up by a mir surface as they don't draw anything (nor should).
+        return new UbuntuDesktopWindow(window);
+    } else {
+        return new UbuntuWindow(window, mInput, mNativeInterface, mEglDisplay, mMirConnection);
+    }
 }
 
 bool UbuntuClientIntegration::hasCapability(QPlatformIntegration::Capability cap) const
 {
     switch (cap) {
-    case ThreadedPixmaps:
-        return true;
-
-    case OpenGL:
-        return true;
-
-    case ApplicationState:
-        return true;
-
     case ThreadedOpenGL:
         if (qEnvironmentVariableIsEmpty("QTUBUNTU_NO_THREADED_OPENGL")) {
             return true;
@@ -232,8 +231,16 @@
             qCDebug(ubuntumirclient, "disabled threaded OpenGL");
             return false;
         }
+
+    case ThreadedPixmaps:
+    case OpenGL:
+    case ApplicationState:
     case MultipleWindows:
     case NonFullScreenWindows:
+#if QT_VERSION > QT_VERSION_CHECK(5, 5, 0)
+    case SwitchableWidgetComposition:
+#endif
+    case RasterGLSurface: // needed for QQuickWidget
         return true;
     default:
         return QPlatformIntegration::hasCapability(cap);
@@ -319,7 +326,7 @@
 QPlatformOffscreenSurface *UbuntuClientIntegration::createPlatformOffscreenSurface(
         QOffscreenSurface *surface) const
 {
-    return new UbuntuOffscreenSurface(surface);
+    return new QEGLPbuffer(mEglDisplay, surface->requestedFormat(), surface);
 }
 
 void UbuntuClientIntegration::destroyScreen(UbuntuScreen *screen)

=== removed file 'src/ubuntumirclient/offscreensurface.cpp'
--- src/ubuntumirclient/offscreensurface.cpp	2016-01-04 17:18:51 +0000
+++ src/ubuntumirclient/offscreensurface.cpp	1970-01-01 00:00:00 +0000
@@ -1,47 +0,0 @@
-/*
- * Copyright (C) 2016 Canonical, Ltd.
- *
- * This program is free software: you can redistribute it and/or modify it under
- * the terms of the GNU Lesser General Public License version 3, as published by
- * the Free Software Foundation.
- *
- * This program is distributed in the hope that it will be useful, but WITHOUT
- * ANY WARRANTY; without even the implied warranties of MERCHANTABILITY,
- * SATISFACTORY QUALITY, or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
- * Lesser General Public License for more details.
- *
- * You should have received a copy of the GNU Lesser General Public License
- * along with this program.  If not, see <http://www.gnu.org/licenses/>.
- */
-
-#include "offscreensurface.h"
-
-#include <QOffscreenSurface>
-#include <QOpenGLFramebufferObject>
-
-UbuntuOffscreenSurface::UbuntuOffscreenSurface(QOffscreenSurface *offscreenSurface)
-    : QPlatformOffscreenSurface(offscreenSurface)
-    , m_buffer(nullptr)
-    , m_format(offscreenSurface->requestedFormat())
-{
-}
-
-QSurfaceFormat UbuntuOffscreenSurface::format() const
-{
-    return m_format;
-}
-
-bool UbuntuOffscreenSurface::isValid() const
-{
-    return m_buffer != nullptr && m_buffer->isValid();
-}
-
-QOpenGLFramebufferObject* UbuntuOffscreenSurface::buffer() const
-{
-    return m_buffer;
-}
-
-void UbuntuOffscreenSurface::setBuffer(QOpenGLFramebufferObject *buffer)
-{
-    m_buffer = buffer;
-}

=== removed file 'src/ubuntumirclient/offscreensurface.h'
--- src/ubuntumirclient/offscreensurface.h	2016-01-04 17:18:51 +0000
+++ src/ubuntumirclient/offscreensurface.h	1970-01-01 00:00:00 +0000
@@ -1,41 +0,0 @@
-/*
- * Copyright (C) 2016 Canonical, Ltd.
- *
- * This program is free software: you can redistribute it and/or modify it under
- * the terms of the GNU Lesser General Public License version 3, as published by
- * the Free Software Foundation.
- *
- * This program is distributed in the hope that it will be useful, but WITHOUT
- * ANY WARRANTY; without even the implied warranties of MERCHANTABILITY,
- * SATISFACTORY QUALITY, or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
- * Lesser General Public License for more details.
- *
- * You should have received a copy of the GNU Lesser General Public License
- * along with this program.  If not, see <http://www.gnu.org/licenses/>.
- */
-
-#ifndef UBUNTU_OFFSCREEN_SURFACE_H
-#define UBUNTU_OFFSCREEN_SURFACE_H
-
-#include <qpa/qplatformoffscreensurface.h>
-#include <QSurfaceFormat>
-
-class QOpenGLFramebufferObject;
-
-class UbuntuOffscreenSurface : public QPlatformOffscreenSurface
-{
-public:
-    UbuntuOffscreenSurface(QOffscreenSurface *offscreenSurface);
-
-    QSurfaceFormat format() const override;
-    bool isValid() const override;
-
-    QOpenGLFramebufferObject* buffer() const;
-    void setBuffer(QOpenGLFramebufferObject *buffer);
-
-private:
-    QOpenGLFramebufferObject *m_buffer;
-    QSurfaceFormat m_format;
-};
-
-#endif // UBUNTU_OFFSCREEN_SURFACE_H

=== modified file 'src/ubuntumirclient/ubuntumirclient.pro'
--- src/ubuntumirclient/ubuntumirclient.pro	2016-08-24 12:40:30 +0000
+++ src/ubuntumirclient/ubuntumirclient.pro	2016-09-28 10:56:31 +0000
@@ -18,11 +18,11 @@
     backingstore.cpp \
     clipboard.cpp \
     cursor.cpp \
+    desktopwindow.cpp \
     glcontext.cpp \
     input.cpp \
     integration.cpp \
     nativeinterface.cpp \
-    offscreensurface.cpp \
     platformservices.cpp \
     plugin.cpp \
     screen.cpp \
@@ -34,12 +34,12 @@
     backingstore.h \
     clipboard.h \
     cursor.h \
+    desktopwindow.h \
     glcontext.h \
     input.h \
     integration.h \
     logging.h \
     nativeinterface.h \
-    offscreensurface.h \
     orientationchangeevent_p.h \
     platformservices.h \
     plugin.h \