diff options
author | Paul Olav Tvete <paul.tvete@qt.io> | 2016-10-06 16:16:24 +0200 |
---|---|---|
committer | Paul Olav Tvete <paul.tvete@qt.io> | 2016-10-07 12:01:28 +0000 |
commit | 985bd824ef70ea23484f70718b0f944533c4d076 (patch) | |
tree | 3b602883e9828bcfe2cab643a56d86ae960e61dc | |
parent | 2e37c65cb8e90694a7fb8107f009ba7710103062 (diff) | |
download | qtwayland-985bd824ef70ea23484f70718b0f944533c4d076.tar.gz |
Fix advance() documentation
Focus less on how the function is implemented and more on what
it does.
Change-Id: I3fff4a142e730431056cac1d2173e0d82440f8ec
Reviewed-by: Johan Helsing <johan.helsing@qt.io>
-rw-r--r-- | src/compositor/compositor_api/qwaylandview.cpp | 27 |
1 files changed, 12 insertions, 15 deletions
diff --git a/src/compositor/compositor_api/qwaylandview.cpp b/src/compositor/compositor_api/qwaylandview.cpp index ef9e43a3..f526c647 100644 --- a/src/compositor/compositor_api/qwaylandview.cpp +++ b/src/compositor/compositor_api/qwaylandview.cpp @@ -216,20 +216,11 @@ void QWaylandView::bufferCommitted(const QWaylandBufferRef &buffer, const QRegio } /*! - * Sets the next buffer and damage region to current and returns \c true. If the buffer - * is locked or if no new buffer has been attached since the last call to - * advance(), the function returns \c false and does nothing. + * Updates the current buffer and damage region to the latest version committed by the client. + * Returns true if new content was committed since the previous call to advance(). + * Otherwise returns false. * - * If this view is set as the surface's throttling view, discardCurrentBuffer() - * is called on all views of the same surface for which the - * \l{QWaylandView::allowDiscardFrontBuffer}{allowDiscardFrontBuffer} - * property is set to true and the current buffer is the same as the - * throttling view's current buffer. - * - * To enable clients to reuse existing buffers, enable the primary view to ensure - * that views running on a lower frequency will release their front buffer - * references. This design approach should avoid the situation where the lower - * frequency views throttle the frame rate of the client application. + * \sa currentBuffer(), currentDamage() */ bool QWaylandView::advance() { @@ -324,14 +315,20 @@ void QWaylandView::setBufferLocked(bool locked) * \qmlproperty bool QtWaylandCompositor::WaylandView::allowDiscardFrontBuffer * * By default, the view locks the current buffer until advance() is called. Set this property - * to true to allow Qt to release the buffer when the throttling view is no longer using it. + * to true to allow Qt to release the buffer when the primary view is no longer using it. + * + * This can be used to avoid the situation where a secondary view that updates on a lower + * frequency will throttle the frame rate of the client application. */ /*! * \property QWaylandView::allowDiscardFrontBuffer * * By default, the view locks the current buffer until advance() is called. Set this property - * to \c true to allow Qt to release the buffer when the throttling view is no longer using it. + * to \c true to allow Qt to release the buffer when the primary view is no longer using it. + * + * This can be used to avoid the situation where a secondary view that updates on a lower + * frequency will throttle the frame rate of the client application. */ bool QWaylandView::allowDiscardFrontBuffer() const { |