Commit 05176ece authored by Laszlo Agocs's avatar Laszlo Agocs
Browse files

Fix render control docs


Fix a typo and add a note to the signals.

Change-Id: Ia8810562c5b5f192d7e54bc965807b8e78a26985
Reviewed-by: default avatarKarim Pinter <karim.pinter@digia.com>
Reviewed-by: default avatarPaul Olav Tvete <paul.tvete@theqtcompany.com>
parent 2f3c8f79
No related merge requests found
Showing with 9 additions and 1 deletion
...@@ -106,7 +106,7 @@ extern Q_GUI_EXPORT QImage qt_gl_read_framebuffer(const QSize &size, bool alpha_ ...@@ -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 rendered by calling render(). After making the context current, applications
are expected to call render(). 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. meaning that, before rendering, polishing and synchronizing is also necessary.
\endlist \endlist
...@@ -296,6 +296,10 @@ void QQuickRenderControl::render() ...@@ -296,6 +296,10 @@ void QQuickRenderControl::render()
\fn void QQuickRenderControl::renderRequested() \fn void QQuickRenderControl::renderRequested()
This signal is emitted when the scene graph needs to be rendered. It is not necessary to call sync(). 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() ...@@ -304,6 +308,10 @@ void QQuickRenderControl::render()
This signal is emitted when the scene graph is updated, meaning that This signal is emitted when the scene graph is updated, meaning that
polishItems() and sync() needs to be called. If sync() returns polishItems() and sync() needs to be called. If sync() returns
true, then render() needs to be called. 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.
*/ */
/*! /*!
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment