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     private_color_table = 1,
  24     default_color_table = 2
  25 };
  26
  27 typedef struct
  28 {
  29     int bit_count, width, height;
  30     int compression;
  31     int stride; /* stride in bytes.  Will be -ve for bottom-up dibs (see bits). */
  32     struct gdi_image_bits bits; /* bits.ptr points to the top-left corner of the dib. */
  33
  34     DWORD red_mask, green_mask, blue_mask;
  35     int red_shift, green_shift, blue_shift;
  36     int red_len, green_len, blue_len;
  37
  38     RGBQUAD *color_table;
  39     DWORD color_table_size;
  40
  41     enum dib_info_flags flags;
  42
  43     const struct primitive_funcs *funcs;
  44 } dib_info;
  45
  46 typedef struct
  47 {
  48     DWORD count;
  49     DWORD dashes[16]; /* 16 is the maximum number for a PS_USERSTYLE pen */
  50     DWORD total_len;  /* total length of the dashes, should be multiplied by 2 if there are an odd number of dash lengths */
  51 } dash_pattern;
  52
  53 typedef struct
  54 {
  55     int left_in_dash;
  56     int cur_dash;
  57     BOOL mark;
  58 } dash_pos;
  59
  60 typedef struct
  61 {
  62     DWORD and;
  63     DWORD xor;
  64 } rop_mask;
  65
  66 typedef struct
  67 {
  68     void *and;
  69     void *xor;
  70 } rop_mask_bits;
  71
  72 struct intensity_range
  73 {
  74     BYTE r_min, r_max;
  75     BYTE g_min, g_max;
  76     BYTE b_min, b_max;
  77 };
  78
  79 typedef struct dibdrv_physdev
  80 {
  81     struct gdi_physdev dev;
  82     dib_info dib;
  83
  84     HRGN clip;
  85     DWORD defer;
  86
  87     /* pen */
  88     COLORREF pen_colorref;
  89     DWORD pen_color, pen_and, pen_xor, pen_endcap, pen_join;
  90     int pen_width;
  91     dash_pattern pen_pattern;
  92     dash_pos dash_pos;
  93     BOOL   (* pen_lines)(struct dibdrv_physdev *pdev, int num, POINT *pts, BOOL close);
  94
  95     /* brush */
  96     UINT brush_style;
  97     UINT brush_hatch;
  98     INT brush_rop;   /* PatBlt, for example, can override the DC's rop2 */
  99     COLORREF brush_colorref;
 100     DWORD brush_color, brush_and, brush_xor;
 101     dib_info brush_dib;
 102     void *brush_and_bits, *brush_xor_bits;
 103     const BITMAPINFO *brush_pattern_info;
 104     void *brush_pattern_bits;
 105     UINT brush_pattern_usage;
 106     BOOL   (* brush_rects)(struct dibdrv_physdev *pdev, dib_info *dib, int num, const RECT *rects, HRGN clip);
 107
 108     /* background */
 109     DWORD bkgnd_color, bkgnd_and, bkgnd_xor;
 110
 111     /* text */
 112     DWORD text_color;
 113     struct intensity_range glyph_intensities[17];
 114 } dibdrv_physdev;
 115
 116 #define DEFER_FORMAT     1
 117 #define DEFER_PEN        2
 118 #define DEFER_BRUSH      4
 119
 120 extern BOOL     dibdrv_AlphaBlend( PHYSDEV dst_dev, struct bitblt_coords *dst,
 121                                    PHYSDEV src_dev, struct bitblt_coords *src, BLENDFUNCTION blend ) DECLSPEC_HIDDEN;
 122 extern DWORD    dibdrv_BlendImage( PHYSDEV dev, BITMAPINFO *info, const struct gdi_image_bits *bits,
 123                                    struct bitblt_coords *src, struct bitblt_coords *dst, BLENDFUNCTION func ) DECLSPEC_HIDDEN;
 124 extern BOOL     dibdrv_GradientFill( PHYSDEV dev, TRIVERTEX *vert_array, ULONG nvert,
 125                                      void *grad_array, ULONG ngrad, ULONG mode ) DECLSPEC_HIDDEN;
 126 extern BOOL     dibdrv_ExtTextOut( PHYSDEV dev, INT x, INT y, UINT flags,
 127                                    const RECT *rect, LPCWSTR str, UINT count, const INT *dx ) DECLSPEC_HIDDEN;
 128 extern DWORD    dibdrv_GetImage( PHYSDEV dev, HBITMAP hbitmap, BITMAPINFO *info,
 129                                  struct gdi_image_bits *bits, struct bitblt_coords *src ) DECLSPEC_HIDDEN;
 130 extern COLORREF dibdrv_GetPixel( PHYSDEV dev, INT x, INT y ) 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_PolyPolyline( PHYSDEV dev, const POINT* pt, const DWORD* counts,
 135                                      DWORD polylines ) DECLSPEC_HIDDEN;
 136 extern BOOL     dibdrv_Polyline( PHYSDEV dev, const POINT* pt, INT count ) DECLSPEC_HIDDEN;
 137 extern DWORD    dibdrv_PutImage( PHYSDEV dev, HBITMAP hbitmap, HRGN clip, BITMAPINFO *info,
 138                                  const struct gdi_image_bits *bits, struct bitblt_coords *src,
 139                                  struct bitblt_coords *dst, DWORD rop ) DECLSPEC_HIDDEN;
 140 extern BOOL     dibdrv_Rectangle( PHYSDEV dev, INT left, INT top, INT right, INT bottom ) DECLSPEC_HIDDEN;
 141 extern HBRUSH   dibdrv_SelectBrush( PHYSDEV dev, HBRUSH hbrush, HBITMAP bitmap,
 142                                     const BITMAPINFO *info, void *bits, UINT usage ) DECLSPEC_HIDDEN;
 143 extern HPEN     dibdrv_SelectPen( PHYSDEV dev, HPEN hpen ) DECLSPEC_HIDDEN;
 144 extern COLORREF dibdrv_SetDCBrushColor( PHYSDEV dev, COLORREF color ) DECLSPEC_HIDDEN;
 145 extern COLORREF dibdrv_SetDCPenColor( PHYSDEV dev, COLORREF color ) DECLSPEC_HIDDEN;
 146 extern COLORREF dibdrv_SetPixel( PHYSDEV dev, INT x, INT y, COLORREF color ) DECLSPEC_HIDDEN;
 147 extern BOOL     dibdrv_StretchBlt( PHYSDEV dst_dev, struct bitblt_coords *dst,
 148                                    PHYSDEV src_dev, struct bitblt_coords *src, DWORD rop ) DECLSPEC_HIDDEN;
 149
 150 static inline dibdrv_physdev *get_dibdrv_pdev( PHYSDEV dev )
 151 {
 152     return (dibdrv_physdev *)dev;
 153 }
 154
 155 struct line_params
 156 {
 157     int err_start, err_add_1, err_add_2, bias;
 158     unsigned int length;
 159     int x_inc, y_inc;
 160     BOOL x_major;
 161 };
 162
 163 struct stretch_params
 164 {
 165     int err_start, err_add_1, err_add_2;
 166     unsigned int length;
 167     int dst_inc, src_inc;
 168 };
 169
 170 typedef struct primitive_funcs
 171 {
 172     void            (* solid_rects)(const dib_info *dib, int num, const RECT *rc, DWORD and, DWORD xor);
 173     void             (* solid_line)(const dib_info *dib, const POINT *start, const struct line_params *params,
 174                                     DWORD and, DWORD xor);
 175     void          (* pattern_rects)(const dib_info *dib, int num, const RECT *rc, const POINT *orign,
 176                                     const dib_info *brush, void *and_bits, void *xor_bits);
 177     void              (* copy_rect)(const dib_info *dst, const RECT *rc, const dib_info *src,
 178                                     const POINT *origin, int rop2, int overlap);
 179     void             (* blend_rect)(const dib_info *dst, const RECT *rc, const dib_info *src,
 180                                     const POINT *origin, BLENDFUNCTION blend);
 181     BOOL          (* gradient_rect)(const dib_info *dib, const RECT *rc, const TRIVERTEX *v, int mode);
 182     void             (* draw_glyph)(const dib_info *dst, const RECT *rc, const dib_info *glyph,
 183                                     const POINT *origin, DWORD text_pixel, const struct intensity_range *ranges);
 184     DWORD             (* get_pixel)(const dib_info *dib, const POINT *pt);
 185     DWORD     (* colorref_to_pixel)(const dib_info *dib, COLORREF color);
 186     COLORREF  (* pixel_to_colorref)(const dib_info *dib, DWORD pixel);
 187     void             (* convert_to)(dib_info *dst, const dib_info *src, const RECT *src_rect);
 188     BOOL       (* create_rop_masks)(const dib_info *dib, const dib_info *hatch,
 189                                     const rop_mask *fg, const rop_mask *bg, rop_mask_bits *bits);
 190     void            (* stretch_row)(const dib_info *dst_dib, const POINT *dst_start,
 191                                     const dib_info *src_dib, const POINT *src_start,
 192                                     const struct stretch_params *params, int mode, BOOL keep_dst);
 193     void             (* shrink_row)(const dib_info *dst_dib, const POINT *dst_start,
 194                                     const dib_info *src_dib, const POINT *src_start,
 195                                     const struct stretch_params *params, int mode, BOOL keep_dst);
 196 } primitive_funcs;
 197
 198 extern const primitive_funcs funcs_8888 DECLSPEC_HIDDEN;
 199 extern const primitive_funcs funcs_32   DECLSPEC_HIDDEN;
 200 extern const primitive_funcs funcs_24   DECLSPEC_HIDDEN;
 201 extern const primitive_funcs funcs_555  DECLSPEC_HIDDEN;
 202 extern const primitive_funcs funcs_16   DECLSPEC_HIDDEN;
 203 extern const primitive_funcs funcs_8    DECLSPEC_HIDDEN;
 204 extern const primitive_funcs funcs_4    DECLSPEC_HIDDEN;
 205 extern const primitive_funcs funcs_1    DECLSPEC_HIDDEN;
 206 extern const primitive_funcs funcs_null DECLSPEC_HIDDEN;
 207
 208 struct rop_codes
 209 {
 210     DWORD a1, a2, x1, x2;
 211 };
 212
 213 #define OVERLAP_LEFT  0x01  /* dest starts left of source */
 214 #define OVERLAP_RIGHT 0x02  /* dest starts right of source */
 215 #define OVERLAP_ABOVE 0x04  /* dest starts above source */
 216 #define OVERLAP_BELOW 0x08  /* dest starts below source */
 217
 218 typedef struct
 219 {
 220     unsigned int dx, dy;
 221     int bias;
 222     DWORD octant;
 223 } bres_params;
 224
 225 extern void get_rop_codes(INT rop, struct rop_codes *codes) DECLSPEC_HIDDEN;
 226 extern void calc_and_xor_masks(INT rop, DWORD color, DWORD *and, DWORD *xor) DECLSPEC_HIDDEN;
 227 extern void update_brush_rop( dibdrv_physdev *pdev, INT rop ) DECLSPEC_HIDDEN;
 228 extern void reset_dash_origin(dibdrv_physdev *pdev) DECLSPEC_HIDDEN;
 229 extern BOOL init_dib_info_from_brush(dib_info *dib, const BITMAPINFO *bi, void *bits, UINT usage, HDC hdc) DECLSPEC_HIDDEN;
 230 extern BOOL init_dib_info_from_bitmapinfo(dib_info *dib, const BITMAPINFO *info, void *bits,
 231                                           enum dib_info_flags flags) DECLSPEC_HIDDEN;
 232 extern BOOL init_dib_info_from_bitmapobj(dib_info *dib, BITMAPOBJ *bmp, enum dib_info_flags flags) DECLSPEC_HIDDEN;
 233 extern void free_dib_info(dib_info *dib) DECLSPEC_HIDDEN;
 234 extern void free_pattern_brush(dibdrv_physdev *pdev) DECLSPEC_HIDDEN;
 235 extern void copy_dib_color_info(dib_info *dst, const dib_info *src) DECLSPEC_HIDDEN;
 236 extern BOOL convert_dib(dib_info *dst, const dib_info *src) DECLSPEC_HIDDEN;
 237 extern COLORREF make_rgb_colorref( HDC hdc, dib_info *dib, COLORREF color, BOOL *got_pixel, DWORD *pixel ) DECLSPEC_HIDDEN;
 238 extern DWORD get_pixel_color(dibdrv_physdev *pdev, COLORREF color, BOOL mono_fixup) DECLSPEC_HIDDEN;
 239 extern BOOL brush_rects( dibdrv_physdev *pdev, int num, const RECT *rects ) DECLSPEC_HIDDEN;
 240 extern void solid_rects( dib_info *dib, int num, const RECT *rects, const rop_mask *color, HRGN region ) DECLSPEC_HIDDEN;
 241 extern HRGN add_extra_clipping_region( dibdrv_physdev *pdev, HRGN rgn ) DECLSPEC_HIDDEN;
 242 extern void restore_clipping_region( dibdrv_physdev *pdev, HRGN rgn ) DECLSPEC_HIDDEN;
 243 extern int clip_line(const POINT *start, const POINT *end, const RECT *clip,
 244                      const bres_params *params, POINT *pt1, POINT *pt2) DECLSPEC_HIDDEN;
 245 extern void update_aa_ranges( dibdrv_physdev *pdev ) DECLSPEC_HIDDEN;
 246
 247 /* compute the x coordinate corresponding to y on the specified edge */
 248 static inline int edge_coord( int y, int x1, int y1, int x2, int y2 )
 249 {
 250     if (x2 > x1)  /* always follow the edge from right to left to get correct rounding */
 251         return x2 + (y - y2) * (x2 - x1) / (y2 - y1);
 252     else
 253         return x1 + (y - y1) * (x2 - x1) / (y2 - y1);
 254 }
 255
 256 static inline BOOL defer_pen(dibdrv_physdev *pdev)
 257 {
 258     return pdev->defer & (DEFER_FORMAT | DEFER_PEN);
 259 }
 260
 261 static inline BOOL defer_brush(dibdrv_physdev *pdev)
 262 {
 263     return pdev->defer & (DEFER_FORMAT | DEFER_BRUSH);
 264 }