From c1b0b061e14d1b41551dd0035a5c1f2f833f944e Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Tor=20Arne=20Vestb=C3=B8?= <tor.arne.vestbo@qt.io>
Date: Fri, 1 Apr 2022 18:14:21 +0200
Subject: [PATCH] doc: Warn against using the screen's refresh rate for driving
 animations

Pick-to: 6.2 6.3
Change-Id: Id26aae76792a4109b2ea6cca3db69ab505495d65
Reviewed-by: Laszlo Agocs <laszlo.agocs@qt.io>
---
 src/gui/kernel/qscreen.cpp | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/src/gui/kernel/qscreen.cpp b/src/gui/kernel/qscreen.cpp
index e6f408875e..1818e19612 100644
--- a/src/gui/kernel/qscreen.cpp
+++ b/src/gui/kernel/qscreen.cpp
@@ -547,6 +547,11 @@ Qt::ScreenOrientation QScreen::orientation() const
 /*!
   \property QScreen::refreshRate
   \brief the approximate vertical refresh rate of the screen in Hz
+
+  \warning Avoid using the screen's refresh rate to drive animations
+  via a timer such as QTimer. Instead use QWindow::requestUpdate().
+
+  \sa QWindow::requestUpdate()
 */
 qreal QScreen::refreshRate() const
 {