diff options
author | Laszlo Agocs <laszlo.agocs@qt.io> | 2020-10-19 10:58:43 +0200 |
---|---|---|
committer | Laszlo Agocs <laszlo.agocs@qt.io> | 2020-10-19 12:31:27 +0200 |
commit | 765878539587626f2793c5eb454d57ec3c9f1ae9 (patch) | |
tree | 6bd75f9a7407cc124435fe38af9d0503e48f7cdf /src/quick | |
parent | c5ac1b8a060affdf73dfbed4322741fe1f2b43f9 (diff) |
doc: Update sg rhi backend section
Use the now preferred GraphicsApi enum value (e.g. Vulkan instead of
VulkanRhi). Drop a reference to the long gone QSG_RHI env.var.
Change-Id: I233611b40186884a70e9680b3dfef7284b3e3c73
Reviewed-by: Andy Nichols <andy.nichols@qt.io>
Diffstat (limited to 'src/quick')
-rw-r--r-- | src/quick/doc/src/concepts/visualcanvas/scenegraph.qdoc | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/src/quick/doc/src/concepts/visualcanvas/scenegraph.qdoc b/src/quick/doc/src/concepts/visualcanvas/scenegraph.qdoc index a3022f0e2b..7cffd8408f 100644 --- a/src/quick/doc/src/concepts/visualcanvas/scenegraph.qdoc +++ b/src/quick/doc/src/concepts/visualcanvas/scenegraph.qdoc @@ -1017,15 +1017,15 @@ with multiple windows. Applications wishing to always run with a single given graphics API, can request this via C++ as well. For example, the following call made early in main(), before constructing any QQuickWindow, forces the use of Vulkan (and - will fail otherwise); + will fail otherwise): \badcode - QQuickWindow::setGraphicsApi(QSGRendererInterface::VulkanRhi); + QQuickWindow::setGraphicsApi(QSGRendererInterface::Vulkan); \endcode - See QSGRendererInterface::GraphicsApi. The enum values ending in \c Rhi are - equivalent in effect to running with both \c QSG_RHI and \c QSG_RHI_BACKEND - set. + See QSGRendererInterface::GraphicsApi. The enum values \c OpenGL, \c Vulkan, + \c Metal, \c Direct3D11 are equivalent in effect to running with \c + QSG_RHI_BACKEND set to the equivalent string key. All QRhi backends will choose the system default GPU adapter or physical device, unless overridden by \c{QSG_RHI_PREFER_SOFTWARE_RENDERER} or a |