From 63b1e026205b0fe8e877f55ad0eccb5d66accb5f Mon Sep 17 00:00:00 2001 From: Meep-Eep Date: Thu, 29 Dec 2011 22:30:42 +0000 Subject: [PATCH] More comment fixes. git-svn-id: svn://svn.code.sf.net/p/sc2/code/trunk@3721 8092fc87-c524-0410-9efc-e669fe64eaf9 --- sc2/src/uqm/flash.h | 20 +++++++++++--------- 1 file changed, 11 insertions(+), 9 deletions(-) diff --git a/sc2/src/uqm/flash.h b/sc2/src/uqm/flash.h index b3ed1aaa9..cb3b51f85 100644 --- a/sc2/src/uqm/flash.h +++ b/sc2/src/uqm/flash.h @@ -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"