X-Git-Url: https://codewiz.org/gitweb?a=blobdiff_plain;f=gfx%2Fgfx.h;h=ef4588fc858251ecfb36b431c89210c85c0735f3;hb=5f3952176a4e9a00ca8dd5ec4a6b994958f89e0a;hp=6e812a96e19a27e220b58db98bfa3bbac09c676d;hpb=26633abe9295e935a4645aa2447cdbcdd499006f;p=bertos.git

diff --git a/gfx/gfx.h b/gfx/gfx.h
old mode 100755
new mode 100644
index 6e812a96..ef4588fc
--- 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>
@@ -12,33 +12,6 @@
  * \brief General pourpose graphics routines
  */
 
-/*#*
- *#* $Log$
- *#* 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.
- *#*
- *#* Revision 1.10  2006/02/17 22:24:40  bernie
- *#* Fix undefined preprocessor symbol.
- *#*
- *#* Revision 1.9  2006/02/15 09:10:15  bernie
- *#* Implement prop fonts; Fix algo styles.
- *#*
- *#* Revision 1.8  2006/02/10 12:28:33  bernie
- *#* Add font support in bitmaps; Make bitmap formats public.
- *#*
- *#* 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.
- *#*/
-
 #ifndef GFX_GFX_H
 #define GFX_GFX_H
 
@@ -67,11 +40,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 +91,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 +117,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,30 +142,29 @@ 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 */
 
-
 /* Function prototypes */
 void gfx_bitmapInit (Bitmap *bm, uint8_t *raster, coord_t w, coord_t h);
 void gfx_bitmapClear(Bitmap *bm);