aboutsummaryrefslogtreecommitdiffstats
path: root/src/quick
diff options
context:
space:
mode:
authorAndy Shaw <andy.shaw@qt.io>2020-04-16 09:27:47 +0200
committerAndy Shaw <andy.shaw@qt.io>2020-04-16 12:40:53 +0000
commitb3eb349ddddec6967fcedfdbfc857b99f34e552a (patch)
treec9745bf5db30becd408f66b94ff00d7aa74f4a61 /src/quick
parentf590202cb085e1463e61bd8b645e6f2cdb7d3fe8 (diff)
Doc: Clarify what QQuickWindow::resetOpenGLState() resets
As there is some confusion over what resetOpenGLState() actually resets, then this clarifies it to be clearer on that it only resets the internally changed states. Change-Id: Ie6f27e4772bd757d7d435575dcd9d711a1c6a9d7 Reviewed-by: Topi Reiniƶ <topi.reinio@qt.io> Reviewed-by: Laszlo Agocs <laszlo.agocs@qt.io>
Diffstat (limited to 'src/quick')
-rw-r--r--src/quick/items/qquickwindow.cpp5
1 files changed, 5 insertions, 0 deletions
diff --git a/src/quick/items/qquickwindow.cpp b/src/quick/items/qquickwindow.cpp
index 50b166b18f..48ba0ecc28 100644
--- a/src/quick/items/qquickwindow.cpp
+++ b/src/quick/items/qquickwindow.cpp
@@ -4889,6 +4889,11 @@ void QQuickWindow::setDefaultAlphaBuffer(bool useAlpha)
\note This function only has an effect when using the default OpenGL scene graph
adaptation.
+ \note This function will only reset the OpenGL context in relation to what has been changed
+ internally as part of the OpenGL scene graph. It does not reset anything that has been changed
+ externally such as direct OpenGL calls done inside the application code if those same calls are
+ not used internally.
+
\note This function has no effect when running on the RHI graphics
abstraction and the underlying RHI backend is not OpenGL.