Doc fixes.
[bertos.git] / gfx / gfx.h
old mode 100755 (executable)
new mode 100644 (file)
index fb7e615..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$
  *
  * \brief General pourpose graphics routines
  */
 
-/*#*
- *#* $Log$
- *#* 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_* */
 
+/**
+ * \name Known pixel formats for bitmap representation.
+ * \{
+ */
+#define BITMAP_FMT_PLANAR_H_MSB  1  /**< Planar pixels, horizontal bytes, MSB left. */
+#define BITMAP_FMT_PLANAR_V_LSB  2  /**< Planar pixels, vertical bytes, LSB top. */
+/* \} */
+
 #if !defined(CONFIG_BITMAP_FMT) || (CONFIG_BITMAP_FMT != BITMAP_FMT_PLANAR_H_MSB && CONFIG_BITMAP_FMT != BITMAP_FMT_PLANAR_V_LSB)
        #error CONFIG_BITMAP_FMT must be defined to either BITMAP_FMT_PLANAR_H_LSB or BITMAP_FMT_PLANAR_V_LSB
 #endif
        #error CONFIG_GFX_TEXT must be defined to either 0 or 1
 #endif
 
-/**
- * \name Known pixel formats for bitmap representation.
- * \{
- */
-#define BITMAP_FMT_PLANAR_H_MSB  1  /**< Planar pixels, horizontal bytes, MSB left. */
-#define BITMAP_FMT_PLANAR_V_LSB  2  /**< Planar pixels, vertical bytes, LSB top. */
-/* \} */
-
 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 */
 
@@ -108,23 +91,40 @@ 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. */
-#endif
+
+       /**
+        * Algorithmic text style flags.
+        *
+        * 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 /* CONFIG_GFX_TEXT */
+
 #if CONFIG_GFX_VCOORDS
-       /*!
+       /**
         * \name Logical coordinate system
         * \{
         */
@@ -135,29 +135,42 @@ 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 */
 
-
 /* 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);