aboutsummaryrefslogtreecommitdiff
path: root/common
diff options
context:
space:
mode:
authorMax Horn2009-02-24 21:22:04 +0000
committerMax Horn2009-02-24 21:22:04 +0000
commit6eef86ef4ce95e1b6b904acf2c94d29128812681 (patch)
treeb853ad057d7aea8026aa865698b67fb29ba1b71e /common
parentd3b715817d15ac9548586e3461cd9030945a2cc8 (diff)
downloadscummvm-rg350-6eef86ef4ce95e1b6b904acf2c94d29128812681.tar.gz
scummvm-rg350-6eef86ef4ce95e1b6b904acf2c94d29128812681.tar.bz2
scummvm-rg350-6eef86ef4ce95e1b6b904acf2c94d29128812681.zip
Fix my wrong comment on OSystem::updateScreen(). Now it is hopefully correct
svn-id: r38860
Diffstat (limited to 'common')
-rw-r--r--common/system.h12
1 files changed, 4 insertions, 8 deletions
diff --git a/common/system.h b/common/system.h
index d5706e2244..fc5535a4dc 100644
--- a/common/system.h
+++ b/common/system.h
@@ -524,14 +524,10 @@ public:
* Flush the whole screen, that is render the current content of the screen
* 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 <http://www.nabble.com/ATTN-porters%3A-updateScreen%28%29-OSystem-method-tt3960261.html#a3960261>
- * for a discussion on the subject.
+ * This method could be called very often by engines. Backends are hence
+ * supposed to only perform any redrawing if it is necessary, and otherwise
+ * return immediately. For a discussion of the subject, see
+ * <http://www.nabble.com/ATTN-porters%3A-updateScreen%28%29-OSystem-method-tt3960261.html#a3960261>
*/
virtual void updateScreen() = 0;