Clarify side-effects in documentation.

[bertos.git] / mware / gfx.h

diff --git a/mware/gfx.h b/mware/gfx.h
index 16f34e6fc19d7311fecb4cf5150434be99298e1d..792a49c39bd7b864b9c0792f9515a531da362e9f 100755 (executable)
--- a/mware/gfx.h
+++ b/mware/gfx.h
@@ -1,8 +1,8 @@
 /*!
  * \file
+ * Copyright (C) 2003,2004 Develer S.r.l. (http://www.develer.com/)
  * Copyright (C) 1999 Bernardo Innocenti <bernie@develer.com>
- * Copyright (C) 2003 Develer S.r.l. (http://www.develer.com/)
- * All Rights Reserved.
+ * This file is part of DevLib - See devlib/README for information.
  *
  * \version $Id$
  *
@@ -12,46 +12,59 @@
  * \brief General pourpose graphics routines
  */
 
-/*
- * $Log$
- * Revision 1.1  2004/05/23 15:43:16  bernie
- * Import mware modules.
- *
- * Revision 1.4  2004/02/09 00:21:28  aleph
- * Various gfx fixes
- *
- * Revision 1.3  2004/01/27 23:24:19  aleph
- * Add new graphics primitives
- *
- * Revision 1.2  2004/01/07 23:33:01  aleph
- * Change copyright email
- *
- * Revision 1.1  2004/01/07 19:05:31  aleph
- * Add graphics routines
- *
- */
-
-#ifndef GFX_H
-#define GFX_H
-
-#include "compiler.h"
-#include <avr/pgmspace.h>
+/*#*
+ *#* $Log$
+ *#* Revision 1.5  2004/08/25 14:12:09  rasky
+ *#* Aggiornato il comment block dei log RCS
+ *#*
+ *#* 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.
+ *#*
+ *#* Revision 1.4  2004/02/09 00:21:28  aleph
+ *#* Various gfx fixes
+ *#*
+ *#* Revision 1.3  2004/01/27 23:24:19  aleph
+ *#* Add new graphics primitives
+ *#*
+ *#* Revision 1.2  2004/01/07 23:33:01  aleph
+ *#* Change copyright email
+ *#*
+ *#* Revision 1.1  2004/01/07 19:05:31  aleph
+ *#* Add graphics routines
+ *#*
+ *#*/
+
+#ifndef MWARE_GFX_H
+#define MWARE_GFX_H
+
+#include <compiler.h>
+#include <config.h>
 
 
 /*! Common type for coordinates expressed in pixel units */
 typedef int coord_t;
 
-#ifdef CONFIG_LCD_VCOORDS
+#if CONFIG_GFX_VCOORDS
 /*! Common type for coordinates expressed in logical units */
 typedef float vcoord_t;
-#endif /* CONFIG_LCD_VCOORDS */
+#endif /* CONFIG_GFX_VCOORDS */
 
 
 typedef struct Rect { coord_t xmin, ymin, xmax, ymax; } Rect;
 
 
-/*! Control structure to draw in a bitmap */
-
+/*!
+ * Control structure to draw in a bitmap
+ */
 typedef struct Bitmap
 {
        uint8_t *raster;        /*!< Pointer to byte array to hold the data */
@@ -60,11 +73,15 @@ typedef struct Bitmap
 
        Rect cr;                /*!< Clip drawing inside this rectangle */
 
-#ifdef CONFIG_LCD_VCOORDS
-       /*! Logical coordinate system */
+#if CONFIG_GFX_VCOORDS
+       /*!
+        * \name Logical coordinate system
+        * \{
+        */
        vcoord_t orgX, orgY;
        vcoord_t scaleX, scaleY;
-#endif /* CONFIG_LCD_VCOORDS */
+       /*\}*/
+#endif /* CONFIG_GFX_VCOORDS */
 
 } Bitmap;
 
@@ -81,11 +98,11 @@ extern void gfx_MoveTo(Bitmap *bm, coord_t x, coord_t y);
 extern void gfx_LineTo(Bitmap *bm, coord_t x, coord_t y);
 extern void gfx_SetClipRect(Bitmap *bm, coord_t xmin, coord_t ymin, coord_t xmax, coord_t ymax);
 
-#ifdef CONFIG_LCD_VCOORDS
+#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);
 extern coord_t gfx_TransformY(Bitmap *bm, vcoord_t y);
 extern void gfx_VDrawLine(Bitmap *bm, vcoord_t x1, vcoord_t y1, vcoord_t x2, vcoord_t y2);
-#endif /* CONFIG_LCD_VCOORDS */
+#endif /* CONFIG_GFX_VCOORDS */
 
-#endif /* GFX_H */
+#endif /* MWARE_GFX_H */