Doc fixes.

[bertos.git] / gfx / bitmap.c

diff --git a/gfx/bitmap.c b/gfx/bitmap.c
old mode 100755 (executable)
new mode 100644 (file)
index d74c773..d4c447e
--- a/gfx/bitmap.c
+++ b/gfx/bitmap.c
@@ -1,12 +1,35 @@
-/*!
+/**
  * \file
  * <!--
+ * This file is part of BeRTOS.
+ *
+ * Bertos is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+ *
+ * As a special exception, you may use this file as part of a free software
+ * library without restriction.  Specifically, if other files instantiate
+ * templates or use macros or inline functions from this file, or you compile
+ * this file and link it with other files to produce an executable, this
+ * file does not by itself cause the resulting executable to be covered by
+ * the GNU General Public License.  This exception does not however
+ * invalidate any other reasons why the executable file might be covered by
+ * the GNU General Public License.
+ *
  * Copyright 2003, 2004, 2005, 2006 Develer S.r.l. (http://www.develer.com/)
  * Copyright 1999 Bernardo Innocenti <bernie@develer.com>
- * This file is part of DevLib - See README.devlib for information.
- * -->
  *
- * \version $Id$
+ * -->
  *
  * \author Bernardo Innocenti <bernie@develer.com>
  * \author Stefano Fedrigo <aleph@develer.com>
@@ -14,45 +37,11 @@
  * \brief Bitmap manipulation routines.
  */
 
-/*#*
- *#* $Log$
- *#* Revision 1.10  2006/05/27 17:21:15  bernie
- *#* Factor out, simplify and document clipping.
- *#*
- *#* Revision 1.9  2006/05/25 23:35:40  bernie
- *#* Cleanup.
- *#*
- *#* Revision 1.8  2006/03/27 04:48:56  bernie
- *#* gfx_blitImage(): New function; gfx_blitRaster(): Fix clipping bug.
- *#*
- *#* Revision 1.7  2006/03/07 22:18:04  bernie
- *#* Correctly compute text width for prop fonts; Make styles a per-bitmap attribute.
- *#*
- *#* Revision 1.6  2006/02/23 11:17:16  bernie
- *#* Documentation fixes.
- *#*
- *#* Revision 1.5  2006/02/15 09:10:15  bernie
- *#* Implement prop fonts; Fix algo styles.
- *#*
- *#* Revision 1.4  2006/02/10 12:32:33  bernie
- *#* Add multiple font support in bitmaps; gfx_blitRaster(): New function.
- *#*
- *#* Revision 1.3  2006/01/26 00:36:48  bernie
- *#* Const correctness for some new functions.
- *#*
- *#* Revision 1.2  2006/01/24 21:55:43  aleph
- *#* gfx_blit_P(): use RASTER_SIZE() to calculate raster size
- *#*
- *#* Revision 1.1  2006/01/24 02:17:49  bernie
- *#* Split out gfx.c into bitmap.c and line.c.
- *#*
- *#*/
-
 #include "gfx.h"
 #include "gfx_p.h"
 
 #include <cfg/debug.h>  /* ASSERT() */
-#include <cfg/cpu.h>    /* CPU_HARVARD */
+#include <cpu/attr.h>   /* CPU_HARVARD */
 #include <cfg/macros.h> /* MIN() */
 #include <appconfig.h>  /* CONFIG_GFX_CLIPPING */
 
@@ -63,7 +52,7 @@
 #endif
 
 
-/*!
+/**
  * Initialize a Bitmap structure with the provided parameters.
  *
  * \note The pen position is reset to the origin.
@@ -97,7 +86,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.
@@ -105,7 +94,7 @@ void gfx_bitmapInit(Bitmap *bm, uint8_t *raster, coord_t w, coord_t h)
  */
 void gfx_bitmapClear(Bitmap *bm)
 {
-       memset(bm->raster, 0, RASTER_SIZE(bm->width, bm->height));
+       memset(bm->raster, 0, RAST_SIZE(bm->width, bm->height));
 }
 
 
@@ -113,7 +102,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.
  *
@@ -121,7 +110,7 @@ void gfx_bitmapClear(Bitmap *bm)
  */
 void gfx_blit_P(Bitmap *bm, const pgm_uint8_t *raster)
 {
-       memcpy_P(bm->raster, raster, RASTER_SIZE(bm->width, bm->height));
+       memcpy_P(bm->raster, raster, RAST_SIZE(bm->width, bm->height));
 }
 #endif /* CPU_HARVARD */
 
@@ -237,7 +226,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 +234,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)
 {