diff options
| -rw-r--r-- | src/quick/doc/src/concepts/visualcanvas/scenegraph.qdoc | 1 | ||||
| -rw-r--r-- | src/quickwidgets/qquickwidget.cpp | 19 |
2 files changed, 13 insertions, 7 deletions
diff --git a/src/quick/doc/src/concepts/visualcanvas/scenegraph.qdoc b/src/quick/doc/src/concepts/visualcanvas/scenegraph.qdoc index faec8df7e4..b0a66cfb5f 100644 --- a/src/quick/doc/src/concepts/visualcanvas/scenegraph.qdoc +++ b/src/quick/doc/src/concepts/visualcanvas/scenegraph.qdoc @@ -194,6 +194,7 @@ throttling, use the \c basic render loop instead by setting \c {QSG_RENDER_LOOP=basic} in the environment. \section2 Threaded Render Loop ('threaded') +\target threaded_render_loop On many configurations, the scene graph rendering will happen on a dedicated render thread. This is done to increase parallelism of diff --git a/src/quickwidgets/qquickwidget.cpp b/src/quickwidgets/qquickwidget.cpp index 37b3823bde..e3b7a8da28 100644 --- a/src/quickwidgets/qquickwidget.cpp +++ b/src/quickwidgets/qquickwidget.cpp @@ -558,19 +558,24 @@ QImage QQuickWidgetPrivate::grabFramebuffer() size of the view. Alternatively the resizeMode may be set to SizeRootObjectToView which will resize the view to the size of the root object. - \note QQuickWidget is an alternative to using QQuickView and QWidget::createWindowContainer(). + \section1 Performance Considerations + + QQuickWidget is an alternative to using QQuickView and QWidget::createWindowContainer(). The restrictions on stacking order do not apply, making QQuickWidget the more flexible alternative, behaving more like an ordinary widget. - \note However, the above mentioned advantages come at the expense of performance. - Unlike QQuickWindow and QQuickView, QQuickWidget requires rendering into OpenGL + However, the above mentioned advantages come at the expense of performance: + \list + + \li Unlike QQuickWindow and QQuickView, QQuickWidget requires rendering into OpenGL framebuffer objects, which needs to be enforced by calling - QQuickWindow::setGraphicsApi(QSGRendererInterface::OpenGLRhi) at startup. + QQuickWindow::setGraphicsApi(QSGRendererInterface::OpenGL) at startup. This will naturally carry a minor performance hit. - \note Using QQuickWidget disables the threaded render loop on all platforms. This means that - some of the benefits of threaded rendering, for example \l Animator classes and vsync driven - animations, will not be available. + \li Using QQuickWidget disables the \l{threaded_render_loop}{threaded render loop} on all + platforms. This means that some of the benefits of threaded rendering, for example + \l Animator classes and vsync driven animations, will not be available. + \endlist \note Avoid calling winId() on a QQuickWidget. This function triggers the creation of a native window, resulting in reduced performance and possibly rendering glitches. The |