comctl32/imagelist: Use proper color format for merged image lists.
[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 typedef struct
22 {
23     int bit_count, width, height;
24     int compression;
25     RECT rect;  /* visible rectangle relative to bitmap origin */
26     int stride; /* stride in bytes.  Will be -ve for bottom-up dibs (see bits). */
27     struct gdi_image_bits bits; /* bits.ptr points to the top-left corner of the dib. */
28
29     DWORD red_mask, green_mask, blue_mask;
30     int red_shift, green_shift, blue_shift;
31     int red_len, green_len, blue_len;
32
33     const RGBQUAD *color_table;
34     DWORD color_table_size;
35
36     const struct primitive_funcs *funcs;
37 } dib_info;
38
39 typedef struct
40 {
41     DWORD count;
42     DWORD dashes[16]; /* 16 is the maximum number for a PS_USERSTYLE pen */
43     DWORD total_len;  /* total length of the dashes, should be multiplied by 2 if there are an odd number of dash lengths */
44 } dash_pattern;
45
46 typedef struct
47 {
48     int left_in_dash;
49     int cur_dash;
50     BOOL mark;
51 } dash_pos;
52
53 typedef struct
54 {
55     DWORD and;
56     DWORD xor;
57 } rop_mask;
58
59 typedef struct
60 {
61     void *and;
62     void *xor;
63 } rop_mask_bits;
64
65 struct dibdrv_physdev;
66 struct cached_font;
67
68 typedef struct dib_brush
69 {
70     UINT     style;
71     UINT     hatch;
72     INT      rop;   /* rop2 last used to create the brush bits */
73     COLORREF colorref;
74     dib_info dib;
75     rop_mask_bits masks;
76     struct brush_pattern pattern;
77     BOOL (*rects)(struct dibdrv_physdev *pdev, struct dib_brush *brush, dib_info *dib,
78                   int num, const RECT *rects, INT rop);
79 } dib_brush;
80
81 struct intensity_range
82 {
83     BYTE r_min, r_max;
84     BYTE g_min, g_max;
85     BYTE b_min, b_max;
86 };
87
88 typedef struct dibdrv_physdev
89 {
90     struct gdi_physdev dev;
91     dib_info dib;
92     dib_brush brush;
93
94     HRGN clip;
95     RECT *bounds;
96     struct cached_font *font;
97
98     /* pen */
99     DWORD pen_style, pen_endcap, pen_join;
100     BOOL pen_uses_region, pen_is_ext;
101     int pen_width;
102     dib_brush pen_brush;
103     dash_pattern pen_pattern;
104     dash_pos dash_pos;
105     rop_mask dash_masks[2];
106     BOOL   (* pen_lines)(struct dibdrv_physdev *pdev, int num, POINT *pts, BOOL close, HRGN region);
107 } dibdrv_physdev;
108
109 extern BOOL     dibdrv_AlphaBlend( PHYSDEV dst_dev, struct bitblt_coords *dst,
110                                    PHYSDEV src_dev, struct bitblt_coords *src, BLENDFUNCTION blend ) DECLSPEC_HIDDEN;
111 extern BOOL     dibdrv_Arc( PHYSDEV dev, INT left, INT top, INT right, INT bottom,
112                             INT start_x, INT start_y, INT end_x, INT end_y ) DECLSPEC_HIDDEN;
113 extern BOOL     dibdrv_ArcTo( 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 DWORD    dibdrv_BlendImage( PHYSDEV dev, BITMAPINFO *info, const struct gdi_image_bits *bits,
116                                    struct bitblt_coords *src, struct bitblt_coords *dst, BLENDFUNCTION func ) DECLSPEC_HIDDEN;
117 extern BOOL     dibdrv_Chord( PHYSDEV dev, INT left, INT top, INT right, INT bottom,
118                               INT start_x, INT start_y, INT end_x, INT end_y ) DECLSPEC_HIDDEN;
119 extern BOOL     dibdrv_Ellipse( PHYSDEV dev, INT left, INT top, INT right, INT bottom ) DECLSPEC_HIDDEN;
120 extern BOOL     dibdrv_ExtFloodFill( PHYSDEV dev, INT x, INT y, COLORREF color, UINT type ) DECLSPEC_HIDDEN;
121 extern BOOL     dibdrv_ExtTextOut( PHYSDEV dev, INT x, INT y, UINT flags,
122                                    const RECT *rect, LPCWSTR str, UINT count, const INT *dx ) DECLSPEC_HIDDEN;
123 extern DWORD    dibdrv_GetImage( PHYSDEV dev, BITMAPINFO *info, struct gdi_image_bits *bits,
124                                  struct bitblt_coords *src ) DECLSPEC_HIDDEN;
125 extern COLORREF dibdrv_GetNearestColor( PHYSDEV dev, COLORREF color ) DECLSPEC_HIDDEN;
126 extern COLORREF dibdrv_GetPixel( PHYSDEV dev, INT x, INT y ) DECLSPEC_HIDDEN;
127 extern BOOL     dibdrv_GradientFill( PHYSDEV dev, TRIVERTEX *vert_array, ULONG nvert,
128                                      void *grad_array, ULONG ngrad, ULONG mode ) DECLSPEC_HIDDEN;
129 extern BOOL     dibdrv_LineTo( PHYSDEV dev, INT x, INT y ) DECLSPEC_HIDDEN;
130 extern BOOL     dibdrv_PatBlt( PHYSDEV dev, struct bitblt_coords *dst, DWORD rop ) DECLSPEC_HIDDEN;
131 extern BOOL     dibdrv_PaintRgn( PHYSDEV dev, HRGN hrgn ) DECLSPEC_HIDDEN;
132 extern BOOL     dibdrv_Pie( PHYSDEV dev, INT left, INT top, INT right, INT bottom,
133                             INT start_x, INT start_y, INT end_x, INT end_y ) DECLSPEC_HIDDEN;
134 extern BOOL     dibdrv_PolyPolygon( PHYSDEV dev, const POINT *pt, const INT *counts, DWORD polygons ) DECLSPEC_HIDDEN;
135 extern BOOL     dibdrv_PolyPolyline( PHYSDEV dev, const POINT* pt, const DWORD* counts,
136                                      DWORD polylines ) DECLSPEC_HIDDEN;
137 extern BOOL     dibdrv_Polygon( PHYSDEV dev, const POINT *pt, INT count ) DECLSPEC_HIDDEN;
138 extern BOOL     dibdrv_Polyline( PHYSDEV dev, const POINT* pt, INT count ) DECLSPEC_HIDDEN;
139 extern DWORD    dibdrv_PutImage( PHYSDEV dev, HRGN clip, BITMAPINFO *info,
140                                  const struct gdi_image_bits *bits, struct bitblt_coords *src,
141                                  struct bitblt_coords *dst, DWORD rop ) DECLSPEC_HIDDEN;
142 extern BOOL     dibdrv_Rectangle( PHYSDEV dev, INT left, INT top, INT right, INT bottom ) DECLSPEC_HIDDEN;
143 extern BOOL     dibdrv_RoundRect( PHYSDEV dev, INT left, INT top, INT right, INT bottom,
144                                   INT ellipse_width, INT ellipse_height ) DECLSPEC_HIDDEN;
145 extern HBRUSH   dibdrv_SelectBrush( PHYSDEV dev, HBRUSH hbrush, const struct brush_pattern *pattern ) DECLSPEC_HIDDEN;
146 extern HFONT    dibdrv_SelectFont( PHYSDEV dev, HFONT font, UINT *aa_flags ) DECLSPEC_HIDDEN;
147 extern HPEN     dibdrv_SelectPen( PHYSDEV dev, HPEN hpen, const struct brush_pattern *pattern ) DECLSPEC_HIDDEN;
148 extern COLORREF dibdrv_SetDCBrushColor( PHYSDEV dev, COLORREF color ) DECLSPEC_HIDDEN;
149 extern COLORREF dibdrv_SetDCPenColor( PHYSDEV dev, COLORREF color ) DECLSPEC_HIDDEN;
150 extern COLORREF dibdrv_SetPixel( PHYSDEV dev, INT x, INT y, COLORREF color ) DECLSPEC_HIDDEN;
151 extern BOOL     dibdrv_StretchBlt( PHYSDEV dst_dev, struct bitblt_coords *dst,
152                                    PHYSDEV src_dev, struct bitblt_coords *src, DWORD rop ) DECLSPEC_HIDDEN;
153 extern struct opengl_funcs *dibdrv_wine_get_wgl_driver( PHYSDEV dev, UINT version ) 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, const rop_mask_bits *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     void    (* draw_subpixel_glyph)(const dib_info *dst, const RECT *rc, const dib_info *glyph,
190                                     const POINT *origin, DWORD text_pixel );
191     DWORD             (* get_pixel)(const dib_info *dib, int x, int y);
192     DWORD     (* colorref_to_pixel)(const dib_info *dib, COLORREF color);
193     COLORREF  (* pixel_to_colorref)(const dib_info *dib, DWORD pixel);
194     void             (* convert_to)(dib_info *dst, const dib_info *src, const RECT *src_rect, BOOL dither);
195     void       (* create_rop_masks)(const dib_info *dib, const BYTE *hatch_ptr,
196                                     const rop_mask *fg, const rop_mask *bg, rop_mask_bits *bits);
197     void    (* create_dither_masks)(const dib_info *dib, int rop2, COLORREF color, rop_mask_bits *bits);
198     void            (* stretch_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     void             (* shrink_row)(const dib_info *dst_dib, const POINT *dst_start,
202                                     const dib_info *src_dib, const POINT *src_start,
203                                     const struct stretch_params *params, int mode, BOOL keep_dst);
204 } primitive_funcs;
205
206 extern const primitive_funcs funcs_8888 DECLSPEC_HIDDEN;
207 extern const primitive_funcs funcs_32   DECLSPEC_HIDDEN;
208 extern const primitive_funcs funcs_24   DECLSPEC_HIDDEN;
209 extern const primitive_funcs funcs_555  DECLSPEC_HIDDEN;
210 extern const primitive_funcs funcs_16   DECLSPEC_HIDDEN;
211 extern const primitive_funcs funcs_8    DECLSPEC_HIDDEN;
212 extern const primitive_funcs funcs_4    DECLSPEC_HIDDEN;
213 extern const primitive_funcs funcs_1    DECLSPEC_HIDDEN;
214 extern const primitive_funcs funcs_null DECLSPEC_HIDDEN;
215
216 struct rop_codes
217 {
218     DWORD a1, a2, x1, x2;
219 };
220
221 #define OVERLAP_LEFT  0x01  /* dest starts left of source */
222 #define OVERLAP_RIGHT 0x02  /* dest starts right of source */
223 #define OVERLAP_ABOVE 0x04  /* dest starts above source */
224 #define OVERLAP_BELOW 0x08  /* dest starts below source */
225
226 typedef struct
227 {
228     unsigned int dx, dy;
229     int bias;
230     DWORD octant;
231 } bres_params;
232
233 struct clipped_rects
234 {
235     RECT *rects;
236     int   count;
237     RECT  buffer[32];
238 };
239
240 extern void get_rop_codes(INT rop, struct rop_codes *codes) DECLSPEC_HIDDEN;
241 extern void reset_dash_origin(dibdrv_physdev *pdev) DECLSPEC_HIDDEN;
242 extern void init_dib_info_from_bitmapinfo(dib_info *dib, const BITMAPINFO *info, void *bits) DECLSPEC_HIDDEN;
243 extern BOOL init_dib_info_from_bitmapobj(dib_info *dib, BITMAPOBJ *bmp) DECLSPEC_HIDDEN;
244 extern void free_dib_info(dib_info *dib) DECLSPEC_HIDDEN;
245 extern void free_pattern_brush(dib_brush *brush) DECLSPEC_HIDDEN;
246 extern void copy_dib_color_info(dib_info *dst, const dib_info *src) DECLSPEC_HIDDEN;
247 extern BOOL convert_dib(dib_info *dst, const dib_info *src) DECLSPEC_HIDDEN;
248 extern DWORD get_pixel_color( HDC hdc, const dib_info *dib, COLORREF color, BOOL mono_fixup ) DECLSPEC_HIDDEN;
249 extern int clip_rect_to_dib( const dib_info *dib, RECT *rc ) 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 void add_clipped_bounds( dibdrv_physdev *dev, const RECT *rect, HRGN clip ) DECLSPEC_HIDDEN;
252 extern int clip_line(const POINT *start, const POINT *end, const RECT *clip,
253                      const bres_params *params, POINT *pt1, POINT *pt2) DECLSPEC_HIDDEN;
254 extern void release_cached_font( struct cached_font *font ) DECLSPEC_HIDDEN;
255
256 static inline void init_clipped_rects( struct clipped_rects *clip_rects )
257 {
258     clip_rects->count = 0;
259     clip_rects->rects = clip_rects->buffer;
260 }
261
262 static inline void free_clipped_rects( struct clipped_rects *clip_rects )
263 {
264     if (clip_rects->rects != clip_rects->buffer) HeapFree( GetProcessHeap(), 0, clip_rects->rects );
265 }
266
267 /* compute the x coordinate corresponding to y on the specified edge */
268 static inline int edge_coord( int y, int x1, int y1, int x2, int y2 )
269 {
270     if (x2 > x1)  /* always follow the edge from right to left to get correct rounding */
271         return x2 + (y - y2) * (x2 - x1) / (y2 - y1);
272     else
273         return x1 + (y - y1) * (x2 - x1) / (y2 - y1);
274 }
275
276 static inline const RGBQUAD *get_dib_color_table( const dib_info *dib )
277 {
278     return dib->color_table ? dib->color_table : get_default_color_table( dib->bit_count );
279 }