From ed8273b15af82a483077a0be10f4b73d7b45c2a2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vladim=C3=ADr=20Vondru=C5=A1?= Date: Sun, 12 Apr 2015 22:28:36 +0200 Subject: [PATCH] Doc++ --- src/Magnum/Timeline.h | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/src/Magnum/Timeline.h b/src/Magnum/Timeline.h index a6c29d145..0863fa9df 100644 --- a/src/Magnum/Timeline.h +++ b/src/Magnum/Timeline.h @@ -99,8 +99,12 @@ class MAGNUM_EXPORT Timeline { * @brief Set minimal frame time * @return Reference to self (for method chaining) * - * Default value is 0. - * @see @ref nextFrame() + * Default value is `0.0f`. Cannot be used on some platforms where + * blocking the main loop is not allowed (such as + * @ref CORRADE_TARGET_EMSCRIPTEN "Emscripten"). Prefer to use VSync + * where possible. + * @see @ref nextFrame(), + * @ref Platform::Sdl2Application::setSwapInterval() "Platform::*Application::setSwapInterval()" */ Timeline& setMinimalFrameTime(Float seconds) { _minimalFrameTime = seconds;