Doc fixes.
[bertos.git] / gfx / bitmap.c
old mode 100755 (executable)
new mode 100644 (file)
index e99a254..d4c447e
@@ -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>
  * \brief Bitmap manipulation routines.
  */
 
-/*#*
- *#* $Log$
- *#* 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 */
 
@@ -54,7 +52,7 @@
 #endif
 
 
-/*!
+/**
  * Initialize a Bitmap structure with the provided parameters.
  *
  * \note The pen position is reset to the origin.
@@ -88,14 +86,15 @@ 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.
+ * \note This function bypasses the current clipping area.
  */
 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));
 }
 
 
@@ -103,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.
  *
@@ -111,10 +110,38 @@ 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 */
 
+#if CONFIG_GFX_CLIPPING
+       /**
+        * Clip destination coordinates inside a clipping range.
+        *
+        * This macro helps a drawing operation to adjust its
+        * destination X and Y coordinates inside the destination
+        * clipping range.
+        *
+        * The source start coordinate is adjusted as well
+        * when destination start clipping occurs.
+        */
+       #define gfx_clip(dmin, dmax, smin, cmin, cmax) \
+               do { \
+                       if ((dmin) < (cmin)) \
+                       { \
+                               (smin) += (cmin) - (dmin); \
+                               (dmin) = (cmin); \
+                       } \
+                       (dmax) = MIN((dmax), (cmax)); \
+               } while(0)
+
+#else /* !CONFIG_GFX_CLIPPING */
+
+       #define gfx_clip(dmin, dmax, smin, cmin, cmax) do { } while (0)
+
+#endif /* !CONFIG_GFX_CLIPPING */
+
+
 /**
  * Copy a rectangular area of a bitmap on another bitmap.
  *
@@ -138,22 +165,19 @@ void gfx_blit(Bitmap *dst, const Rect *rect, const Bitmap *src, coord_t srcx, co
        coord_t dx, dy, sx, sy;
 
        /*
-        * Clip coordinates inside dst->cr and src->width/height.
+        * Pre-clip coordinates inside src->width/height.
         */
        dxmin = rect->xmin;
-       if (dxmin < dst->cr.xmin)
-       {
-               srcx += dst->cr.xmin - dxmin;
-               dxmin = dst->cr.xmin;
-       }
        dymin = rect->ymin;
-       if (dymin < dst->cr.ymin)
-       {
-               srcy += dst->cr.ymin - dymin;
-               dymin = dst->cr.ymin;
-       }
-       dxmax = MIN(MIN(rect->xmax, rect->xmin + src->width), dst->cr.xmax);
-       dymax = MIN(MIN(rect->ymax, rect->ymin + src->height), dst->cr.ymax);
+       dxmax = MIN(rect->xmax, rect->xmin + src->width);
+       dymax = MIN(rect->ymax, rect->ymin + src->height);
+
+       /* Perform regular clipping */
+       gfx_clip(dxmin, dxmax, srcx, dst->cr.xmin, dst->cr.xmax);
+       gfx_clip(dymin, dymax, srcy, dst->cr.ymin, dst->cr.ymax);
+
+       //kprintf("dxmin=%d, sxmin=%d, dxmax=%d; ", dxmin, sxmin, dxmax);
+       //kprintf("dymin=%d, symin=%d, dymax=%d\n", dymin, symin, dymax);
 
        /* TODO: make it not as dog slow as this */
        for (dx = dxmin, sx = srcx; dx < dxmax; ++dx, ++sx)
@@ -161,28 +185,26 @@ void gfx_blit(Bitmap *dst, const Rect *rect, const Bitmap *src, coord_t srcx, co
                        BM_DRAWPIXEL(dst, dx, dy, BM_READPIXEL(src, sx, sy));
 }
 
-
-void gfx_blitRaster(Bitmap *dst, coord_t dxmin, coord_t dymin, const uint8_t *raster, coord_t w, coord_t h, coord_t stride)
+/**
+ * Blit a raster to a Bitmap.
+ *
+ * \todo Merge this function into gfx_blit()
+ *
+ * \see gfx_blit()
+ */
+void gfx_blitRaster(Bitmap *dst, coord_t dxmin, coord_t dymin,
+               const uint8_t *raster, coord_t w, coord_t h, coord_t stride)
 {
-       coord_t dxmax, dymax;
+       coord_t dxmax = dxmin + w, dymax = dymin + h;
        coord_t sxmin = 0, symin = 0;
        coord_t dx, dy, sx, sy;
 
-       /*
-        * Clip coordinates inside dst->cr.
-        */
-       if (dxmin < dst->cr.xmin)
-       {
-               sxmin += dst->cr.xmin - dxmin;
-               dxmin = dst->cr.xmin;
-       }
-       if (dymin < dst->cr.ymin)
-       {
-               symin += dst->cr.ymin - dymin;
-               dymin = dst->cr.ymin;
-       }
-       dxmax = MIN(dxmin + w, dst->cr.xmax);
-       dymax = MIN(dymin + h, dst->cr.ymax);
+       /* Perform regular clipping */
+       gfx_clip(dxmin, dxmax, sxmin, dst->cr.xmin, dst->cr.xmax);
+       gfx_clip(dymin, dymax, symin, dst->cr.ymin, dst->cr.ymax);
+
+       //kprintf("dxmin=%d, sxmin=%d, dxmax=%d; ", dxmin, sxmin, dxmax);
+       //kprintf("dymin=%d, symin=%d, dymax=%d\n", dymin, symin, dymax);
 
        /* TODO: make it not as dog slow as this */
        for (dx = dxmin, sx = sxmin; dx < dxmax; ++dx, ++sx)
@@ -190,16 +212,36 @@ void gfx_blitRaster(Bitmap *dst, coord_t dxmin, coord_t dymin, const uint8_t *ra
                        BM_DRAWPIXEL(dst, dx, dy, RAST_READPIXEL(raster, sx, sy, stride));
 }
 
+/**
+ * Blit an Image to a Bitmap.
+ *
+ * \see gfx_blit()
+ */
+void gfx_blitImage(Bitmap *dst, coord_t dxmin, coord_t dymin, const Image *image)
+{
+       ASSERT(image);
+
+       gfx_blitRaster(dst, dxmin, dymin,
+                       image->raster, image->width, image->height, image->stride);
+}
+
+
+#if CONFIG_GFX_CLIPPING || CONFIG_GFX_VCOORDS
 
-/*!
+/**
  * Set the bitmap clipping rectangle to the specified coordinates.
  *
  * All drawing performed on the bitmap will be clipped inside this
  * rectangle.
  *
- * \note Following the convention used in all other operations, the
+ * 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)
 {
@@ -215,8 +257,9 @@ void gfx_setClipRect(Bitmap *bm, coord_t minx, coord_t miny, coord_t maxx, coord
        bm->cr.xmax = maxx;
        bm->cr.ymax = maxy;
 
-/*     kprintf("cr.xmin = %d, cr.ymin = %d, cr.xmax = %d, cr.ymax = %d\n",
-               bm->cr.xMin, bm->cr.ymin, bm->cr.xmax, bm->cr.ymax);
-*/
+//     kprintf("cr.xmin = %d, cr.ymin = %d, cr.xmax = %d, cr.ymax = %d\n",
+//             bm->cr.xMin, bm->cr.ymin, bm->cr.xmax, bm->cr.ymax);
 }
 
+#endif /* CONFIG_GFX_CLIPPING */
+