Release 1.4.1.
[wine] / dlls / gdi32 / dibdrv / dibdrv.h
1 /*
2  * DIB driver include file.
3  *
4  * Copyright 2011 Huw Davies
5  *
6  * This library is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Lesser General Public
8  * License as published by the Free Software Foundation; either
9  * version 2.1 of the License, or (at your option) any later version.
10  *
11  * This library is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  * Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License along with this library; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
19  */
20
21 enum dib_info_flags
22 {
23     default_color_table = 1
24 };
25
26 typedef struct
27 {
28     int bit_count, width, height;
29     int compression;
30     int stride; /* stride in bytes.  Will be -ve for bottom-up dibs (see bits). */
31     struct gdi_image_bits bits; /* bits.ptr points to the top-left corner of the dib. */
32
33     DWORD red_mask, green_mask, blue_mask;
34     int red_shift, green_shift, blue_shift;
35     int red_len, green_len, blue_len;
36
37     const RGBQUAD *color_table;
38     DWORD color_table_size;
39
40     const struct primitive_funcs *funcs;
41 } dib_info;
42
43 typedef struct
44 {
45     DWORD count;
46     DWORD dashes[16]; /* 16 is the maximum number for a PS_USERSTYLE pen */
47     DWORD total_len;  /* total length of the dashes, should be multiplied by 2 if there are an odd number of dash lengths */
48 } dash_pattern;
49
50 typedef struct
51 {
52     int left_in_dash;
53     int cur_dash;
54     BOOL mark;
55 } dash_pos;
56
57 typedef struct
58 {
59     DWORD and;
60     DWORD xor;
61 } rop_mask;
62
63 typedef struct
64 {
65     void *and;
66     void *xor;
67 } rop_mask_bits;
68
69 struct dibdrv_physdev;
70
71 typedef struct dib_brush
72 {
73     UINT     style;
74     UINT     hatch;
75     INT      rop;   /* rop2 last used to create the brush bits */
76     COLORREF colorref;
77     dib_info dib;
78     void    *and_bits;
79     void    *xor_bits;
80     struct brush_pattern pattern;
81     BOOL (*rects)(struct dibdrv_physdev *pdev, struct dib_brush *brush, dib_info *dib,
82                   int num, const RECT *rects, INT rop);
83 } dib_brush;
84
85 struct intensity_range
86 {
87     BYTE r_min, r_max;
88     BYTE g_min, g_max;
89     BYTE b_min, b_max;
90 };
91
92 typedef struct dibdrv_physdev
93 {
94     struct gdi_physdev dev;
95     dib_info dib;
96     dib_brush brush;
97
98     HRGN clip;
99
100     /* pen */
101     DWORD pen_style, pen_endcap, pen_join;
102     BOOL pen_uses_region, pen_is_ext;
103     int pen_width;
104     dib_brush pen_brush;
105     dash_pattern pen_pattern;
106     dash_pos dash_pos;
107     rop_mask dash_masks[2];
108     BOOL   (* pen_lines)(struct dibdrv_physdev *pdev, int num, POINT *pts, BOOL close, HRGN region);
109 } dibdrv_physdev;
110
111 extern BOOL     dibdrv_AlphaBlend( PHYSDEV dst_dev, struct bitblt_coords *dst,
112                                    PHYSDEV src_dev, struct bitblt_coords *src, BLENDFUNCTION blend ) DECLSPEC_HIDDEN;
113 extern BOOL     dibdrv_Arc( PHYSDEV dev, INT left, INT top, INT right, INT bottom,
114                             INT start_x, INT start_y, INT end_x, INT end_y ) DECLSPEC_HIDDEN;
115 extern BOOL     dibdrv_ArcTo( PHYSDEV dev, INT left, INT top, INT right, INT bottom,
116                               INT start_x, INT start_y, INT end_x, INT end_y ) DECLSPEC_HIDDEN;
117 extern DWORD    dibdrv_BlendImage( PHYSDEV dev, BITMAPINFO *info, const struct gdi_image_bits *bits,
118                                    struct bitblt_coords *src, struct bitblt_coords *dst, BLENDFUNCTION func ) DECLSPEC_HIDDEN;
119 extern BOOL     dibdrv_Chord( PHYSDEV dev, INT left, INT top, INT right, INT bottom,
120                               INT start_x, INT start_y, INT end_x, INT end_y ) DECLSPEC_HIDDEN;
121 extern BOOL     dibdrv_Ellipse( PHYSDEV dev, INT left, INT top, INT right, INT bottom ) DECLSPEC_HIDDEN;
122 extern BOOL     dibdrv_ExtFloodFill( PHYSDEV dev, INT x, INT y, COLORREF color, UINT type ) DECLSPEC_HIDDEN;
123 extern BOOL     dibdrv_ExtTextOut( PHYSDEV dev, INT x, INT y, UINT flags,
124                                    const RECT *rect, LPCWSTR str, UINT count, const INT *dx ) DECLSPEC_HIDDEN;
125 extern DWORD    dibdrv_GetImage( PHYSDEV dev, HBITMAP hbitmap, BITMAPINFO *info,
126                                  struct gdi_image_bits *bits, struct bitblt_coords *src ) DECLSPEC_HIDDEN;
127 extern COLORREF dibdrv_GetNearestColor( PHYSDEV dev, COLORREF color ) DECLSPEC_HIDDEN;
128 extern COLORREF dibdrv_GetPixel( PHYSDEV dev, INT x, INT y ) DECLSPEC_HIDDEN;
129 extern BOOL     dibdrv_GradientFill( PHYSDEV dev, TRIVERTEX *vert_array, ULONG nvert,
130                                      void *grad_array, ULONG ngrad, ULONG mode ) DECLSPEC_HIDDEN;
131 extern BOOL     dibdrv_LineTo( PHYSDEV dev, INT x, INT y ) DECLSPEC_HIDDEN;
132 extern BOOL     dibdrv_PatBlt( PHYSDEV dev, struct bitblt_coords *dst, DWORD rop ) DECLSPEC_HIDDEN;
133 extern BOOL     dibdrv_PaintRgn( PHYSDEV dev, HRGN hrgn ) DECLSPEC_HIDDEN;
134 extern BOOL     dibdrv_Pie( PHYSDEV dev, INT left, INT top, INT right, INT bottom,
135                             INT start_x, INT start_y, INT end_x, INT end_y ) DECLSPEC_HIDDEN;
136 extern BOOL     dibdrv_PolyPolygon( PHYSDEV dev, const POINT *pt, const INT *counts, DWORD polygons ) DECLSPEC_HIDDEN;
137 extern BOOL     dibdrv_PolyPolyline( PHYSDEV dev, const POINT* pt, const DWORD* counts,
138                                      DWORD polylines ) DECLSPEC_HIDDEN;
139 extern BOOL     dibdrv_Polygon( PHYSDEV dev, const POINT *pt, INT count ) DECLSPEC_HIDDEN;
140 extern BOOL     dibdrv_Polyline( PHYSDEV dev, const POINT* pt, INT count ) DECLSPEC_HIDDEN;
141 extern DWORD    dibdrv_PutImage( PHYSDEV dev, HBITMAP hbitmap, HRGN clip, BITMAPINFO *info,
142                                  const struct gdi_image_bits *bits, struct bitblt_coords *src,
143                                  struct bitblt_coords *dst, DWORD rop ) DECLSPEC_HIDDEN;
144 extern BOOL     dibdrv_Rectangle( PHYSDEV dev, INT left, INT top, INT right, INT bottom ) DECLSPEC_HIDDEN;
145 extern BOOL     dibdrv_RoundRect( PHYSDEV dev, INT left, INT top, INT right, INT bottom,
146                                   INT ellipse_width, INT ellipse_height ) DECLSPEC_HIDDEN;
147 extern HBRUSH   dibdrv_SelectBrush( PHYSDEV dev, HBRUSH hbrush, const struct brush_pattern *pattern ) DECLSPEC_HIDDEN;
148 extern HPEN     dibdrv_SelectPen( PHYSDEV dev, HPEN hpen, const struct brush_pattern *pattern ) DECLSPEC_HIDDEN;
149 extern COLORREF dibdrv_SetDCBrushColor( PHYSDEV dev, COLORREF color ) DECLSPEC_HIDDEN;
150 extern COLORREF dibdrv_SetDCPenColor( PHYSDEV dev, COLORREF color ) DECLSPEC_HIDDEN;
151 extern COLORREF dibdrv_SetPixel( PHYSDEV dev, INT x, INT y, COLORREF color ) DECLSPEC_HIDDEN;
152 extern BOOL     dibdrv_StretchBlt( PHYSDEV dst_dev, struct bitblt_coords *dst,
153                                    PHYSDEV src_dev, struct bitblt_coords *src, DWORD rop ) DECLSPEC_HIDDEN;
154
155 static inline dibdrv_physdev *get_dibdrv_pdev( PHYSDEV dev )
156 {
157     return (dibdrv_physdev *)dev;
158 }
159
160 struct line_params
161 {
162     int err_start, err_add_1, err_add_2, bias;
163     unsigned int length;
164     int x_inc, y_inc;
165     BOOL x_major;
166 };
167
168 struct stretch_params
169 {
170     int err_start, err_add_1, err_add_2;
171     unsigned int length;
172     int dst_inc, src_inc;
173 };
174
175 typedef struct primitive_funcs
176 {
177     void            (* solid_rects)(const dib_info *dib, int num, const RECT *rc, DWORD and, DWORD xor);
178     void             (* solid_line)(const dib_info *dib, const POINT *start, const struct line_params *params,
179                                     DWORD and, DWORD xor);
180     void          (* pattern_rects)(const dib_info *dib, int num, const RECT *rc, const POINT *orign,
181                                     const dib_info *brush, void *and_bits, void *xor_bits);
182     void              (* copy_rect)(const dib_info *dst, const RECT *rc, const dib_info *src,
183                                     const POINT *origin, int rop2, int overlap);
184     void             (* blend_rect)(const dib_info *dst, const RECT *rc, const dib_info *src,
185                                     const POINT *origin, BLENDFUNCTION blend);
186     BOOL          (* gradient_rect)(const dib_info *dib, const RECT *rc, const TRIVERTEX *v, int mode);
187     void             (* draw_glyph)(const dib_info *dst, const RECT *rc, const dib_info *glyph,
188                                     const POINT *origin, DWORD text_pixel, const struct intensity_range *ranges);
189     DWORD             (* get_pixel)(const dib_info *dib, int x, int y);
190     DWORD     (* colorref_to_pixel)(const dib_info *dib, COLORREF color);
191     COLORREF  (* pixel_to_colorref)(const dib_info *dib, DWORD pixel);
192     void             (* convert_to)(dib_info *dst, const dib_info *src, const RECT *src_rect);
193     BOOL       (* create_rop_masks)(const dib_info *dib, const dib_info *hatch,
194                                     const rop_mask *fg, const rop_mask *bg, rop_mask_bits *bits);
195     void            (* stretch_row)(const dib_info *dst_dib, const POINT *dst_start,
196                                     const dib_info *src_dib, const POINT *src_start,
197                                     const struct stretch_params *params, int mode, BOOL keep_dst);
198     void             (* shrink_row)(const dib_info *dst_dib, const POINT *dst_start,
199                                     const dib_info *src_dib, const POINT *src_start,
200                                     const struct stretch_params *params, int mode, BOOL keep_dst);
201 } primitive_funcs;
202
203 extern const primitive_funcs funcs_8888 DECLSPEC_HIDDEN;
204 extern const primitive_funcs funcs_32   DECLSPEC_HIDDEN;
205 extern const primitive_funcs funcs_24   DECLSPEC_HIDDEN;
206 extern const primitive_funcs funcs_555  DECLSPEC_HIDDEN;
207 extern const primitive_funcs funcs_16   DECLSPEC_HIDDEN;
208 extern const primitive_funcs funcs_8    DECLSPEC_HIDDEN;
209 extern const primitive_funcs funcs_4    DECLSPEC_HIDDEN;
210 extern const primitive_funcs funcs_1    DECLSPEC_HIDDEN;
211 extern const primitive_funcs funcs_null DECLSPEC_HIDDEN;
212
213 struct rop_codes
214 {
215     DWORD a1, a2, x1, x2;
216 };
217
218 #define OVERLAP_LEFT  0x01  /* dest starts left of source */
219 #define OVERLAP_RIGHT 0x02  /* dest starts right of source */
220 #define OVERLAP_ABOVE 0x04  /* dest starts above source */
221 #define OVERLAP_BELOW 0x08  /* dest starts below source */
222
223 typedef struct
224 {
225     unsigned int dx, dy;
226     int bias;
227     DWORD octant;
228 } bres_params;
229
230 struct clipped_rects
231 {
232     RECT *rects;
233     int   count;
234     RECT  buffer[32];
235 };
236
237 extern void get_rop_codes(INT rop, struct rop_codes *codes) DECLSPEC_HIDDEN;
238 extern void reset_dash_origin(dibdrv_physdev *pdev) DECLSPEC_HIDDEN;
239 extern void init_dib_info_from_bitmapinfo(dib_info *dib, const BITMAPINFO *info, void *bits, enum dib_info_flags flags) DECLSPEC_HIDDEN;
240 extern BOOL init_dib_info_from_bitmapobj(dib_info *dib, BITMAPOBJ *bmp, enum dib_info_flags flags) DECLSPEC_HIDDEN;
241 extern void free_dib_info(dib_info *dib) DECLSPEC_HIDDEN;
242 extern void free_pattern_brush(dib_brush *brush) DECLSPEC_HIDDEN;
243 extern void copy_dib_color_info(dib_info *dst, const dib_info *src) DECLSPEC_HIDDEN;
244 extern BOOL convert_dib(dib_info *dst, const dib_info *src) DECLSPEC_HIDDEN;
245 extern COLORREF make_rgb_colorref( HDC hdc, dib_info *dib, COLORREF color, BOOL *got_pixel, DWORD *pixel ) DECLSPEC_HIDDEN;
246 extern DWORD get_pixel_color(dibdrv_physdev *pdev, COLORREF color, BOOL mono_fixup) DECLSPEC_HIDDEN;
247 extern BOOL brush_rect( dibdrv_physdev *pdev, dib_brush *brush, const RECT *rect, HRGN clip, INT rop ) DECLSPEC_HIDDEN;
248 extern BOOL brush_region( dibdrv_physdev *pdev, HRGN region ) DECLSPEC_HIDDEN;
249 extern BOOL pen_region( dibdrv_physdev *pdev, HRGN region ) DECLSPEC_HIDDEN;
250 extern int get_clipped_rects( const dib_info *dib, const RECT *rc, HRGN clip, struct clipped_rects *clip_rects ) DECLSPEC_HIDDEN;
251 extern int clip_line(const POINT *start, const POINT *end, const RECT *clip,
252                      const bres_params *params, POINT *pt1, POINT *pt2) DECLSPEC_HIDDEN;
253
254 static inline void init_clipped_rects( struct clipped_rects *clip_rects )
255 {
256     clip_rects->count = 0;
257     clip_rects->rects = clip_rects->buffer;
258 }
259
260 static inline void free_clipped_rects( struct clipped_rects *clip_rects )
261 {
262     if (clip_rects->rects != clip_rects->buffer) HeapFree( GetProcessHeap(), 0, clip_rects->rects );
263 }
264
265 /* compute the x coordinate corresponding to y on the specified edge */
266 static inline int edge_coord( int y, int x1, int y1, int x2, int y2 )
267 {
268     if (x2 > x1)  /* always follow the edge from right to left to get correct rounding */
269         return x2 + (y - y2) * (x2 - x1) / (y2 - y1);
270     else
271         return x1 + (y - y1) * (x2 - x1) / (y2 - y1);
272 }