From 8adde5537719aa7981d8ca8b5218cbbf95f107df Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vladim=C3=ADr=20Vondru=C5=A1?= Date: Thu, 13 Mar 2014 23:19:14 +0100 Subject: [PATCH] Platform: improve documentation of redraw() function. Make it clear that it's possible and non-harmful to call it from drawEvent() itself. --- src/Magnum/Platform/Sdl2Application.h | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/src/Magnum/Platform/Sdl2Application.h b/src/Magnum/Platform/Sdl2Application.h index eb5289388..30cb1643e 100644 --- a/src/Magnum/Platform/Sdl2Application.h +++ b/src/Magnum/Platform/Sdl2Application.h @@ -283,7 +283,8 @@ class Sdl2Application { * @brief Redraw immediately * * Marks the window for redrawing, resulting in call to @ref drawEvent() - * in the next iteration. + * in the next iteration. You can call it from @ref drawEvent() itself + * to redraw immediately without waiting for user input. */ void redraw() { flags |= Flag::Redraw; }