GRAPHICS: Add mask mode to FloodFill class and document the class.

1 files changed, 52 insertions, 0 deletions

diff --git a/graphics/surface.h b/graphics/surface.h
index e5685bf997..414a734683 100644
--- a/graphics/surface.h
+++ b/graphics/surface.h
@@ -343,19 +343,71 @@ struct SharedPtrSurfaceDeleter {
 	}
 };
 
+/**
+ * Stack-based flood fill algorithm for arbitrary Surfaces.
+ *
+ * It could be used in 2 ways. One is to fill the pixels of oldColor
+ * with fillColor. Second is when the surface stays intact but another
+ * surface with mask is created, where filled colors are marked with 255.
+ *
+ * Before running fill() or fillMask(), the initial pixels must be addSeed
+ * with addSeed() method.
+ */
 class FloodFill {
 public:
+	/**
+	 * Construct a simple Surface object.
+	 *
+	 * @param surface Input surface
+	 * @param oldColor Color on the surface to change
+	 * @param fillColor Color to fill with
+	 */
 	FloodFill(Surface *surface, uint32 oldColor, uint32 fillColor);
 	~FloodFill();
+
+	/**
+	 * Add pixels to the fill queue.
+	 *
+	 * @param x The x coordinate of the pixel.
+	 * @param y The x coordinate of the pixel.
+	 */
 	void addSeed(int x, int y);
+
+	/**
+	 * Fill the surface as requested.
+	 *
+	 * It uses pixels which were added with addSeed() method.
+	 *
+	 * @see addSeed
+	 */
 	void fill();
 
+	/**
+	 * Fill the mask. The mask is a CLUT8 Surface with pixels 0 and 255.
+	 * 255 means that the pixel has been filled.
+	 *
+	 * It uses pixels which were added with addSeed() method.
+	 *
+	 * @see addSeed
+	 */
+	void fillMask();
+
+	/**
+	 * Get the resulting mask.
+	 *
+	 * @see fillMask
+	 */
+	Surface *getMask() { return _mask; }
+
 private:
 	Common::List<Common::Point *> _queue;
 	Surface *_surface;
+	Surface *_mask;
 	uint32 _oldColor, _fillColor;
 	byte *_visited;
 	int _w, _h;
+
+	bool _maskMode;
 };
 
 } // End of namespace Graphics