gfx/gfx.h

   1 /*!
   2  * \file
   3  * Copyright 2003, 2004, 2005, 2006 Develer S.r.l. (http://www.develer.com/)
   4  * Copyright 1999 Bernardo Innocenti <bernie@develer.com>
   5  * This file is part of DevLib - See README.devlib for information.
   6  *
   7  * \version $Id$
   8  *
   9  * \author Bernardo Innocenti <bernie@develer.com>
  10  * \author Stefano Fedrigo <aleph@develer.com>
  11  *
  12  * \brief General pourpose graphics routines
  13  */
  14
  15 /*#*
  16  *#* $Log$
  17  *#* Revision 1.13  2006/04/11 00:08:24  bernie
  18  *#* text_offset(): New function, but I'm not quite confident with the design.
  19  *#*
  20  *#* Revision 1.12  2006/03/27 04:48:56  bernie
  21  *#* gfx_blitImage(): New function; gfx_blitRaster(): Fix clipping bug.
  22  *#*
  23  *#* Revision 1.11  2006/03/07 22:18:04  bernie
  24  *#* Correctly compute text width for prop fonts; Make styles a per-bitmap attribute.
  25  *#*
  26  *#* Revision 1.10  2006/02/17 22:24:40  bernie
  27  *#* Fix undefined preprocessor symbol.
  28  *#*
  29  *#* Revision 1.9  2006/02/15 09:10:15  bernie
  30  *#* Implement prop fonts; Fix algo styles.
  31  *#*
  32  *#* Revision 1.8  2006/02/10 12:28:33  bernie
  33  *#* Add font support in bitmaps; Make bitmap formats public.
  34  *#*
  35  *#* Revision 1.7  2006/01/26 00:36:48  bernie
  36  *#* Const correctness for some new functions.
  37  *#*
  38  *#* Revision 1.6  2006/01/23 23:13:04  bernie
  39  *#* RECT_WIDTH(), RECT_HEIGHT(), RASTER_SIZE(): New macros.
  40  *#*
  41  *#* Revision 1.5  2006/01/17 02:31:29  bernie
  42  *#* Add bitmap format support; Improve some comments.
  43  *#*/
  44
  45 #ifndef GFX_GFX_H
  46 #define GFX_GFX_H
  47
  48 #include <cfg/compiler.h>
  49 #include <cfg/cpu.h>   /* CPU_HARVARD */
  50
  51 #include <appconfig.h> /* CONFIG_GFX_* */
  52
  53 /**
  54  * \name Known pixel formats for bitmap representation.
  55  * \{
  56  */
  57 #define BITMAP_FMT_PLANAR_H_MSB  1  /**< Planar pixels, horizontal bytes, MSB left. */
  58 #define BITMAP_FMT_PLANAR_V_LSB  2  /**< Planar pixels, vertical bytes, LSB top. */
  59 /* \} */
  60
  61 #if !defined(CONFIG_BITMAP_FMT) || (CONFIG_BITMAP_FMT != BITMAP_FMT_PLANAR_H_MSB && CONFIG_BITMAP_FMT != BITMAP_FMT_PLANAR_V_LSB)
  62         #error CONFIG_BITMAP_FMT must be defined to either BITMAP_FMT_PLANAR_H_LSB or BITMAP_FMT_PLANAR_V_LSB
  63 #endif
  64 #if !defined(CONFIG_GFX_CLIPPING) || (CONFIG_GFX_CLIPPING != 0 && CONFIG_GFX_CLIPPING != 1)
  65         #error CONFIG_GFX_CLIPPING must be defined to either 0 or 1
  66 #endif
  67 #if !defined(CONFIG_GFX_TEXT) || (CONFIG_GFX_TEXT != 0 && CONFIG_GFX_TEXT != 1)
  68         #error CONFIG_GFX_TEXT must be defined to either 0 or 1
  69 #endif
  70
  71 EXTERN_C_BEGIN
  72
  73 /*! Common type for coordinates expressed in pixel units */
  74 typedef int coord_t;
  75
  76 #if CONFIG_GFX_VCOORDS
  77 /*! Common type for coordinates expressed in logical units */
  78 typedef float vcoord_t;
  79 #endif /* CONFIG_GFX_VCOORDS */
  80
  81
  82 /**
  83  * Describe a rectangular area with coordinates expressed in pixels.
  84  *
  85  * The rectangle is represented in terms of its top/left and
  86  * right/bottom borders.
  87  *
  88  * In some cases, rectangles are assumed to obey to the
  89  * following invariants:
  90  *
  91  *    xmin <= xmax
  92  *    ymin <= ymax
  93  *
  94  * Oddly, the xmin and ymin coordinates are inclusive, while the
  95  * xmax and ymax coordinates are non-inclusive.  This design
  96  * decision makes several computations simpler and lets you
  97  * specify empty (0x0) rectangles without breaking the
  98  * invariants.
  99  *
 100  * Computing the size of a rectangle can be done by simply
 101  * subtracting the maximum X or Y coordinate from the minimum
 102  * X or Y coordinate.
 103  */
 104 typedef struct Rect { coord_t xmin, ymin, xmax, ymax; } Rect;
 105
 106 /**
 107  * Return the width of a rectangle in pixels.
 108  *
 109  * \note The argument \a r is evaluated twice.
 110  */
 111 #define RECT_WIDTH(r)   ((r)->xmax - (r)->xmin)
 112
 113 /**
 114  * Return the height of a rectangle in pixels.
 115  *
 116  * \note The argument \a r is evaluated twice.
 117  */
 118 #define RECT_HEIGHT(r)  ((r)->ymax - (r)->ymin)
 119
 120 /* Fwd decl */
 121 struct Font;
 122
 123 /*!
 124  * Control structure to draw in a bitmap
 125  */
 126 typedef struct Bitmap
 127 {
 128         uint8_t *raster;        /*!< Pointer to byte array to hold the data */
 129         coord_t width, height;  /*!< Width/Height in pixels */
 130         coord_t stride;         /*!< Bytes per row. */
 131         coord_t penX, penY;     /*!< Current pen position MoveTo()/LineTo() */
 132
 133         Rect cr;                /*!< Clip drawing inside this rectangle */
 134
 135 #if CONFIG_GFX_TEXT
 136         const struct Font *font;/**< Current font for text rendering. */
 137
 138         /**
 139          * Algorithmic text style flags.
 140          *
 141          * The text rendering routine can apply a few simple transformations
 142          * to the current font in order to generate common styles such as
 143          * bold, italic and underline from plain glyphs.
 144          */
 145         uint8_t styles;
 146 #endif
 147 #if CONFIG_GFX_VCOORDS
 148         /*!
 149          * \name Logical coordinate system
 150          * \{
 151          */
 152         vcoord_t orgX, orgY;
 153         vcoord_t scaleX, scaleY;
 154         /*\}*/
 155 #endif /* CONFIG_GFX_VCOORDS */
 156
 157 } Bitmap;
 158
 159 /**
 160  * Hold image pixels.
 161  *
 162  * \todo Use this as Bitmap and change Bitmap to Drawable.
 163  */
 164 typedef struct Image
 165 {
 166         const uint8_t *raster;   /*!< Pointer to byte array to hold the data. */
 167         coord_t width;     /*!< Raster width in pixels. */
 168         coord_t height;    /*!< Raster height in pixels. */
 169         coord_t stride;    /*!< Bytes per row. */
 170 } Image;
 171
 172 #if CONFIG_BITMAP_FMT == BITMAP_FMT_PLANAR_H_MSB
 173         /**
 174          * Compute the size in bytes of a raster suitable for
 175          * holding a bitmap of \a width x \a height pixels.
 176          */
 177         #define RASTER_SIZE(width, height) ( ((width) + 7 / 8) * (height) )
 178
 179 #elif CONFIG_BITMAP_FMT == BITMAP_FMT_PLANAR_V_LSB
 180         /**
 181          * Compute the size in bytes of a raster suitable for
 182          * holding a bitmap of \a width x \a height pixels.
 183          */
 184         #define RASTER_SIZE(width, height) ( (width) * (((height) + 7) / 8) )
 185 #else
 186         #error Unknown value of CONFIG_BITMAP_FMT
 187 #endif /* CONFIG_BITMAP_FMT */
 188
 189
 190 /* Function prototypes */
 191 void gfx_bitmapInit (Bitmap *bm, uint8_t *raster, coord_t w, coord_t h);
 192 void gfx_bitmapClear(Bitmap *bm);
 193 void gfx_blit       (Bitmap *dst, const Rect *rect, const Bitmap *src, coord_t srcx, coord_t srcy);
 194 void gfx_blitRaster (Bitmap *dst, coord_t dx, coord_t dy, const uint8_t *raster, coord_t w, coord_t h, coord_t stride);
 195 void gfx_blitImage  (Bitmap *dst, coord_t dx, coord_t dy, const Image *image);
 196 void gfx_line       (Bitmap *bm, coord_t x1, coord_t y1, coord_t x2, coord_t y2);
 197 void gfx_rectDraw   (Bitmap *bm, coord_t x1, coord_t y1, coord_t x2, coord_t y2);
 198 void gfx_rectFillC  (Bitmap *bm, coord_t x1, coord_t y1, coord_t x2, coord_t y2, uint8_t color);
 199 void gfx_rectFill   (Bitmap *bm, coord_t x1, coord_t y1, coord_t x2, coord_t y2);
 200 void gfx_rectClear  (Bitmap *bm, coord_t x1, coord_t y1, coord_t x2, coord_t y2);
 201 void gfx_moveTo     (Bitmap *bm, coord_t x,  coord_t y);
 202 void gfx_lineTo     (Bitmap *bm, coord_t x,  coord_t y);
 203 void gfx_setClipRect(Bitmap *bm, coord_t xmin, coord_t ymin, coord_t xmax, coord_t ymax);
 204
 205 #if CPU_HARVARD
 206         #include <mware/pgm.h>
 207         void gfx_blit_P(Bitmap *bm, const pgm_uint8_t *raster);
 208 #endif
 209
 210 #if CONFIG_GFX_TEXT
 211 INLINE void gfx_setFont(Bitmap *bm, const struct Font *font)
 212 {
 213         bm->font = font;
 214 }
 215 #endif
 216
 217 #if CONFIG_GFX_VCOORDS
 218 void gfx_setViewRect(Bitmap *bm, vcoord_t x1, vcoord_t y1, vcoord_t x2, vcoord_t y2);
 219 coord_t gfx_transformX(Bitmap *bm, vcoord_t x);
 220 coord_t gfx_transformY(Bitmap *bm, vcoord_t y);
 221 void gfx_vline(Bitmap *bm, vcoord_t x1, vcoord_t y1, vcoord_t x2, vcoord_t y2);
 222 #endif /* CONFIG_GFX_VCOORDS */
 223
 224 EXTERN_C_END
 225
 226 #endif /* GFX_GFX_H */