diff options
| author | Laszlo Agocs <laszlo.agocs@qt.io> | 2020-06-22 13:00:03 +0200 |
|---|---|---|
| committer | Laszlo Agocs <laszlo.agocs@qt.io> | 2020-06-22 16:10:52 +0200 |
| commit | 4e266103ad8b75d71fb176a2f774faf71997123d (patch) | |
| tree | ecf675969c45271ca2c9d3e5199631f4f1b9c129 /src/quick/doc | |
| parent | 38bd2bd83144e3b7e7935e3730c109358b3e5740 (diff) | |
Rename setSceneGraphBackend to setGraphicsApi
...and fix up the docs.
The string-based setSceneGraphBackend() stays of course (the docs have
been enhanced, however). The GraphicsApi enum-based overload is now
renamed to setGraphicsApi().
Using the same name for both functions is a historical artifact, reflecting
the evolution (5.0 - 5.8 - 5.14). In 6.0 we can give it a more appropriate
name, since it does not have much to do with "backends" from the user's
perspective.
Change-Id: Id75dbf81f50a148797e5b5de9be4000153737473
Reviewed-by: Andy Nichols <andy.nichols@qt.io>
Diffstat (limited to 'src/quick/doc')
| -rw-r--r-- | src/quick/doc/src/concepts/visualcanvas/adaptations.qdoc | 4 | ||||
| -rw-r--r-- | src/quick/doc/src/concepts/visualcanvas/scenegraph.qdoc | 2 |
2 files changed, 3 insertions, 3 deletions
diff --git a/src/quick/doc/src/concepts/visualcanvas/adaptations.qdoc b/src/quick/doc/src/concepts/visualcanvas/adaptations.qdoc index d07885e6ad..e330806c85 100644 --- a/src/quick/doc/src/concepts/visualcanvas/adaptations.qdoc +++ b/src/quick/doc/src/concepts/visualcanvas/adaptations.qdoc @@ -59,7 +59,7 @@ is always built-in. As of Qt 6.0 it is always enabled. On platforms where multiple graphics APIs are available, the scenegraph makes a platform-specific choice. If this is not desired, applications can force a specified graphics API by setting the environment variable \c{QSG_RHI_BACKEND} or via \l -QQuickWindow::setSceneGraphBackend() in combination with \l +QQuickWindow::setGraphicsApi() in combination with \l QSGRendererInterface::GraphicsApi. Switching to a different adaptation can be achieved in two ways: @@ -74,7 +74,7 @@ Switching to a different adaptation can be achieved in two ways: The following backends are supported: \list - \li Default - Request with the \c{""} string or a QSGRendererInterface::GraphicsApi enum value + \li Default - Request with the \c{"rhi"} string or a QSGRendererInterface::GraphicsApi enum value different than the ones listed below. \li Software - Request with the \c{"software"} string or the QSGRendererInterface::Software enum value. diff --git a/src/quick/doc/src/concepts/visualcanvas/scenegraph.qdoc b/src/quick/doc/src/concepts/visualcanvas/scenegraph.qdoc index b06c972ddf..a3022f0e2b 100644 --- a/src/quick/doc/src/concepts/visualcanvas/scenegraph.qdoc +++ b/src/quick/doc/src/concepts/visualcanvas/scenegraph.qdoc @@ -1020,7 +1020,7 @@ with multiple windows. will fail otherwise); \badcode - QQuickWindow::setSceneGraphBackend(QSGRendererInterface::VulkanRhi); + QQuickWindow::setGraphicsApi(QSGRendererInterface::VulkanRhi); \endcode See QSGRendererInterface::GraphicsApi. The enum values ending in \c Rhi are |