Cast constants to hptime_t.
[bertos.git] / gfx / bitmap.c
index d74c7735487c64a2957a8e9c3c83381045162357..fd534375d0a309415ca260975d039a295ba17cbd 100755 (executable)
@@ -1,4 +1,4 @@
-/*!
+/**
  * \file
  * <!--
  * Copyright 2003, 2004, 2005, 2006 Develer S.r.l. (http://www.develer.com/)
 
 /*#*
  *#* $Log$
+ *#* Revision 1.12  2006/08/01 12:23:39  bernie
+ *#* gfx_setClipRect(): Also define when CONFIG_GFX_VCOORDS is enabled; Extend documentation.
+ *#*
+ *#* Revision 1.11  2006/07/19 12:56:26  bernie
+ *#* Convert to new Doxygen style.
+ *#*
  *#* Revision 1.10  2006/05/27 17:21:15  bernie
  *#* Factor out, simplify and document clipping.
  *#*
@@ -63,7 +69,7 @@
 #endif
 
 
-/*!
+/**
  * Initialize a Bitmap structure with the provided parameters.
  *
  * \note The pen position is reset to the origin.
@@ -97,7 +103,7 @@ void gfx_bitmapInit(Bitmap *bm, uint8_t *raster, coord_t w, coord_t h)
 }
 
 
-/*!
+/**
  * Clear the whole bitmap surface to the background color.
  *
  * \note This function does \b not update the current pen position.
@@ -113,7 +119,7 @@ void gfx_bitmapClear(Bitmap *bm)
 
 #include <avr/pgmspace.h> /* FIXME: memcpy_P() */
 
-/*!
+/**
  * Copy a raster picture located in program memory in the bitmap.
  * The size of the raster to copy *must* be the same of the raster bitmap.
  *
@@ -237,7 +243,7 @@ void gfx_blitImage(Bitmap *dst, coord_t dxmin, coord_t dymin, const Image *image
 }
 
 
-#if CONFIG_GFX_CLIPPING
+#if CONFIG_GFX_CLIPPING || CONFIG_GFX_VCOORDS
 
 /**
  * Set the bitmap clipping rectangle to the specified coordinates.
@@ -245,9 +251,14 @@ void gfx_blitImage(Bitmap *dst, coord_t dxmin, coord_t dymin, const Image *image
  * All drawing performed on the bitmap will be clipped inside this
  * rectangle.
  *
+ * The clipping rectangle is also used as a bounding box for the
+ * logical view of the virtual coordinate system.
+ *
  * \note Following the convention used for all other operations, the
  *       top-left pixels of the rectangle are included, while the
  *       bottom-right pixels are considered outside the clipping region.
+ *
+ * \see gfx_setViewRect
  */
 void gfx_setClipRect(Bitmap *bm, coord_t minx, coord_t miny, coord_t maxx, coord_t maxy)
 {