initial commit
[profile/ivi/xorg-x11-server.git] / mi / miline.h
1
2 /*
3
4 Copyright 1994, 1998  The Open Group
5
6 Permission to use, copy, modify, distribute, and sell this software and its
7 documentation for any purpose is hereby granted without fee, provided that
8 the above copyright notice appear in all copies and that both that
9 copyright notice and this permission notice appear in supporting
10 documentation.
11
12 The above copyright notice and this permission notice shall be included in
13 all copies or substantial portions of the Software.
14
15 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL THE
18 OPEN GROUP BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
19 AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
20 CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
21
22 Except as contained in this notice, the name of The Open Group shall not be
23 used in advertising or otherwise to promote the sale, use or other dealings
24 in this Software without prior written authorization from The Open Group.
25
26 */
27
28 #ifndef MILINE_H
29
30 #include "screenint.h"
31 #include "privates.h"
32
33 /*
34  * Public definitions used for configuring basic pixelization aspects
35  * of the sample implementation line-drawing routines provided in
36  * {mfb,mi,cfb*} at run-time.
37  */
38
39 #define XDECREASING     4
40 #define YDECREASING     2
41 #define YMAJOR          1
42
43 #define OCTANT1         (1 << (YDECREASING))
44 #define OCTANT2         (1 << (YDECREASING|YMAJOR))
45 #define OCTANT3         (1 << (XDECREASING|YDECREASING|YMAJOR))
46 #define OCTANT4         (1 << (XDECREASING|YDECREASING))
47 #define OCTANT5         (1 << (XDECREASING))
48 #define OCTANT6         (1 << (XDECREASING|YMAJOR))
49 #define OCTANT7         (1 << (YMAJOR))
50 #define OCTANT8         (1 << (0))
51
52 #define XMAJOROCTANTS           (OCTANT1 | OCTANT4 | OCTANT5 | OCTANT8)
53
54 #define DEFAULTZEROLINEBIAS     (OCTANT2 | OCTANT3 | OCTANT4 | OCTANT5)
55
56 /*
57  * Devices can configure the rendering of routines in mi, mfb, and cfb*
58  * by specifying a thin line bias to be applied to a particular screen
59  * using the following function.  The bias parameter is an OR'ing of
60  * the appropriate OCTANT constants defined above to indicate which
61  * octants to bias a line to prefer an axial step when the Bresenham
62  * error term is exactly zero.  The octants are mapped as follows:
63  *
64  *   \    |    /
65  *    \ 3 | 2 /
66  *     \  |  /
67  *    4 \ | / 1
68  *       \|/
69  *   -----------
70  *       /|\
71  *    5 / | \ 8
72  *     /  |  \
73  *    / 6 | 7 \
74  *   /    |    \
75  *
76  * For more information, see "Ambiguities in Incremental Line Rastering,"
77  * Jack E. Bresenham, IEEE CG&A, May 1987.
78  */
79
80 extern _X_EXPORT void miSetZeroLineBias(
81     ScreenPtr /* pScreen */,
82     unsigned int /* bias */
83 );
84
85 /*
86  * Private definitions needed for drawing thin (zero width) lines
87  * Used by the mi, mfb, and all cfb* components.
88  */
89
90 #define X_AXIS  0
91 #define Y_AXIS  1
92
93 #define OUT_LEFT  0x08
94 #define OUT_RIGHT 0x04
95 #define OUT_ABOVE 0x02
96 #define OUT_BELOW 0x01
97
98 #define OUTCODES(_result, _x, _y, _pbox) \
99     if      ( (_x) <  (_pbox)->x1) (_result) |= OUT_LEFT; \
100     else if ( (_x) >= (_pbox)->x2) (_result) |= OUT_RIGHT; \
101     if      ( (_y) <  (_pbox)->y1) (_result) |= OUT_ABOVE; \
102     else if ( (_y) >= (_pbox)->y2) (_result) |= OUT_BELOW;
103
104 #define MIOUTCODES(outcode, x, y, xmin, ymin, xmax, ymax) \
105 {\
106      if (x < xmin) outcode |= OUT_LEFT;\
107      if (x > xmax) outcode |= OUT_RIGHT;\
108      if (y < ymin) outcode |= OUT_ABOVE;\
109      if (y > ymax) outcode |= OUT_BELOW;\
110 }
111   
112 #define SWAPINT(i, j) \
113 {  int _t = i;  i = j;  j = _t; }
114
115 #define SWAPPT(i, j) \
116 {  DDXPointRec _t; _t = i;  i = j; j = _t; }
117
118 #define SWAPINT_PAIR(x1, y1, x2, y2)\
119 {   int t = x1;  x1 = x2;  x2 = t;\
120         t = y1;  y1 = y2;  y2 = t;\
121 }
122
123 #define miGetZeroLineBias(_pScreen) ((unsigned long) (unsigned long*)\
124     dixLookupPrivate(&(_pScreen)->devPrivates, miZeroLineScreenKey))
125
126 #define CalcLineDeltas(_x1,_y1,_x2,_y2,_adx,_ady,_sx,_sy,_SX,_SY,_octant) \
127     (_octant) = 0;                              \
128     (_sx) = (_SX);                              \
129     if (((_adx) = (_x2) - (_x1)) < 0) {         \
130         (_adx) = -(_adx);                       \
131         (_sx = -(_sx));                         \
132         (_octant) |= XDECREASING;               \
133     }                                           \
134     (_sy) = (_SY);                              \
135     if (((_ady) = (_y2) - (_y1)) < 0) {         \
136         (_ady) = -(_ady);                       \
137         (_sy = -(_sy));                         \
138         (_octant) |= YDECREASING;               \
139     }
140
141 #define SetYMajorOctant(_octant)        ((_octant) |= YMAJOR)
142
143 #define FIXUP_ERROR(_e, _octant, _bias) \
144     (_e) -= (((_bias) >> (_octant)) & 1)
145
146 #define IsXMajorOctant(_octant)         (!((_octant) & YMAJOR))
147 #define IsYMajorOctant(_octant)         ((_octant) & YMAJOR)
148 #define IsXDecreasingOctant(_octant)    ((_octant) & XDECREASING)
149 #define IsYDecreasingOctant(_octant)    ((_octant) & YDECREASING)
150
151 extern _X_EXPORT DevPrivateKeyRec miZeroLineScreenKeyRec;
152 #define miZeroLineScreenKey (&miZeroLineScreenKeyRec)
153
154 extern _X_EXPORT int miZeroClipLine(
155     int /*xmin*/,
156     int /*ymin*/,
157     int /*xmax*/,
158     int /*ymax*/,
159     int * /*new_x1*/,
160     int * /*new_y1*/,
161     int * /*new_x2*/,
162     int * /*new_y2*/,
163     unsigned int /*adx*/,
164     unsigned int /*ady*/,
165     int * /*pt1_clipped*/,
166     int * /*pt2_clipped*/,
167     int /*octant*/,
168     unsigned int /*bias*/,
169     int /*oc1*/,
170     int /*oc2*/
171 );
172
173 #endif /* MILINE_H */