Include <mware/pgm.h> explicitly for non-Harvard archs.
[bertos.git] / mware / gfx.h
1 /*!
2  * \file
3  * Copyright 2003, 2004 Develer S.r.l. (http://www.develer.com/)
4  * Copyright 1999 Bernardo Innocenti <bernie@develer.com>
5  * This file is part of DevLib - See devlib/README 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.9  2005/01/20 18:46:31  aleph
18  *#* Fix progmem includes.
19  *#*
20  *#* Revision 1.8  2004/11/01 15:14:07  bernie
21  *#* Update to current coding conventions.
22  *#*
23  *#* Revision 1.7  2004/09/20 03:29:06  bernie
24  *#* Conditionalize AVR-specific code.
25  *#*
26  *#* Revision 1.6  2004/09/14 21:01:08  bernie
27  *#* Rename rectangle drawing functions; Unify filled/cleared implementations.
28  *#*
29  *#* Revision 1.4  2004/08/10 07:00:16  bernie
30  *#* Add missing header.
31  *#*
32  *#* Revision 1.3  2004/08/04 03:16:59  bernie
33  *#* Switch to new DevLib CONFIG_ convention.
34  *#*
35  *#* Revision 1.2  2004/06/03 11:27:09  bernie
36  *#* Add dual-license information.
37  *#*
38  *#* Revision 1.1  2004/05/23 15:43:16  bernie
39  *#* Import mware modules.
40  *#*/
41
42 #ifndef MWARE_GFX_H
43 #define MWARE_GFX_H
44
45 #include <config.h>
46 #include <compiler.h>
47 #include <cpu.h>
48
49
50 /*! Common type for coordinates expressed in pixel units */
51 typedef int coord_t;
52
53 #if CONFIG_GFX_VCOORDS
54 /*! Common type for coordinates expressed in logical units */
55 typedef float vcoord_t;
56 #endif /* CONFIG_GFX_VCOORDS */
57
58
59 typedef struct Rect { coord_t xmin, ymin, xmax, ymax; } Rect;
60
61
62 /*!
63  * Control structure to draw in a bitmap
64  */
65 typedef struct Bitmap
66 {
67         uint8_t *raster;        /*!< Pointer to byte array to hold the data */
68         coord_t width, height;  /*!< Width/Height in pixels */
69         coord_t penX, penY;     /*!< Current pen position MoveTo()/LineTo() */
70
71         Rect cr;                /*!< Clip drawing inside this rectangle */
72
73 #if CONFIG_GFX_VCOORDS
74         /*!
75          * \name Logical coordinate system
76          * \{
77          */
78         vcoord_t orgX, orgY;
79         vcoord_t scaleX, scaleY;
80         /*\}*/
81 #endif /* CONFIG_GFX_VCOORDS */
82
83 } Bitmap;
84
85
86 /* Function prototypes */
87 extern void gfx_bitmapInit (Bitmap *bm, uint8_t *raster, coord_t w, coord_t h);
88 extern void gfx_bitmapClear(Bitmap *bm);
89 extern void gfx_line       (Bitmap *bm, coord_t x1, coord_t y1, coord_t x2, coord_t y2);
90 extern void gfx_rectDraw   (Bitmap *bm, coord_t x1, coord_t y1, coord_t x2, coord_t y2);
91 extern void gfx_rectFillC  (Bitmap *bm, coord_t x1, coord_t y1, coord_t x2, coord_t y2, uint8_t color);
92 extern void gfx_rectFill   (Bitmap *bm, coord_t x1, coord_t y1, coord_t x2, coord_t y2);
93 extern void gfx_rectClear  (Bitmap *bm, coord_t x1, coord_t y1, coord_t x2, coord_t y2);
94 extern void gfx_moveTo     (Bitmap *bm, coord_t x,  coord_t y);
95 extern void gfx_lineTo     (Bitmap *bm, coord_t x,  coord_t y);
96 extern void gfx_setClipRect(Bitmap *bm, coord_t xmin, coord_t ymin, coord_t xmax, coord_t ymax);
97
98 #if CPU_HARVARD
99         extern void gfx_blit_P(Bitmap *bm, const pgm_uint8_t *raster);
100 #endif
101
102
103 #if CONFIG_GFX_VCOORDS
104 extern void gfx_setViewRect(Bitmap *bm, vcoord_t x1, vcoord_t y1, vcoord_t x2, vcoord_t y2);
105 extern coord_t gfx_transformX(Bitmap *bm, vcoord_t x);
106 extern coord_t gfx_transformY(Bitmap *bm, vcoord_t y);
107 extern void gfx_vline(Bitmap *bm, vcoord_t x1, vcoord_t y1, vcoord_t x2, vcoord_t y2);
108 #endif /* CONFIG_GFX_VCOORDS */
109
110 #endif /* MWARE_GFX_H */