[Scummvm-cvs-logs] SF.net SVN: scummvm:[38860] scummvm/trunk/common/system.h

[fingolfin at users.sourceforge.net]

Revision: 38860
          http://scummvm.svn.sourceforge.net/scummvm/?rev=38860&view=rev
Author:   fingolfin
Date:     2009-02-24 21:22:04 +0000 (Tue, 24 Feb 2009)

Log Message:
-----------
Fix my wrong comment on OSystem::updateScreen(). Now it is hopefully correct

Modified Paths:
--------------
    scummvm/trunk/common/system.h

Modified: scummvm/trunk/common/system.h
===================================================================
--- scummvm/trunk/common/system.h	2009-02-24 21:15:23 UTC (rev 38859)
+++ scummvm/trunk/common/system.h	2009-02-24 21:22:04 UTC (rev 38860)
@@ -524,14 +524,10 @@
 	 * 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;
 


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.