Doc fixes.

[bertos.git] / gfx / gfx.h

diff --git a/gfx/gfx.h b/gfx/gfx.h
old mode 100755 (executable)
new mode 100644 (file)
index 5fe1e30..a852c54
--- a/gfx/gfx.h
+++ b/gfx/gfx.h
@@ -1,8 +1,8 @@
-/*!
+/**
  * \file
  * 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$
  *
@@ -12,50 +12,11 @@
  * \brief General pourpose graphics routines
  */
 
-/*#*
- *#* $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.
- *#*
- *#* 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
 
 #include <cfg/compiler.h>
-#include <cfg/cpu.h>   /* CPU_HARVARD */
+#include <cpu/attr.h>   /* CPU_HARVARD */
 
 #include <appconfig.h> /* CONFIG_GFX_* */
 
@@ -79,12 +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 */
 
@@ -138,12 +99,14 @@ struct Font;
  */
 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. */
@@ -158,9 +121,10 @@ typedef struct Bitmap
         * \see text_style()
         */
        uint8_t styles;
-#endif
+#endif /* CONFIG_GFX_TEXT */
+
 #if CONFIG_GFX_VCOORDS
-       /*!
+       /**
         * \name Logical coordinate system
         * \{
         */
@@ -178,10 +142,10 @@ 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
@@ -201,8 +165,6 @@ typedef struct Image
        #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);