aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorLaszlo Agocs <laszlo.agocs@digia.com>2014-11-13 14:47:21 +0100
committerLaszlo Agocs <laszlo.agocs@digia.com>2014-11-17 13:22:37 +0100
commit05176ece31d6eb5295d96b8ba75b10cd84e603a6 (patch)
treeb03255f9d0e5de7a6e3a55a2f1b0855ab01e23e3
parent2f3c8f79d2230a8217c29b6e909bd8418ede24e8 (diff)
Fix render control docs
Fix a typo and add a note to the signals. Change-Id: Ia8810562c5b5f192d7e54bc965807b8e78a26985 Reviewed-by: Karim Pinter <karim.pinter@digia.com> Reviewed-by: Paul Olav Tvete <paul.tvete@theqtcompany.com>
-rw-r--r--src/quick/items/qquickrendercontrol.cpp10
1 files changed, 9 insertions, 1 deletions
diff --git a/src/quick/items/qquickrendercontrol.cpp b/src/quick/items/qquickrendercontrol.cpp
index 7ccd3a0fb4..e433e55873 100644
--- a/src/quick/items/qquickrendercontrol.cpp
+++ b/src/quick/items/qquickrendercontrol.cpp
@@ -106,7 +106,7 @@ extern Q_GUI_EXPORT QImage qt_gl_read_framebuffer(const QSize &size, bool alpha_
rendered by calling render(). After making the context current, applications
are expected to call render().
- \li QQuickRenderControl::sceneChanged() Inidcates that the scene has changed
+ \li QQuickRenderControl::sceneChanged() Indicates that the scene has changed
meaning that, before rendering, polishing and synchronizing is also necessary.
\endlist
@@ -296,6 +296,10 @@ void QQuickRenderControl::render()
\fn void QQuickRenderControl::renderRequested()
This signal is emitted when the scene graph needs to be rendered. It is not necessary to call sync().
+
+ \note Avoid triggering rendering directly when this signal is
+ emitted. Instead, prefer deferring it by using a timer for example. This
+ will lead to better performance.
*/
/*!
@@ -304,6 +308,10 @@ void QQuickRenderControl::render()
This signal is emitted when the scene graph is updated, meaning that
polishItems() and sync() needs to be called. If sync() returns
true, then render() needs to be called.
+
+ \note Avoid triggering polishing, synchronization and rendering directly
+ when this signal is emitted. Instead, prefer deferring it by using a timer
+ for example. This will lead to better performance.
*/
/*!