From d3b715817d15ac9548586e3461cd9030945a2cc8 Mon Sep 17 00:00:00 2001 From: Max Horn Date: Tue, 24 Feb 2009 21:15:23 +0000 Subject: Add some remarks on OSystem::updateScreen() properties svn-id: r38859 --- common/system.h | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/common/system.h b/common/system.h index b4bbae017b..d5706e2244 100644 --- a/common/system.h +++ b/common/system.h @@ -522,7 +522,16 @@ public: /** * Flush the whole screen, that is render the current content of the screen - * framebuffer (resp. the dirty/changed parts of it) to the display. + * framebuffer to the display. + * + * Depending on the backend, this can be a relatively slow operation. Since + * a full screen update could take place upon each call, you should call + * this method as rarely as possible, but of course still as often as + * necessary. + * + * @todo Yes, this is vague. We probably should try to specify this clearly. + * See + * for a discussion on the subject. */ virtual void updateScreen() = 0; -- cgit v1.2.3