[Sc2-cvs] SF.net SVN: sc2:[3721] trunk/sc2/src/uqm/flash.h

[<Mee...@us...>]

Revision: 3721
          http://sc2.svn.sourceforge.net/sc2/?rev=3721&view=rev
Author:   Meep-Eep
Date:     2011-12-29 22:30:42 +0000 (Thu, 29 Dec 2011)
Log Message:
-----------
More comment fixes.

Modified Paths:
--------------
    trunk/sc2/src/uqm/flash.h

Modified: trunk/sc2/src/uqm/flash.h
===================================================================
--- trunk/sc2/src/uqm/flash.h	2011-12-29 21:29:16 UTC (rev 3720)
+++ trunk/sc2/src/uqm/flash.h	2011-12-29 22:30:42 UTC (rev 3721)
@@ -38,7 +38,7 @@
  * Flash_setMergeFactors(fc, 2, 3, 2);
  *
  * // We change the flashing speed from the defaults.
- * Flash_setSpeed (ONE_SECOND, ONE_SECOND, ONE_SECOND, ONE_SECOND);
+ * Flash_setSpeed (fc, ONE_SECOND, ONE_SECOND, ONE_SECOND, ONE_SECOND);
  * 
  * // During cross-fades, update 8 times per second.
  * Flash_setFrameTime (fc, ONE_SECOND / 8);
@@ -62,7 +62,7 @@
  * ...
  * // Modifying the graphics of the area that is flashing:
  * void Flash_preUpdate (fc);
- * ... // do Drawing
+ * ... // do drawing
  * void Flash_postUpdate (fc);
  * ...
  * // We're done. Terminating the flash restores the flash area to its
@@ -77,13 +77,15 @@
  *
  * Limitations:
  *
- * 2) Functions that draw to the gfxContext or read the original gfxContext
- * contents, which is most of them, must be called with gfxContext having
- * the same clip-rect as it did when other drawing functions were called.
- * Otherwise, original contents restoration may draw to the wrong area, or
- * the wrong area may be read.
- * There may be cases where one would *want* that to happen, and such
- * cases are not covered by this limitation.
+ * * Functions that draw to the gfxContext or read the original gfxContext
+ *   contents, which is most of them, must be called with gfxContext having
+ *   the same clip-rect as it did when other drawing functions were called.
+ *   Otherwise, original contents restoration may draw to the wrong area, or
+ *   the wrong area may be read.
+ *   There may be cases where one would *want* that to happen, and such
+ *   cases are not covered by this limitation.
+ * * Multiple flashes may be used simultaneously, but don't let them
+ *   overlap; artifacts would occur.
  */
 
 #include "libs/gfxlib.h"

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