Add missing header.

[bertos.git] / gfx / gfx.h

diff --git a/gfx/gfx.h b/gfx/gfx.h
index 788bd69f3acf7577886481ed62c2d2128a6bd143..80c477abac81b0cedabaaa6b83c86e75f68e6369 100755 (executable)
--- a/gfx/gfx.h
+++ b/gfx/gfx.h
@@ -1,6 +1,6 @@
 /*!
  * \file
- * Copyright 2003, 2004 Develer S.r.l. (http://www.develer.com/)
+ * Copyright 2003, 2004, 2005 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.
  *
@@ -14,6 +14,24 @@
 
 /*#*
  *#* $Log$
+ *#* Revision 1.7  2006/01/26 00:36:48  bernie
+ *#* Const correctness for some new functions.
+ *#*
+ *#* Revision 1.6  2006/01/23 23:13:04  bernie
+ *#* RECT_WIDTH(), RECT_HEIGHT(), RASTER_SIZE(): New macros.
+ *#*
+ *#* Revision 1.5  2006/01/17 02:31:29  bernie
+ *#* Add bitmap format support; Improve some comments.
+ *#*
+ *#* Revision 1.4  2006/01/16 03:30:57  bernie
+ *#* Make header C++ friendly.
+ *#*
+ *#* Revision 1.3  2005/11/27 23:33:40  bernie
+ *#* Use appconfig.h instead of cfg/config.h.
+ *#*
+ *#* Revision 1.2  2005/11/04 18:17:45  bernie
+ *#* Fix header guards and includes for new location of gfx module.
+ *#*
  *#* Revision 1.1  2005/11/04 18:11:35  bernie
  *#* Move graphics stuff from mware/ to gfx/.
  *#*
@@ -28,36 +46,16 @@
  *#*
  *#* Revision 1.9  2005/01/20 18:46:31  aleph
  *#* Fix progmem includes.
- *#*
- *#* Revision 1.8  2004/11/01 15:14:07  bernie
- *#* Update to current coding conventions.
- *#*
- *#* Revision 1.7  2004/09/20 03:29:06  bernie
- *#* Conditionalize AVR-specific code.
- *#*
- *#* Revision 1.6  2004/09/14 21:01:08  bernie
- *#* Rename rectangle drawing functions; Unify filled/cleared implementations.
- *#*
- *#* Revision 1.4  2004/08/10 07:00:16  bernie
- *#* Add missing header.
- *#*
- *#* Revision 1.3  2004/08/04 03:16:59  bernie
- *#* Switch to new DevLib CONFIG_ convention.
- *#*
- *#* Revision 1.2  2004/06/03 11:27:09  bernie
- *#* Add dual-license information.
- *#*
- *#* Revision 1.1  2004/05/23 15:43:16  bernie
- *#* Import mware modules.
  *#*/
 
-#ifndef MWARE_GFX_H
-#define MWARE_GFX_H
+#ifndef GFX_GFX_H
+#define GFX_GFX_H
 
-#include <cfg/config.h>
+#include <appconfig.h>
 #include <cfg/compiler.h>
 #include <cfg/cpu.h>
 
+EXTERN_C_BEGIN
 
 /*! Common type for coordinates expressed in pixel units */
 typedef int coord_t;
@@ -68,8 +66,44 @@ typedef float vcoord_t;
 #endif /* CONFIG_GFX_VCOORDS */
 
 
+/**
+ * Describe a rectangular area with coordinates expressed in pixels.
+ *
+ * The rectangle is represented in terms of its top/left and
+ * right/bottom borders.
+ *
+ * In some cases, rectangles are assumed to obey to the
+ * following invariants:
+ *
+ *    xmin <= xmax
+ *    ymin <= ymax
+ *
+ * Oddly, the xmin and ymin coordinates are inclusive, while the
+ * xmax and ymax coordinates are non-inclusive.  This design
+ * decision makes several computations simpler and lets you
+ * specify empty (0x0) rectangles without breaking the
+ * invariants.
+ *
+ * Computing the size of a rectangle can be done by simply
+ * subtracting the maximum X or Y coordinate from the minimum
+ * X or Y coordinate.
+ */
 typedef struct Rect { coord_t xmin, ymin, xmax, ymax; } Rect;
 
+/**
+ * Return the width of a rectangle in pixels.
+ *
+ * \note The argument \a r is evaluated twice.
+ */
+#define RECT_WIDTH(r)   ((r)->xmax - (r)->xmin)
+
+/**
+ * Return the height of a rectangle in pixels.
+ *
+ * \note The argument \a r is evaluated twice.
+ */
+#define RECT_HEIGHT(r)  ((r)->ymax - (r)->ymin)
+
 
 /*!
  * Control structure to draw in a bitmap
@@ -78,6 +112,7 @@ typedef struct Bitmap
 {
        uint8_t *raster;        /*!< Pointer to byte array to hold the data */
        coord_t width, height;  /*!< Width/Height in pixels */
+       coord_t stride;         /*!< Bytes per row. */
        coord_t penX, penY;     /*!< Current pen position MoveTo()/LineTo() */
 
        Rect cr;                /*!< Clip drawing inside this rectangle */
@@ -94,10 +129,28 @@ typedef struct Bitmap
 
 } Bitmap;
 
+#if CONFIG_BITMAP_FMT == BITMAP_FMT_PLANAR_H_MSB
+       /**
+        * Compute the size in bytes of a raster suitable for
+        * holding a bitmap of \a width x \a height pixels.
+        */
+       #define RASTER_SIZE(width, height) ( ((width) + 7 / 8) * (height) )
+
+#elif CONFIG_BITMAP_FMT == BITMAP_FMT_PLANAR_V_LSB
+       /**
+        * Compute the size in bytes of a raster suitable for
+        * holding a bitmap of \a width x \a height pixels.
+        */
+       #define RASTER_SIZE(width, height) ( (width) * (((height) + 7) / 8) )
+#else
+       #error Unknown value of CONFIG_BITMAP_FMT
+#endif /* CONFIG_BITMAP_FMT */
+
 
 /* Function prototypes */
 extern void gfx_bitmapInit (Bitmap *bm, uint8_t *raster, coord_t w, coord_t h);
 extern void gfx_bitmapClear(Bitmap *bm);
+extern void gfx_blit       (Bitmap *dst, const Rect *rect, const Bitmap *src, coord_t srcx, coord_t srcy);
 extern void gfx_line       (Bitmap *bm, coord_t x1, coord_t y1, coord_t x2, coord_t y2);
 extern void gfx_rectDraw   (Bitmap *bm, coord_t x1, coord_t y1, coord_t x2, coord_t y2);
 extern void gfx_rectFillC  (Bitmap *bm, coord_t x1, coord_t y1, coord_t x2, coord_t y2, uint8_t color);
@@ -112,7 +165,6 @@ extern void gfx_setClipRect(Bitmap *bm, coord_t xmin, coord_t ymin, coord_t xmax
        extern void gfx_blit_P(Bitmap *bm, const pgm_uint8_t *raster);
 #endif
 
-
 #if CONFIG_GFX_VCOORDS
 extern void gfx_setViewRect(Bitmap *bm, vcoord_t x1, vcoord_t y1, vcoord_t x2, vcoord_t y2);
 extern coord_t gfx_transformX(Bitmap *bm, vcoord_t x);
@@ -120,4 +172,6 @@ extern coord_t gfx_transformY(Bitmap *bm, vcoord_t y);
 extern void gfx_vline(Bitmap *bm, vcoord_t x1, vcoord_t y1, vcoord_t x2, vcoord_t y2);
 #endif /* CONFIG_GFX_VCOORDS */
 
-#endif /* MWARE_GFX_H */
+EXTERN_C_END
+
+#endif /* GFX_GFX_H */