Use demo as default app.

[bertos.git] / gfx / gfx.h

diff --git a/gfx/gfx.h b/gfx/gfx.h
index 6e812a96e19a27e220b58db98bfa3bbac09c676d..2c48b27be5e5b934306c2a35e16a8944f4ae776b 100755 (executable)
--- a/gfx/gfx.h
+++ b/gfx/gfx.h
@@ -1,4 +1,4 @@
-/*!
+/**
  * \file
  * Copyright 2003, 2004, 2005, 2006 Develer S.r.l. (http://www.develer.com/)
  * Copyright 1999 Bernardo Innocenti <bernie@develer.com>
@@ -14,6 +14,24 @@
 
 /*#*
  *#* $Log$
+ *#* Revision 1.18  2006/08/01 12:45:01  bernie
+ *#* Remove Bitmap::cr when not needed.
+ *#*
+ *#* Revision 1.17  2006/07/19 12:56:26  bernie
+ *#* Convert to new Doxygen style.
+ *#*
+ *#* 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.
  *#*
@@ -67,11 +85,12 @@
 
 EXTERN_C_BEGIN
 
-/*! Common type for coordinates expressed in pixel units */
+/** 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 */
+/** Common type for coordinates expressed in logical units */
 typedef float vcoord_t;
 #endif /* CONFIG_GFX_VCOORDS */
 
@@ -117,17 +136,22 @@ 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 penX, penY;     /*!< Current pen position MoveTo()/LineTo() */
+       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 */
+#if CONFIG_GFX_CLIPPING || CONFIG_GFX_VCOORDS
+       Rect cr;                /**< Clip drawing inside this rectangle */
+#endif
 
 #if CONFIG_GFX_TEXT
        const struct Font *font;/**< Current font for text rendering. */
@@ -138,11 +162,14 @@ 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
+#endif /* CONFIG_GFX_TEXT */
+
 #if CONFIG_GFX_VCOORDS
-       /*!
+       /**
         * \name Logical coordinate system
         * \{
         */
@@ -160,29 +187,30 @@ typedef struct Bitmap
  */
 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. */
-};
+       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);