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

[fingolfin at users.sourceforge.net]

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

Log Message:
-----------
Add some remarks on OSystem::updateScreen() properties

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

Modified: scummvm/trunk/common/system.h
===================================================================
--- scummvm/trunk/common/system.h	2009-02-24 21:14:04 UTC (rev 38858)
+++ scummvm/trunk/common/system.h	2009-02-24 21:15:23 UTC (rev 38859)
@@ -522,7 +522,16 @@
 
 	/**
 	 * 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 <http://www.nabble.com/ATTN-porters%3A-updateScreen%28%29-OSystem-method-tt3960261.html#a3960261>
+	 * for a discussion on the subject.
 	 */
 	virtual void updateScreen() = 0;
 


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