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