Optimize away divisions in RAST_ADDR/MASK macros.

[bertos.git] / gfx / gfx.h

diff --git a/gfx/gfx.h b/gfx/gfx.h
index 324c7c59b97c272ae049491eb0116e20b65e393a..5fe1e30016153f7ae0b1818acad099f014d3f942 100755 (executable)
--- a/gfx/gfx.h
+++ b/gfx/gfx.h
@@ -14,6 +14,21 @@
 
 /*#*
  *#* $Log$
+ *#* Revision 1.16  2006/05/27 17:17:34  bernie
+ *#* Optimize away divisions in RAST_ADDR/MASK macros.
+ *#*
+ *#* Revision 1.15  2006/05/25 23:35:40  bernie
+ *#* Cleanup.
+ *#*
+ *#* Revision 1.14  2006/04/27 05:39:24  bernie
+ *#* Enhance text rendering to arbitrary x,y coords.
+ *#*
+ *#* Revision 1.13  2006/04/11 00:08:24  bernie
+ *#* text_offset(): New function, but I'm not quite confident with the design.
+ *#*
+ *#* Revision 1.12  2006/03/27 04:48:56  bernie
+ *#* gfx_blitImage(): New function; gfx_blitRaster(): Fix clipping bug.
+ *#*
  *#* Revision 1.11  2006/03/07 22:18:04  bernie
  *#* Correctly compute text width for prop fonts; Make styles a per-bitmap attribute.
  *#*
@@ -66,6 +81,7 @@ EXTERN_C_BEGIN
 
 /*! Common type for coordinates expressed in pixel units */
 typedef int coord_t;
+typedef unsigned int ucoord_t;
 
 #if CONFIG_GFX_VCOORDS
 /*! Common type for coordinates expressed in logical units */
@@ -114,14 +130,17 @@ typedef struct Rect { coord_t xmin, ymin, xmax, ymax; } Rect;
 /* Fwd decl */
 struct Font;
 
-/*!
+/**
  * Control structure to draw in a bitmap
+ *
+ * \todo For better ortogonality, split this structure into
+ *       an Image and a plain drawing context called Painter.
  */
 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 stride;         /*!< Bytes per row. */
        coord_t penX, penY;     /*!< Current pen position MoveTo()/LineTo() */
 
        Rect cr;                /*!< Clip drawing inside this rectangle */
@@ -135,6 +154,8 @@ typedef struct Bitmap
         * The text rendering routine can apply a few simple transformations
         * to the current font in order to generate common styles such as
         * bold, italic and underline from plain glyphs.
+        *
+        * \see text_style()
         */
        uint8_t styles;
 #endif
@@ -150,29 +171,44 @@ typedef struct Bitmap
 
 } Bitmap;
 
+/**
+ * Hold image pixels.
+ *
+ * \todo Use this as Bitmap and change Bitmap to Drawable.
+ */
+typedef struct Image
+{
+       const uint8_t *raster;   /*!< Pointer to byte array to hold the data. */
+       coord_t width;     /*!< Raster width in pixels. */
+       coord_t height;    /*!< Raster height in pixels. */
+       coord_t stride;    /*!< Bytes per row. */
+} Image;
+
 #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) )
+       #define RAST_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) )
+       #define RAST_SIZE(width, height) ( (width) * (((height) + 7) / 8) )
 #else
        #error Unknown value of CONFIG_BITMAP_FMT
 #endif /* CONFIG_BITMAP_FMT */
 
+#define RASTER_SIZE RAST_SIZE /* OBSOLETE */
 
 /* Function prototypes */
 void gfx_bitmapInit (Bitmap *bm, uint8_t *raster, coord_t w, coord_t h);
 void gfx_bitmapClear(Bitmap *bm);
 void gfx_blit       (Bitmap *dst, const Rect *rect, const Bitmap *src, coord_t srcx, coord_t srcy);
 void gfx_blitRaster (Bitmap *dst, coord_t dx, coord_t dy, const uint8_t *raster, coord_t w, coord_t h, coord_t stride);
+void gfx_blitImage  (Bitmap *dst, coord_t dx, coord_t dy, const Image *image);
 void gfx_line       (Bitmap *bm, coord_t x1, coord_t y1, coord_t x2, coord_t y2);
 void gfx_rectDraw   (Bitmap *bm, coord_t x1, coord_t y1, coord_t x2, coord_t y2);
 void gfx_rectFillC  (Bitmap *bm, coord_t x1, coord_t y1, coord_t x2, coord_t y2, uint8_t color);