Add support capturing QtQuick windows backed by Qt Rhi

This is an interesting QtQuick backend to support because of some of the
inherent design limitations we have to work around. But we are now able
to capture and draw target decorations for these windows backed by Rhi
now.

The first problem we have to tackle is actually capturing the window
contents, but fortunately Qt already has public API to do this. They
don't provide a mapping from their bespoke Rhi texture format to QImage
unfortunately, but I added a user-visible error message so it's easier
for people to submit bugreports for any missing cases.

I tried to optimize the readback as best I could, and the performance is
about on-par to the OpenGL screen grabber. (I didn't actually benchmark,
but it looks good enough to my own eyes.)

Another tricky problem to tackle is drawing the remote target
decorations, because we previously assumed we always had a QPainter to
draw in. (For context, the client's viewport is drawn in QPainter and in
the OpenGL there's QOpenGLPaintDevice available.) Not only that, but we
can't exactly tell *when* to let Qt readback the swapchain image. The
pre-existing screengrabbers grabbed the backbuffer before we drew target
decorations so we could draw them client-side.

For the drawing part I don't think there's anything we could do save for
rewriting it in QtRHI, so we upload it into a texture and draw it onto
the backbuffer. Yes it is "slow" but it's more than good enough than it
not working at all.

For the target decoration part that's not going to be easily possible,
so I decided to not do it! Instead, we let ourselves capture the full
window contents *including* the decorations we drew. We then skip
drawing decorations client-side, and it's practically the same
experience save for anything drawn outside the window. That limitation
is going to be planned to be addressed in a future patch.

Author: redstrate

CMakeLists.txt

@@ -506,6 +506,8 @@ if(Qt6Gui_VERSION VERSION_GREATER_EQUAL "6.10.0")
     find_package(Qt6WidgetsPrivate REQUIRED NO_MODULE)
     find_package(Qt6QmlPrivate NO_MODULE)
     find_package(Qt6QuickPrivate NO_MODULE)
+    find_package(Qt6QuickWidgetsPrivate NO_MODULE)
+    find_package(Qt6GuiPrivate NO_MODULE)
 endif()
 
 # these need to included after the last Qt-related find_package() call

common/remoteviewframe.cpp

@@ -68,9 +68,19 @@ void RemoteViewFrame::setImage(const QImage &image, const QTransform &transform)
     m_image.setTransform(transform);
 }
 
+void RemoteViewFrame::setGraphicsApi(const int value)
+{
+    m_graphicsApi = value;
+}
+
+int RemoteViewFrame::graphicsApi() const
+{
+    return m_graphicsApi;
+}
+
 QDataStream &operator<<(QDataStream &stream, const RemoteViewFrame &frame)
 {
-    stream << frame.m_image << frame.data << frame.m_viewRect << frame.m_sceneRect;
+    stream << frame.m_image << frame.data << frame.m_viewRect << frame.m_sceneRect << frame.m_graphicsApi;
     return stream;
 }
 
@@ -80,6 +90,7 @@ QDataStream &operator>>(QDataStream &stream, RemoteViewFrame &frame)
     stream >> frame.data;
     stream >> frame.m_viewRect;
     stream >> frame.m_sceneRect;
+    stream >> frame.m_graphicsApi;
     return stream;
 }
 }

common/remoteviewframe.h

@@ -46,6 +46,9 @@ class GAMMARAY_COMMON_EXPORT RemoteViewFrame
     void setImage(const QImage &image);
     void setImage(const QImage &image, const QTransform &transform);
 
+    void setGraphicsApi(int value);
+    int graphicsApi() const;
+
     /// tool specific frame data
     QVariant data;
 
@@ -55,6 +58,7 @@ class GAMMARAY_COMMON_EXPORT RemoteViewFrame
     TransferImage m_image;
     QRectF m_viewRect;
     QRectF m_sceneRect;
+    int m_graphicsApi; // Only relevant and used in QtQuick preview.
 };
 }
 

plugins/quickinspector/CMakeLists.txt

@@ -79,12 +79,30 @@ if(NOT GAMMARAY_CLIENT_ONLY_BUILD)
         )
     endif()
 
+    # Only needed for the RHI screen grabber for >=6.6
+    if(QT_VERSION_MAJOR EQUAL 6 AND Qt${QT_VERSION_MAJOR}Core_VERSION_MINOR GREATER_EQUAL 6)
+        find_package(Qt${QT_VERSION_MAJOR}ShaderTools REQUIRED)
+        qt_add_shaders(
+            gammaray_quickinspector
+            "gammaray_quickinspector_shaders"
+            PRECOMPILE
+            PREFIX
+            "/gammaray_quickinspector_shaders/"
+            FILES
+            "shaders/rhi_inspector_decorations.vert"
+            "shaders/rhi_inspector_decorations.frag"
+        )
+    endif()
+
     target_link_libraries(
         gammaray_quickinspector
         gammaray_quickinspector_shared
         gammaray_core
         Qt::Quick
         Qt::QuickPrivate
+        Qt::QuickWidgets
+        Qt::QuickWidgetsPrivate
+        Qt::GuiPrivate
         gammaray_kitemmodels
     )
 

plugins/quickinspector/quickinspector.cpp

@@ -292,7 +292,7 @@ void RenderModeRequest::apply()
     if (connection)
         disconnect(connection);
 
-    if (window && window->rendererInterface()->graphicsApi() != QSGRendererInterface::OpenGL)
+    if (window && window->rendererInterface()->graphicsApi() == QSGRendererInterface::Software)
         return;
 
     if (window) {
@@ -574,6 +574,7 @@ void QuickInspector::sendRenderedScene(const GammaRay::GrabbedFrame &grabbedFram
         frame.data = QVariant::fromValue(grabbedFrame.itemsGeometry);
     else if (!grabbedFrame.itemsGeometry.isEmpty())
         frame.data = QVariant::fromValue(grabbedFrame.itemsGeometry.at(0));
+    frame.setGraphicsApi(m_window->rendererInterface()->graphicsApi());
     m_remoteView->sendFrame(frame);
 }
 
@@ -612,10 +613,10 @@ void QuickInspector::checkFeatures()
         return;
     }
 
-    if (m_window->rendererInterface()->graphicsApi() == QSGRendererInterface::OpenGL)
-        f = AllCustomRenderModes;
-    else if (m_window->rendererInterface()->graphicsApi() == QSGRendererInterface::Software)
+    if (m_window->rendererInterface()->graphicsApi() == QSGRendererInterface::Software)
         f = AnalyzePainting;
+    else
+        f = AllCustomRenderModes;
 
     emit features(f);
 }

plugins/quickinspector/quickscenepreviewwidget.cpp

@@ -20,6 +20,10 @@
 #include <QMouseEvent>
 #include <QPainter>
 
+#if QT_VERSION >= QT_VERSION_CHECK(6, 6, 0)
+#include <qsgrendererinterface.h>
+#endif
+
 using namespace GammaRay;
 static const qint32 QuickScenePreviewWidgetStateVersion = 4;
 
@@ -152,6 +156,14 @@ void QuickScenePreviewWidget::resizeEvent(QResizeEvent *e)
 
 void QuickScenePreviewWidget::renderDecoration(QPainter *p, double zoom) const
 {
+#if QT_VERSION >= QT_VERSION_CHECK(6, 6, 0)
+    // We want to skip rendering decorations in the client, if we draw it on RHI targets and this rendering backend cannot discern between the two.
+    const auto graphicsApi = static_cast<QSGRendererInterface::GraphicsApi>(frame().graphicsApi());
+    if (QSGRendererInterface::isApiRhiBased(graphicsApi) && m_control->serverSideDecorationsEnabled()) {
+        return;
+    }
+#endif
+
     // Scaling and translations on QuickItemGeometry will be done on demand
 
     if (frame().data.userType() == qMetaTypeId<QuickItemGeometry>()) {