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.
9 * \author Bernardo Innocenti <bernie@develer.com>
10 * \author Stefano Fedrigo <aleph@develer.com>
12 * \brief General pourpose graphics routines
17 *#* Revision 1.16 2006/05/27 17:17:34 bernie
18 *#* Optimize away divisions in RAST_ADDR/MASK macros.
20 *#* Revision 1.15 2006/05/25 23:35:40 bernie
23 *#* Revision 1.14 2006/04/27 05:39:24 bernie
24 *#* Enhance text rendering to arbitrary x,y coords.
26 *#* Revision 1.13 2006/04/11 00:08:24 bernie
27 *#* text_offset(): New function, but I'm not quite confident with the design.
29 *#* Revision 1.12 2006/03/27 04:48:56 bernie
30 *#* gfx_blitImage(): New function; gfx_blitRaster(): Fix clipping bug.
32 *#* Revision 1.11 2006/03/07 22:18:04 bernie
33 *#* Correctly compute text width for prop fonts; Make styles a per-bitmap attribute.
35 *#* Revision 1.10 2006/02/17 22:24:40 bernie
36 *#* Fix undefined preprocessor symbol.
38 *#* Revision 1.9 2006/02/15 09:10:15 bernie
39 *#* Implement prop fonts; Fix algo styles.
41 *#* Revision 1.8 2006/02/10 12:28:33 bernie
42 *#* Add font support in bitmaps; Make bitmap formats public.
44 *#* Revision 1.7 2006/01/26 00:36:48 bernie
45 *#* Const correctness for some new functions.
47 *#* Revision 1.6 2006/01/23 23:13:04 bernie
48 *#* RECT_WIDTH(), RECT_HEIGHT(), RASTER_SIZE(): New macros.
50 *#* Revision 1.5 2006/01/17 02:31:29 bernie
51 *#* Add bitmap format support; Improve some comments.
57 #include <cfg/compiler.h>
58 #include <cfg/cpu.h> /* CPU_HARVARD */
60 #include <appconfig.h> /* CONFIG_GFX_* */
63 * \name Known pixel formats for bitmap representation.
66 #define BITMAP_FMT_PLANAR_H_MSB 1 /**< Planar pixels, horizontal bytes, MSB left. */
67 #define BITMAP_FMT_PLANAR_V_LSB 2 /**< Planar pixels, vertical bytes, LSB top. */
70 #if !defined(CONFIG_BITMAP_FMT) || (CONFIG_BITMAP_FMT != BITMAP_FMT_PLANAR_H_MSB && CONFIG_BITMAP_FMT != BITMAP_FMT_PLANAR_V_LSB)
71 #error CONFIG_BITMAP_FMT must be defined to either BITMAP_FMT_PLANAR_H_LSB or BITMAP_FMT_PLANAR_V_LSB
73 #if !defined(CONFIG_GFX_CLIPPING) || (CONFIG_GFX_CLIPPING != 0 && CONFIG_GFX_CLIPPING != 1)
74 #error CONFIG_GFX_CLIPPING must be defined to either 0 or 1
76 #if !defined(CONFIG_GFX_TEXT) || (CONFIG_GFX_TEXT != 0 && CONFIG_GFX_TEXT != 1)
77 #error CONFIG_GFX_TEXT must be defined to either 0 or 1
82 /*! Common type for coordinates expressed in pixel units */
84 typedef unsigned int ucoord_t;
86 #if CONFIG_GFX_VCOORDS
87 /*! Common type for coordinates expressed in logical units */
88 typedef float vcoord_t;
89 #endif /* CONFIG_GFX_VCOORDS */
93 * Describe a rectangular area with coordinates expressed in pixels.
95 * The rectangle is represented in terms of its top/left and
96 * right/bottom borders.
98 * In some cases, rectangles are assumed to obey to the
99 * following invariants:
104 * Oddly, the xmin and ymin coordinates are inclusive, while the
105 * xmax and ymax coordinates are non-inclusive. This design
106 * decision makes several computations simpler and lets you
107 * specify empty (0x0) rectangles without breaking the
110 * Computing the size of a rectangle can be done by simply
111 * subtracting the maximum X or Y coordinate from the minimum
114 typedef struct Rect { coord_t xmin, ymin, xmax, ymax; } Rect;
117 * Return the width of a rectangle in pixels.
119 * \note The argument \a r is evaluated twice.
121 #define RECT_WIDTH(r) ((r)->xmax - (r)->xmin)
124 * Return the height of a rectangle in pixels.
126 * \note The argument \a r is evaluated twice.
128 #define RECT_HEIGHT(r) ((r)->ymax - (r)->ymin)
134 * Control structure to draw in a bitmap
136 * \todo For better ortogonality, split this structure into
137 * an Image and a plain drawing context called Painter.
139 typedef struct Bitmap
141 uint8_t *raster; /*!< Pointer to byte array to hold the data */
142 coord_t width, height; /*!< Width/Height in pixels */
143 coord_t stride; /*!< Bytes per row. */
144 coord_t penX, penY; /*!< Current pen position MoveTo()/LineTo() */
146 Rect cr; /*!< Clip drawing inside this rectangle */
149 const struct Font *font;/**< Current font for text rendering. */
152 * Algorithmic text style flags.
154 * The text rendering routine can apply a few simple transformations
155 * to the current font in order to generate common styles such as
156 * bold, italic and underline from plain glyphs.
162 #if CONFIG_GFX_VCOORDS
164 * \name Logical coordinate system
168 vcoord_t scaleX, scaleY;
170 #endif /* CONFIG_GFX_VCOORDS */
177 * \todo Use this as Bitmap and change Bitmap to Drawable.
181 const uint8_t *raster; /*!< Pointer to byte array to hold the data. */
182 coord_t width; /*!< Raster width in pixels. */
183 coord_t height; /*!< Raster height in pixels. */
184 coord_t stride; /*!< Bytes per row. */
187 #if CONFIG_BITMAP_FMT == BITMAP_FMT_PLANAR_H_MSB
189 * Compute the size in bytes of a raster suitable for
190 * holding a bitmap of \a width x \a height pixels.
192 #define RAST_SIZE(width, height) ( ((width) + 7 / 8) * (height) )
194 #elif CONFIG_BITMAP_FMT == BITMAP_FMT_PLANAR_V_LSB
196 * Compute the size in bytes of a raster suitable for
197 * holding a bitmap of \a width x \a height pixels.
199 #define RAST_SIZE(width, height) ( (width) * (((height) + 7) / 8) )
201 #error Unknown value of CONFIG_BITMAP_FMT
202 #endif /* CONFIG_BITMAP_FMT */
204 #define RASTER_SIZE RAST_SIZE /* OBSOLETE */
206 /* Function prototypes */
207 void gfx_bitmapInit (Bitmap *bm, uint8_t *raster, coord_t w, coord_t h);
208 void gfx_bitmapClear(Bitmap *bm);
209 void gfx_blit (Bitmap *dst, const Rect *rect, const Bitmap *src, coord_t srcx, coord_t srcy);
210 void gfx_blitRaster (Bitmap *dst, coord_t dx, coord_t dy, const uint8_t *raster, coord_t w, coord_t h, coord_t stride);
211 void gfx_blitImage (Bitmap *dst, coord_t dx, coord_t dy, const Image *image);
212 void gfx_line (Bitmap *bm, coord_t x1, coord_t y1, coord_t x2, coord_t y2);
213 void gfx_rectDraw (Bitmap *bm, coord_t x1, coord_t y1, coord_t x2, coord_t y2);
214 void gfx_rectFillC (Bitmap *bm, coord_t x1, coord_t y1, coord_t x2, coord_t y2, uint8_t color);
215 void gfx_rectFill (Bitmap *bm, coord_t x1, coord_t y1, coord_t x2, coord_t y2);
216 void gfx_rectClear (Bitmap *bm, coord_t x1, coord_t y1, coord_t x2, coord_t y2);
217 void gfx_moveTo (Bitmap *bm, coord_t x, coord_t y);
218 void gfx_lineTo (Bitmap *bm, coord_t x, coord_t y);
219 void gfx_setClipRect(Bitmap *bm, coord_t xmin, coord_t ymin, coord_t xmax, coord_t ymax);
222 #include <mware/pgm.h>
223 void gfx_blit_P(Bitmap *bm, const pgm_uint8_t *raster);
227 INLINE void gfx_setFont(Bitmap *bm, const struct Font *font)
233 #if CONFIG_GFX_VCOORDS
234 void gfx_setViewRect(Bitmap *bm, vcoord_t x1, vcoord_t y1, vcoord_t x2, vcoord_t y2);
235 coord_t gfx_transformX(Bitmap *bm, vcoord_t x);
236 coord_t gfx_transformY(Bitmap *bm, vcoord_t y);
237 void gfx_vline(Bitmap *bm, vcoord_t x1, vcoord_t y1, vcoord_t x2, vcoord_t y2);
238 #endif /* CONFIG_GFX_VCOORDS */
242 #endif /* GFX_GFX_H */