diff options
Diffstat (limited to 'src/quick/items/qquickrendercontrol.cpp')
| -rw-r--r-- | src/quick/items/qquickrendercontrol.cpp | 624 |
1 files changed, 483 insertions, 141 deletions
diff --git a/src/quick/items/qquickrendercontrol.cpp b/src/quick/items/qquickrendercontrol.cpp index f6d4e7ed49..3a92507141 100644 --- a/src/quick/items/qquickrendercontrol.cpp +++ b/src/quick/items/qquickrendercontrol.cpp @@ -1,41 +1,5 @@ -/**************************************************************************** -** -** Copyright (C) 2016 The Qt Company Ltd. -** Contact: https://www.qt.io/licensing/ -** -** This file is part of the QtQuick module of the Qt Toolkit. -** -** $QT_BEGIN_LICENSE:LGPL$ -** Commercial License Usage -** Licensees holding valid commercial Qt licenses may use this file in -** accordance with the commercial license agreement provided with the -** Software or, alternatively, in accordance with the terms contained in -** a written agreement between you and The Qt Company. For licensing terms -** and conditions see https://www.qt.io/terms-conditions. For further -** information use the contact form at https://www.qt.io/contact-us. -** -** GNU Lesser General Public License Usage -** Alternatively, this file may be used under the terms of the GNU Lesser -** General Public License version 3 as published by the Free Software -** Foundation and appearing in the file LICENSE.LGPL3 included in the -** packaging of this file. Please review the following information to -** ensure the GNU Lesser General Public License version 3 requirements -** will be met: https://www.gnu.org/licenses/lgpl-3.0.html. -** -** GNU General Public License Usage -** Alternatively, this file may be used under the terms of the GNU -** General Public License version 2.0 or (at your option) the GNU General -** Public license version 3 or any later version approved by the KDE Free -** Qt Foundation. The licenses are as published by the Free Software -** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3 -** included in the packaging of this file. Please review the following -** information to ensure the GNU General Public License requirements will -** be met: https://www.gnu.org/licenses/gpl-2.0.html and -** https://www.gnu.org/licenses/gpl-3.0.html. -** -** $QT_END_LICENSE$ -** -****************************************************************************/ +// Copyright (C) 2016 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only #include "qquickrendercontrol.h" #include "qquickrendercontrol_p.h" @@ -43,28 +7,29 @@ #include <QtCore/QCoreApplication> #include <QtCore/QTime> #include <QtQuick/private/qquickanimatorcontroller_p.h> +#include <QtQuick/private/qsgdefaultrendercontext_p.h> +#include <QtQuick/private/qsgrhisupport_p.h> + +#include <private/qsgrhishadereffectnode_p.h> -#if QT_CONFIG(opengl) -# include <QtGui/QOpenGLContext> -# include <QtQuick/private/qsgdefaultrendercontext_p.h> -#if QT_CONFIG(quick_shadereffect) -# include <QtQuick/private/qquickopenglshadereffectnode_p.h> -#endif -#endif #include <QtGui/private/qguiapplication_p.h> #include <qpa/qplatformintegration.h> +#include <QtGui/qoffscreensurface.h> #include <QtQml/private/qqmlglobal_p.h> #include <QtQuick/QQuickWindow> +#include <QtQuick/QQuickRenderTarget> #include <QtQuick/private/qquickwindow_p.h> +#include <QtQuick/private/qquickitem_p.h> #include <QtQuick/private/qsgsoftwarerenderer_p.h> #include <QtCore/private/qobject_p.h> +#include <QtQuick/private/qquickwindow_p.h> +#include <rhi/qrhi.h> + QT_BEGIN_NAMESPACE -#if QT_CONFIG(opengl) -extern Q_GUI_EXPORT QImage qt_gl_read_framebuffer(const QSize &size, bool alpha_format, bool include_alpha); -#endif + /*! \class QQuickRenderControl @@ -76,27 +41,34 @@ extern Q_GUI_EXPORT QImage qt_gl_read_framebuffer(const QSize &size, bool alpha_ QQuickWindow and QQuickView and their associated internal render loops render the Qt Quick scene onto a native window. In some cases, for example when - integrating with 3rd party OpenGL renderers, it might be beneficial to get the - scene into a texture that can then be used in arbitrary ways by the external - rendering engine. QQuickRenderControl makes this possible in a hardware - accelerated manner, unlike the performance-wise limited alternative of using - QQuickWindow::grabWindow() - - When using a QQuickRenderControl, the QQuickWindow does not have to be shown - or even created at all. This means there will not be an underlying native - window for it. Instead, the QQuickWindow instance is associated with the - render control, using the overload of the QQuickWindow constructor, and an - OpenGL framebuffer object by calling QQuickWindow::setRenderTarget(). - - Management of the context and framebuffer object is up to the application. The - context that will be used by Qt Quick must be created before calling - initialize(). The creation of the framebuffer object can be deferred, see - below. Qt 5.4 introduces the ability for QOpenGLContext to adopt existing - native contexts. Together with QQuickRenderControl this makes it possible to - create a QOpenGLContext that shares with an external rendering engine's - existing context. This new QOpenGLContext can then be used to render the Qt - Quick scene into a texture that is accessible by the other engine's context - too. + integrating with 3rd party OpenGL, Vulkan, Metal, or Direct 3D renderers, it + can be useful to get the scene into a texture that can then be used in + arbitrary ways by the external rendering engine. Such a mechanism is also + essential when integrating with a VR framework. QQuickRenderControl makes this + possible in a hardware accelerated manner, unlike the performance-wise limited + alternative of using QQuickWindow::grabWindow() + + When using a QQuickRenderControl, the QQuickWindow must not be + \l{QWindow::show()}{shown} (it will not be visible on-screen) and there will + not be an underlying native window for it. Instead, the QQuickWindow instance + is associated with the render control object, using the overload of the + QQuickWindow constructor, and a texture or image object specified via + QQuickWindow::setRenderTarget(). The QQuickWindow object is still essential, + because it represents the Qt Quick scene and provides the bulk of the scene + management and event delivery mechanisms. It does not however act as a real + on-screen window from the windowing system's perspective. + + Management of the graphics devices, contexts, image and texture objects is up + to the application. The device or context that will be used by Qt Quick must + be created before calling initialize(). The creation of the texture object + can be deferred, see below. Qt 5.4 introduces the ability for QOpenGLContext + to adopt existing native contexts. Together with QQuickRenderControl this + makes it possible to create a QOpenGLContext that shares with an external + rendering engine's existing context. This new QOpenGLContext can then be used + to render the Qt Quick scene into a texture that is accessible by the other + engine's context too. For Vulkan, Metal, and Direct 3D there are no + Qt-provided wrappers for device objects, so existing ones can be passed as-is + via QQuickWindow::setGraphicsDevice(). Loading and instantiation of the QML components happen by using a QQmlEngine. Once the root object is created, it will need to be parented to @@ -126,6 +98,12 @@ extern Q_GUI_EXPORT QImage qt_gl_read_framebuffer(const QSize &size, bool alpha_ To send events, for example mouse or keyboard events, to the scene, use QCoreApplication::sendEvent() with the QQuickWindow instance as the receiver. + For key events it may be also necessary to set the focus manually on the + desired item. In practice this involves calling + \l{QQuickItem::forceActiveFocus()}{forceActiveFocus()} on the desired item, + for example the scene's root item, once it is associated with the scene (the + QQuickWindow). + \note In general QQuickRenderControl is supported in combination with all Qt Quick backends. However, some functionality, in particular grab(), may not be available in all cases. @@ -135,9 +113,16 @@ extern Q_GUI_EXPORT QImage qt_gl_read_framebuffer(const QSize &size, bool alpha_ QSGContext *QQuickRenderControlPrivate::sg = nullptr; -QQuickRenderControlPrivate::QQuickRenderControlPrivate() - : initialized(0), - window(nullptr) +QQuickRenderControlPrivate::QQuickRenderControlPrivate(QQuickRenderControl *renderControl) + : q(renderControl), + initialized(false), + window(nullptr), + rhi(nullptr), + ownRhi(true), + cb(nullptr), + offscreenSurface(nullptr), + sampleCount(1), + frameStatus(NotRecordingFrame) { if (!sg) { qAddPostRoutine(cleanup); @@ -157,7 +142,15 @@ void QQuickRenderControlPrivate::cleanup() object \a parent. */ QQuickRenderControl::QQuickRenderControl(QObject *parent) - : QObject(*(new QQuickRenderControlPrivate), parent) + : QObject(*(new QQuickRenderControlPrivate(this)), parent) +{ +} + +/*! + \internal +*/ +QQuickRenderControl::QQuickRenderControl(QQuickRenderControlPrivate &dd, QObject * parent) + : QObject(dd, parent) { } @@ -172,8 +165,12 @@ QQuickRenderControl::~QQuickRenderControl() invalidate(); - if (d->window) - QQuickWindowPrivate::get(d->window)->renderControl = nullptr; + QQuickGraphicsConfiguration config; + if (d->window) { + QQuickWindowPrivate *wd = QQuickWindowPrivate::get(d->window); + wd->renderControl = nullptr; + config = wd->graphicsConfig; + } // It is likely that the cleanup in windowDestroyed() is not called since // the standard pattern is to destroy the rendercontrol before the QQuickWindow. @@ -181,19 +178,27 @@ QQuickRenderControl::~QQuickRenderControl() d->windowDestroyed(); delete d->rc; + + // Only call rhi related cleanup when we actually got to initialize() and + // managed to get a QRhi. The software backend for instance would mean + // using the rendercontrol without ever calling initialize() - it is then + // important to completely skip calling any QSGRhiSupport functions. + if (d->rhi) + d->resetRhi(config); } void QQuickRenderControlPrivate::windowDestroyed() { if (window) { + QQuickWindowPrivate *cd = QQuickWindowPrivate::get(window); + cd->cleanupNodesOnShutdown(); + rc->invalidate(); - delete QQuickWindowPrivate::get(window)->animationController; - QQuickWindowPrivate::get(window)->animationController = nullptr; + QQuickWindowPrivate::get(window)->animationController.reset(); -#if QT_CONFIG(quick_shadereffect) && QT_CONFIG(opengl) - if (QOpenGLContext::currentContext()) - QQuickOpenGLShaderEffectMaterial::cleanupMaterialCache(); +#if QT_CONFIG(quick_shadereffect) + QSGRhiShaderEffectNode::resetMaterialTypeCache(window); #endif window = nullptr; @@ -201,7 +206,7 @@ void QQuickRenderControlPrivate::windowDestroyed() } /*! - Prepares rendering the Qt Quick scene outside the gui thread. + Prepares rendering the Qt Quick scene outside the GUI thread. \a targetThread specifies the thread on which synchronization and rendering will happen. There is no need to call this function in a @@ -215,38 +220,110 @@ void QQuickRenderControl::prepareThread(QThread *targetThread) } /*! - Initializes the scene graph resources. The context \a gl has to be the - current OpenGL context or null if it is not relevant because a Qt Quick - backend other than OpenGL is in use. + Sets the number of samples to use for multisampling. When \a sampleCount is + 0 or 1, multisampling is disabled. + + \note This function is always used in combination with a multisample render + target, which means \a sampleCount must match the sample count passed to + QQuickRenderTarget::fromNativeTexture(), which in turn must match the + sample count of the native texture. + + \since 6.0 + + \sa initialize(), QQuickRenderTarget + */ +void QQuickRenderControl::setSamples(int sampleCount) +{ + Q_D(QQuickRenderControl); + d->sampleCount = qMax(1, sampleCount); +} + +/*! + \return the current sample count. 1 or 0 means no multisampling. - \note Qt Quick does not take ownership of the context. It is up to the - application to destroy it after a call to invalidate() or after the - QQuickRenderControl instance is destroyed. + \since 6.0 */ -void QQuickRenderControl::initialize(QOpenGLContext *gl) +int QQuickRenderControl::samples() const { + Q_D(const QQuickRenderControl); + return d->sampleCount; +} +/*! + Initializes the scene graph resources. When using a graphics API, such as + Vulkan, Metal, OpenGL, or Direct3D, for Qt Quick rendering, + QQuickRenderControl will set up an appropriate rendering engine when this + function is called. This rendering infrastructure exists as long as the + QQuickRenderControl exists. + + To control what graphics API Qt Quick uses, call + QQuickWindow::setGraphicsApi() with one of the + QSGRendererInterface:GraphicsApi constants. That must be done before + calling this function. + + To prevent the scenegraph from creating its own device and context objects, + specify an appropriate QQuickGraphicsDevice, wrapping existing graphics + objects, by calling QQuickWindow::setGraphicsDevice(). + + To configure which device extensions to enable (for example, for Vulkan), + call QQuickWindow::setGraphicsConfiguration() before this function. + + \note When using Vulkan, QQuickRenderControl does not create a QVulkanInstance + automatically. Rather, it is the application's responsibility to create a + suitable QVulkanInstance and \l{QWindow::setVulkanInstance()}{associate it} with + the QQuickWindow. Before initializing the QVulkanInstance, it is strongly + encouraged to query the list of Qt Quick's desired instance extensions by calling + the static function QQuickGraphicsConfiguration::preferredInstanceExtensions() + and to pass the returned list to QVulkanInstance::setExtensions(). + + Returns \c true on success, \c false otherwise. + + \note This function does not need to be, and must not be, called when using + the \c software adaptation of Qt Quick. + + With the default Qt Quick adaptation this function creates a new \l QRhi + object, similarly to what would happen with an on-screen QQuickWindow when + QQuickRenderControl was not used. To make this new QRhi object adopt some + existing device or context resource (e.g. use an existing QOpenGLContext + instead of creating a new one), use QQuickWindow::setGraphicsDevice() as + mentioned above. When the application wants to make the Qt Quick rendering + use an already existing \l QRhi object, that is possible as well via + \l QQuickGraphicsDevice::fromRhi(). When such a QQuickGraphicsDevice, + referencing an already existing QRhi, is set, there will be no new, + dedicated \l QRhi object created in initialize(). + + \since 6.0 + + \sa QQuickRenderTarget, QQuickGraphicsDevice, QQuickGraphicsConfiguration::preferredInstanceExtensions() + */ +bool QQuickRenderControl::initialize() +{ Q_D(QQuickRenderControl); -#if QT_CONFIG(opengl) if (!d->window) { qWarning("QQuickRenderControl::initialize called with no associated window"); - return; + return false; } - if (QOpenGLContext::currentContext() != gl) { - qWarning("QQuickRenderControl::initialize called with incorrect current context"); - return; - } + if (!d->initRhi()) + return false; - // It is the caller's responsiblity to make a context/surface current. - // It cannot be done here since the surface to use may not be the - // surface belonging to window. In fact window may not have a native - // window/surface at all. - d->rc->initialize(gl); -#else - Q_UNUSED(gl) -#endif - d->initialized = true; + QQuickWindowPrivate *wd = QQuickWindowPrivate::get(d->window); + wd->rhi = d->rhi; + + QSGDefaultRenderContext *renderContext = qobject_cast<QSGDefaultRenderContext *>(d->rc); + if (renderContext) { + QSGDefaultRenderContext::InitParams params; + params.rhi = d->rhi; + params.sampleCount = d->sampleCount; + params.initialSurfacePixelSize = d->window->size() * d->window->effectiveDevicePixelRatio(); + params.maybeSurface = d->window; + renderContext->initialize(¶ms); + d->initialized = true; + } else { + qWarning("QRhi is only compatible with default adaptation"); + return false; + } + return true; } /*! @@ -261,10 +338,11 @@ void QQuickRenderControl::polishItems() return; QQuickWindowPrivate *cd = QQuickWindowPrivate::get(d->window); - cd->flushFrameSynchronousEvents(); + cd->deliveryAgentPrivate()->flushFrameSynchronousEvents(d->window); if (!d->window) return; cd->polishItems(); + emit d->window->afterAnimating(); } /*! @@ -283,31 +361,41 @@ bool QQuickRenderControl::sync() return false; QQuickWindowPrivate *cd = QQuickWindowPrivate::get(d->window); + // we may not have a d->rhi (software backend) hence the check is important + if (d->rhi) { + if (!d->rhi->isRecordingFrame()) { + qWarning("QQuickRenderControl can only sync when beginFrame() has been called"); + return false; + } + if (!d->cb) { + qWarning("QQuickRenderControl cannot be used with QRhi when no QRhiCommandBuffer is provided " + "(perhaps beginFrame() was not called or it was unsuccessful?)"); + return false; + } + cd->setCustomCommandBuffer(d->cb); + } + cd->syncSceneGraph(); d->rc->endSync(); - // TODO: find out if the sync actually caused a scenegraph update. return true; } /*! - Stop rendering and release resources. Requires a current context. + Stop rendering and release resources. This is the equivalent of the cleanup operations that happen with a real QQuickWindow when the window becomes hidden. This function is called from the destructor. Therefore there will - typically be no need to call it directly. Pay attention however to - the fact that this requires the context, that was passed to - initialize(), to be the current one at the time of destroying the - QQuickRenderControl instance. + typically be no need to call it directly. Once invalidate() has been called, it is possible to reuse the QQuickRenderControl instance by calling initialize() again. \note This function does not take QQuickWindow::persistentSceneGraph() or - QQuickWindow::persistentOpenGLContext() into account. This means + QQuickWindow::persistentGraphics() into account. This means that context-specific resources are always released. */ void QQuickRenderControl::invalidate() @@ -328,6 +416,7 @@ void QQuickRenderControl::invalidate() // also essential to allow a subsequent initialize() to succeed. d->rc->invalidate(); + d->frameStatus = QQuickRenderControlPrivate::NotRecordingFrame; d->initialized = false; } @@ -341,7 +430,20 @@ void QQuickRenderControl::render() return; QQuickWindowPrivate *cd = QQuickWindowPrivate::get(d->window); - cd->renderSceneGraph(d->window->size()); + // we may not have a d->rhi (software backend) hence the check is important + if (d->rhi) { + if (!d->rhi->isRecordingFrame()) { + qWarning("QQuickRenderControl can only render when beginFrame() has been called"); + return; + } + if (!d->cb) { + qWarning("QQuickRenderControl cannot be used with QRhi when no QRhiCommandBuffer is provided"); + return; + } + cd->setCustomCommandBuffer(d->cb); + } + + cd->renderSceneGraph(); } /*! @@ -366,48 +468,37 @@ void QQuickRenderControl::render() for example. This will lead to better performance. */ -/*! - Grabs the contents of the scene and returns it as an image. - - \note Requires the context to be current. - */ -QImage QQuickRenderControl::grab() +QImage QQuickRenderControlPrivate::grab() { - Q_D(QQuickRenderControl); - if (!d->window) + if (!window) return QImage(); QImage grabContent; - if (d->window->rendererInterface()->graphicsApi() == QSGRendererInterface::OpenGL) { -#if QT_CONFIG(opengl) - QQuickWindowPrivate *cd = QQuickWindowPrivate::get(d->window); - cd->polishItems(); - cd->syncSceneGraph(); - d->rc->endSync(); - render(); - const bool alpha = d->window->format().alphaBufferSize() > 0 && d->window->color().alpha() < 255; - grabContent = qt_gl_read_framebuffer(d->window->size() * d->window->effectiveDevicePixelRatio(), alpha, alpha); - if (QQuickRenderControl::renderWindowFor(d->window)) { - grabContent.setDevicePixelRatio(d->window->effectiveDevicePixelRatio()); - } -#endif + if (rhi) { + + // As documented by QQuickWindow::grabWindow(): Nothing to do here, we + // do not support "grabbing" with an application-provided render target + // in Qt 6. (with the exception of the software backend because that + // does not support custom render targets, so the grab implementation + // here is still valuable) + #if QT_CONFIG(thread) - } else if (d->window->rendererInterface()->graphicsApi() == QSGRendererInterface::Software) { - QQuickWindowPrivate *cd = QQuickWindowPrivate::get(d->window); + } else if (window->rendererInterface()->graphicsApi() == QSGRendererInterface::Software) { + QQuickWindowPrivate *cd = QQuickWindowPrivate::get(window); cd->polishItems(); cd->syncSceneGraph(); QSGSoftwareRenderer *softwareRenderer = static_cast<QSGSoftwareRenderer *>(cd->renderer); if (softwareRenderer) { - const qreal dpr = d->window->effectiveDevicePixelRatio(); - const QSize imageSize = d->window->size() * dpr; + const qreal dpr = window->effectiveDevicePixelRatio(); + const QSize imageSize = window->size() * dpr; grabContent = QImage(imageSize, QImage::Format_ARGB32_Premultiplied); grabContent.setDevicePixelRatio(dpr); QPaintDevice *prevDev = softwareRenderer->currentPaintDevice(); softwareRenderer->setCurrentPaintDevice(&grabContent); softwareRenderer->markDirty(); - d->rc->endSync(); - render(); + rc->endSync(); + q->render(); softwareRenderer->setCurrentPaintDevice(prevDev); } #endif @@ -436,7 +527,7 @@ void QQuickRenderControlPrivate::maybeUpdate() Reimplemented in subclasses to return the real window this render control is rendering into. - If \a offset in non-null, it is set to the offset of the control + If \a offset is non-null, it is set to the offset of the control inside the window. \note While not mandatory, reimplementing this function becomes essential for @@ -448,7 +539,7 @@ void QQuickRenderControlPrivate::maybeUpdate() /*! Returns the real window that \a win is being rendered to, if any. - If \a offset in non-null, it is set to the offset of the rendering + If \a offset is non-null, it is set to the offset of the rendering inside its window. */ @@ -462,6 +553,257 @@ QWindow *QQuickRenderControl::renderWindowFor(QQuickWindow *win, QPoint *offset) return nullptr; } +bool QQuickRenderControlPrivate::isRenderWindowFor(QQuickWindow *quickWin, const QWindow *renderWin) +{ + QQuickRenderControl *rc = QQuickWindowPrivate::get(quickWin)->renderControl; + if (rc) + return QQuickRenderControlPrivate::get(rc)->isRenderWindow(renderWin); + return false; +} + +bool QQuickRenderControlPrivate::isRenderWindow(const QWindow *w) +{ + Q_Q(QQuickRenderControl); + + if (window && w) + return q->renderWindowFor(window, nullptr) == w; + + return false; +} + +/*! + \return the QQuickWindow this QQuickRenderControl is associated with. + + \note A QQuickRenderControl gets associated with a QQuickWindow when + constructing the QQuickWindow. The return value from this function is null + before that point. + + \since 6.0 + */ +QQuickWindow *QQuickRenderControl::window() const +{ + Q_D(const QQuickRenderControl); + return d->window; +} + +/*! + \return the QRhi this QQuickRenderControl is associated with. + + \note The QRhi exists only when initialize() has successfully completed. + Before that the return value is null. + + \note This function is not applicable and returns null when using the + \c software adaptation of Qt Quick. + + \since 6.6 + + \sa commandBuffer(), beginFrame(), endFrame() + */ +QRhi *QQuickRenderControl::rhi() const +{ + Q_D(const QQuickRenderControl); + return d->rhi; +} + +/*! + \return the current command buffer. + + Once beginFrame() is called, a QRhiCommandBuffer is set up automatically. + That is the command buffer Qt Quick scenegraph uses, but in some cases + applications may also want to query it, for example to issue resource + updates (for example, a texture readback). + + The returned command buffer reference should only be used between + beginFrame() and endFrame(). There are specific exceptions, for example + calling + \l{QRhiCommandBuffer::lastCompletedGpuTime()}{lastCompletedGpuTime()} on + the command buffer right after endFrame(), but before the next + beginFrame(), is valid. + + \note This function is not applicable and returns null when using the + \c software adaptation of Qt Quick. + + \since 6.6 + + \sa rhi(), beginFrame(), endFrame() + */ +QRhiCommandBuffer *QQuickRenderControl::commandBuffer() const +{ + Q_D(const QQuickRenderControl); + return d->cb; +} + +/*! + Specifies the start of a graphics frame. Calls to sync() or render() must + be enclosed by calls to beginFrame() and endFrame(). + + Unlike the earlier OpenGL-only world of Qt 5, rendering with other graphics + APIs requires more well-defined points of starting and ending a frame. When + manually driving the rendering loop via QQuickRenderControl, it now falls + to the user of QQuickRenderControl to specify these points. + + A typical update step, including initialization of rendering into an + existing texture, could look like the following. The example snippet + assumes Direct3D 11 but the same concepts apply other graphics APIs as + well. + + \code + if (!m_quickInitialized) { + m_quickWindow->setGraphicsDevice(QQuickGraphicsDevice::fromDeviceAndContext(m_engine->device(), m_engine->context())); + + if (!m_renderControl->initialize()) + qWarning("Failed to initialize redirected Qt Quick rendering"); + + m_quickWindow->setRenderTarget(QQuickRenderTarget::fromNativeTexture({ quint64(m_res.texture), 0 }, + QSize(QML_WIDTH, QML_HEIGHT), + SAMPLE_COUNT)); + + m_quickInitialized = true; + } + + m_renderControl->polishItems(); + + m_renderControl->beginFrame(); + m_renderControl->sync(); + m_renderControl->render(); + m_renderControl->endFrame(); // Qt Quick's rendering commands are submitted to the device context here + \endcode + + \note This function does not need to be, and must not be, called when using + the \c software adaptation of Qt Quick. + + \note Internally beginFrame() and endFrame() invoke + \l{QRhi::}{beginOffscreenFrame()} and \l{QRhi::}{endOffscreenFrame()}, + respectively. This implies that there must not be a frame (neither + offscreen, nor swapchain-based) being recorded on the QRhi when + this function is called. + + \since 6.0 + + \sa endFrame(), initialize(), sync(), render(), QQuickGraphicsDevice, QQuickRenderTarget + */ +void QQuickRenderControl::beginFrame() +{ + Q_D(QQuickRenderControl); + if (!d->rhi) { + qWarning("QQuickRenderControl: No QRhi in beginFrame()"); + return; + } + if (d->frameStatus == QQuickRenderControlPrivate::RecordingFrame) { + qWarning("QQuickRenderControl: beginFrame() must be followed by a call to endFrame() before calling beginFrame() again"); + return; + } + if (d->rhi->isRecordingFrame()) { + qWarning("QQuickRenderControl: Attempted to beginFrame() while the QRhi is already recording a frame"); + return; + } + + emit d->window->beforeFrameBegin(); + + QRhi::FrameOpResult result = d->rhi->beginOffscreenFrame(&d->cb); + + switch (result) { + case QRhi::FrameOpSuccess: + case QRhi::FrameOpSwapChainOutOfDate: + d->frameStatus = QQuickRenderControlPrivate::RecordingFrame; + break; + case QRhi::FrameOpError: + d->frameStatus = QQuickRenderControlPrivate::ErrorInBeginFrame; + break; + case QRhi::FrameOpDeviceLost: + d->frameStatus = QQuickRenderControlPrivate::DeviceLostInBeginFrame; + break; + default: + d->frameStatus = QQuickRenderControlPrivate::NotRecordingFrame; + break; + } +} + +/*! + Specifies the end of a graphics frame. Calls to sync() or render() must be + enclosed by calls to beginFrame() and endFrame(). + + When this function is called, any graphics commands enqueued by the + scenegraph are submitted to the context or command queue, whichever is + applicable. + + \note This function does not need to be, and must not be, called when using + the \c software adaptation of Qt Quick. + + \since 6.0 + + \sa beginFrame(), initialize(), sync(), render(), QQuickGraphicsDevice, QQuickRenderTarget + */ +void QQuickRenderControl::endFrame() +{ + Q_D(QQuickRenderControl); + if (!d->rhi) { + qWarning("QQuickRenderControl: No QRhi in endFrame()"); + return; + } + if (d->frameStatus != QQuickRenderControlPrivate::RecordingFrame) { + qWarning("QQuickRenderControl: endFrame() must only be called after a successful beginFrame()"); + return; + } + if (!d->rhi->isRecordingFrame()) { + qWarning("QQuickRenderControl: Attempted to endFrame() while the QRhi is not recording a frame"); + return; + } + + d->rhi->endOffscreenFrame(); + // do not null out d->cb; this allows calling lastCompletedGpuTime() for example + + d->frameStatus = QQuickRenderControlPrivate::NotRecordingFrame; + + emit d->window->afterFrameEnd(); +} + +bool QQuickRenderControlPrivate::initRhi() +{ + // initialize() - invalidate() - initialize() uses the QRhi the first + // initialize() created, so if already exists, we are done. Does not apply + // when wrapping an externally created QRhi, because we may be associated + // with a new one now. + if (rhi && ownRhi) + return true; + + QSGRhiSupport *rhiSupport = QSGRhiSupport::instance(); + + // sanity check for Vulkan +#if QT_CONFIG(vulkan) + if (rhiSupport->rhiBackend() == QRhi::Vulkan && !window->vulkanInstance()) { + qWarning("QQuickRenderControl: No QVulkanInstance set for QQuickWindow, cannot initialize"); + return false; + } +#endif + + // for OpenGL + if (!offscreenSurface) + offscreenSurface = rhiSupport->maybeCreateOffscreenSurface(window); + + QSGRhiSupport::RhiCreateResult result = rhiSupport->createRhi(window, offscreenSurface); + if (!result.rhi) { + qWarning("QQuickRenderControl: Failed to initialize QRhi"); + return false; + } + + rhi = result.rhi; + ownRhi = result.own; + + return true; +} + +void QQuickRenderControlPrivate::resetRhi(const QQuickGraphicsConfiguration &config) +{ + if (ownRhi) + QSGRhiSupport::instance()->destroyRhi(rhi, config); + + rhi = nullptr; + + delete offscreenSurface; + offscreenSurface = nullptr; +} + QT_END_NAMESPACE #include "moc_qquickrendercontrol.cpp" |