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     DWORD defer;
 100
 101     /* pen */
 102     COLORREF pen_colorref;
 103     DWORD pen_style, pen_endcap, pen_join;
 104     BOOL pen_uses_region, pen_is_ext;
 105     int pen_width;
 106     dash_pattern pen_pattern;
 107     dash_pos dash_pos;
 108     rop_mask dash_masks[2];
 109     BOOL   (* pen_lines)(struct dibdrv_physdev *pdev, int num, POINT *pts, BOOL close, HRGN region);
 110 } dibdrv_physdev;
 111
 112 #define DEFER_PEN        2
 113
 114 extern BOOL     dibdrv_AlphaBlend( PHYSDEV dst_dev, struct bitblt_coords *dst,
 115                                    PHYSDEV src_dev, struct bitblt_coords *src, BLENDFUNCTION blend ) DECLSPEC_HIDDEN;
 116 extern DWORD    dibdrv_BlendImage( PHYSDEV dev, BITMAPINFO *info, const struct gdi_image_bits *bits,
 117                                    struct bitblt_coords *src, struct bitblt_coords *dst, BLENDFUNCTION func ) DECLSPEC_HIDDEN;
 118 extern BOOL     dibdrv_GradientFill( PHYSDEV dev, TRIVERTEX *vert_array, ULONG nvert,
 119                                      void *grad_array, ULONG ngrad, ULONG mode ) DECLSPEC_HIDDEN;
 120 extern BOOL     dibdrv_ExtTextOut( PHYSDEV dev, INT x, INT y, UINT flags,
 121                                    const RECT *rect, LPCWSTR str, UINT count, const INT *dx ) DECLSPEC_HIDDEN;
 122 extern DWORD    dibdrv_GetImage( PHYSDEV dev, HBITMAP hbitmap, BITMAPINFO *info,
 123                                  struct gdi_image_bits *bits, struct bitblt_coords *src ) DECLSPEC_HIDDEN;
 124 extern COLORREF dibdrv_GetNearestColor( PHYSDEV dev, COLORREF color ) DECLSPEC_HIDDEN;
 125 extern COLORREF dibdrv_GetPixel( PHYSDEV dev, INT x, INT y ) DECLSPEC_HIDDEN;
 126 extern BOOL     dibdrv_LineTo( PHYSDEV dev, INT x, INT y ) DECLSPEC_HIDDEN;
 127 extern BOOL     dibdrv_PatBlt( PHYSDEV dev, struct bitblt_coords *dst, DWORD rop ) DECLSPEC_HIDDEN;
 128 extern BOOL     dibdrv_PaintRgn( PHYSDEV dev, HRGN hrgn ) DECLSPEC_HIDDEN;
 129 extern BOOL     dibdrv_PolyPolygon( PHYSDEV dev, const POINT *pt, const INT *counts, DWORD polygons ) DECLSPEC_HIDDEN;
 130 extern BOOL     dibdrv_PolyPolyline( PHYSDEV dev, const POINT* pt, const DWORD* counts,
 131                                      DWORD polylines ) DECLSPEC_HIDDEN;
 132 extern BOOL     dibdrv_Polygon( PHYSDEV dev, const POINT *pt, INT count ) DECLSPEC_HIDDEN;
 133 extern BOOL     dibdrv_Polyline( PHYSDEV dev, const POINT* pt, INT count ) DECLSPEC_HIDDEN;
 134 extern DWORD    dibdrv_PutImage( PHYSDEV dev, HBITMAP hbitmap, HRGN clip, BITMAPINFO *info,
 135                                  const struct gdi_image_bits *bits, struct bitblt_coords *src,
 136                                  struct bitblt_coords *dst, DWORD rop ) DECLSPEC_HIDDEN;
 137 extern BOOL     dibdrv_Rectangle( PHYSDEV dev, INT left, INT top, INT right, INT bottom ) DECLSPEC_HIDDEN;
 138 extern HBRUSH   dibdrv_SelectBrush( PHYSDEV dev, HBRUSH hbrush, const struct brush_pattern *pattern ) DECLSPEC_HIDDEN;
 139 extern HPEN     dibdrv_SelectPen( PHYSDEV dev, HPEN hpen, const struct brush_pattern *pattern ) DECLSPEC_HIDDEN;
 140 extern COLORREF dibdrv_SetDCBrushColor( PHYSDEV dev, COLORREF color ) DECLSPEC_HIDDEN;
 141 extern COLORREF dibdrv_SetDCPenColor( PHYSDEV dev, COLORREF color ) DECLSPEC_HIDDEN;
 142 extern COLORREF dibdrv_SetPixel( PHYSDEV dev, INT x, INT y, COLORREF color ) DECLSPEC_HIDDEN;
 143 extern BOOL     dibdrv_StretchBlt( PHYSDEV dst_dev, struct bitblt_coords *dst,
 144                                    PHYSDEV src_dev, struct bitblt_coords *src, DWORD rop ) DECLSPEC_HIDDEN;
 145
 146 static inline dibdrv_physdev *get_dibdrv_pdev( PHYSDEV dev )
 147 {
 148     return (dibdrv_physdev *)dev;
 149 }
 150
 151 struct line_params
 152 {
 153     int err_start, err_add_1, err_add_2, bias;
 154     unsigned int length;
 155     int x_inc, y_inc;
 156     BOOL x_major;
 157 };
 158
 159 struct stretch_params
 160 {
 161     int err_start, err_add_1, err_add_2;
 162     unsigned int length;
 163     int dst_inc, src_inc;
 164 };
 165
 166 typedef struct primitive_funcs
 167 {
 168     void            (* solid_rects)(const dib_info *dib, int num, const RECT *rc, DWORD and, DWORD xor);
 169     void             (* solid_line)(const dib_info *dib, const POINT *start, const struct line_params *params,
 170                                     DWORD and, DWORD xor);
 171     void          (* pattern_rects)(const dib_info *dib, int num, const RECT *rc, const POINT *orign,
 172                                     const dib_info *brush, void *and_bits, void *xor_bits);
 173     void              (* copy_rect)(const dib_info *dst, const RECT *rc, const dib_info *src,
 174                                     const POINT *origin, int rop2, int overlap);
 175     void             (* blend_rect)(const dib_info *dst, const RECT *rc, const dib_info *src,
 176                                     const POINT *origin, BLENDFUNCTION blend);
 177     BOOL          (* gradient_rect)(const dib_info *dib, const RECT *rc, const TRIVERTEX *v, int mode);
 178     void             (* draw_glyph)(const dib_info *dst, const RECT *rc, const dib_info *glyph,
 179                                     const POINT *origin, DWORD text_pixel, const struct intensity_range *ranges);
 180     DWORD             (* get_pixel)(const dib_info *dib, const POINT *pt);
 181     DWORD     (* colorref_to_pixel)(const dib_info *dib, COLORREF color);
 182     COLORREF  (* pixel_to_colorref)(const dib_info *dib, DWORD pixel);
 183     void             (* convert_to)(dib_info *dst, const dib_info *src, const RECT *src_rect);
 184     BOOL       (* create_rop_masks)(const dib_info *dib, const dib_info *hatch,
 185                                     const rop_mask *fg, const rop_mask *bg, rop_mask_bits *bits);
 186     void            (* stretch_row)(const dib_info *dst_dib, const POINT *dst_start,
 187                                     const dib_info *src_dib, const POINT *src_start,
 188                                     const struct stretch_params *params, int mode, BOOL keep_dst);
 189     void             (* shrink_row)(const dib_info *dst_dib, const POINT *dst_start,
 190                                     const dib_info *src_dib, const POINT *src_start,
 191                                     const struct stretch_params *params, int mode, BOOL keep_dst);
 192 } primitive_funcs;
 193
 194 extern const primitive_funcs funcs_8888 DECLSPEC_HIDDEN;
 195 extern const primitive_funcs funcs_32   DECLSPEC_HIDDEN;
 196 extern const primitive_funcs funcs_24   DECLSPEC_HIDDEN;
 197 extern const primitive_funcs funcs_555  DECLSPEC_HIDDEN;
 198 extern const primitive_funcs funcs_16   DECLSPEC_HIDDEN;
 199 extern const primitive_funcs funcs_8    DECLSPEC_HIDDEN;
 200 extern const primitive_funcs funcs_4    DECLSPEC_HIDDEN;
 201 extern const primitive_funcs funcs_1    DECLSPEC_HIDDEN;
 202 extern const primitive_funcs funcs_null DECLSPEC_HIDDEN;
 203
 204 struct rop_codes
 205 {
 206     DWORD a1, a2, x1, x2;
 207 };
 208
 209 #define OVERLAP_LEFT  0x01  /* dest starts left of source */
 210 #define OVERLAP_RIGHT 0x02  /* dest starts right of source */
 211 #define OVERLAP_ABOVE 0x04  /* dest starts above source */
 212 #define OVERLAP_BELOW 0x08  /* dest starts below source */
 213
 214 typedef struct
 215 {
 216     unsigned int dx, dy;
 217     int bias;
 218     DWORD octant;
 219 } bres_params;
 220
 221 struct clipped_rects
 222 {
 223     RECT *rects;
 224     int   count;
 225     RECT  buffer[32];
 226 };
 227
 228 extern void get_rop_codes(INT rop, struct rop_codes *codes) DECLSPEC_HIDDEN;
 229 extern void reset_dash_origin(dibdrv_physdev *pdev) DECLSPEC_HIDDEN;
 230 extern void init_dib_info_from_bitmapinfo(dib_info *dib, const BITMAPINFO *info, void *bits, enum dib_info_flags flags) DECLSPEC_HIDDEN;
 231 extern BOOL init_dib_info_from_bitmapobj(dib_info *dib, BITMAPOBJ *bmp, enum dib_info_flags flags) DECLSPEC_HIDDEN;
 232 extern void free_dib_info(dib_info *dib) DECLSPEC_HIDDEN;
 233 extern void free_pattern_brush(dib_brush *brush) DECLSPEC_HIDDEN;
 234 extern void copy_dib_color_info(dib_info *dst, const dib_info *src) DECLSPEC_HIDDEN;
 235 extern BOOL convert_dib(dib_info *dst, const dib_info *src) DECLSPEC_HIDDEN;
 236 extern COLORREF make_rgb_colorref( HDC hdc, dib_info *dib, COLORREF color, BOOL *got_pixel, DWORD *pixel ) DECLSPEC_HIDDEN;
 237 extern DWORD get_pixel_color(dibdrv_physdev *pdev, COLORREF color, BOOL mono_fixup) DECLSPEC_HIDDEN;
 238 extern BOOL brush_rect( dibdrv_physdev *pdev, dib_brush *brush, const RECT *rect, HRGN clip, INT rop ) DECLSPEC_HIDDEN;
 239 extern BOOL brush_region( dibdrv_physdev *pdev, HRGN region ) DECLSPEC_HIDDEN;
 240 extern BOOL pen_region( dibdrv_physdev *pdev, HRGN region ) DECLSPEC_HIDDEN;
 241 extern int get_clipped_rects( const dib_info *dib, const RECT *rc, HRGN clip, struct clipped_rects *clip_rects ) DECLSPEC_HIDDEN;
 242 extern int clip_line(const POINT *start, const POINT *end, const RECT *clip,
 243                      const bres_params *params, POINT *pt1, POINT *pt2) DECLSPEC_HIDDEN;
 244
 245 static inline void init_clipped_rects( struct clipped_rects *clip_rects )
 246 {
 247     clip_rects->count = 0;
 248     clip_rects->rects = clip_rects->buffer;
 249 }
 250
 251 static inline void free_clipped_rects( struct clipped_rects *clip_rects )
 252 {
 253     if (clip_rects->rects != clip_rects->buffer) HeapFree( GetProcessHeap(), 0, clip_rects->rects );
 254 }
 255
 256 /* compute the x coordinate corresponding to y on the specified edge */
 257 static inline int edge_coord( int y, int x1, int y1, int x2, int y2 )
 258 {
 259     if (x2 > x1)  /* always follow the edge from right to left to get correct rounding */
 260         return x2 + (y - y2) * (x2 - x1) / (y2 - y1);
 261     else
 262         return x1 + (y - y1) * (x2 - x1) / (y2 - y1);
 263 }
 264
 265 static inline BOOL defer_pen(dibdrv_physdev *pdev)
 266 {
 267     return pdev->defer & DEFER_PEN;
 268 }