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     RECT rect;  /* visible rectangle relative to bitmap origin */
  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     const RGBQUAD *color_table;
  39     DWORD color_table_size;
  40
  41     const struct primitive_funcs *funcs;
  42 } dib_info;
  43
  44 typedef struct
  45 {
  46     DWORD count;
  47     DWORD dashes[16]; /* 16 is the maximum number for a PS_USERSTYLE pen */
  48     DWORD total_len;  /* total length of the dashes, should be multiplied by 2 if there are an odd number of dash lengths */
  49 } dash_pattern;
  50
  51 typedef struct
  52 {
  53     int left_in_dash;
  54     int cur_dash;
  55     BOOL mark;
  56 } dash_pos;
  57
  58 typedef struct
  59 {
  60     DWORD and;
  61     DWORD xor;
  62 } rop_mask;
  63
  64 typedef struct
  65 {
  66     void *and;
  67     void *xor;
  68 } rop_mask_bits;
  69
  70 struct dibdrv_physdev;
  71
  72 typedef struct dib_brush
  73 {
  74     UINT     style;
  75     UINT     hatch;
  76     INT      rop;   /* rop2 last used to create the brush bits */
  77     COLORREF colorref;
  78     dib_info dib;
  79     rop_mask_bits masks;
  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     RECT *bounds;
 100
 101     /* pen */
 102     DWORD pen_style, pen_endcap, pen_join;
 103     BOOL pen_uses_region, pen_is_ext;
 104     int pen_width;
 105     dib_brush pen_brush;
 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 extern BOOL     dibdrv_AlphaBlend( PHYSDEV dst_dev, struct bitblt_coords *dst,
 113                                    PHYSDEV src_dev, struct bitblt_coords *src, BLENDFUNCTION blend ) DECLSPEC_HIDDEN;
 114 extern BOOL     dibdrv_Arc( PHYSDEV dev, INT left, INT top, INT right, INT bottom,
 115                             INT start_x, INT start_y, INT end_x, INT end_y ) DECLSPEC_HIDDEN;
 116 extern BOOL     dibdrv_ArcTo( PHYSDEV dev, INT left, INT top, INT right, INT bottom,
 117                               INT start_x, INT start_y, INT end_x, INT end_y ) DECLSPEC_HIDDEN;
 118 extern DWORD    dibdrv_BlendImage( PHYSDEV dev, BITMAPINFO *info, const struct gdi_image_bits *bits,
 119                                    struct bitblt_coords *src, struct bitblt_coords *dst, BLENDFUNCTION func ) DECLSPEC_HIDDEN;
 120 extern BOOL     dibdrv_Chord( PHYSDEV dev, INT left, INT top, INT right, INT bottom,
 121                               INT start_x, INT start_y, INT end_x, INT end_y ) DECLSPEC_HIDDEN;
 122 extern BOOL     dibdrv_Ellipse( PHYSDEV dev, INT left, INT top, INT right, INT bottom ) DECLSPEC_HIDDEN;
 123 extern BOOL     dibdrv_ExtFloodFill( PHYSDEV dev, INT x, INT y, COLORREF color, UINT type ) DECLSPEC_HIDDEN;
 124 extern BOOL     dibdrv_ExtTextOut( PHYSDEV dev, INT x, INT y, UINT flags,
 125                                    const RECT *rect, LPCWSTR str, UINT count, const INT *dx ) DECLSPEC_HIDDEN;
 126 extern DWORD    dibdrv_GetImage( PHYSDEV dev, HBITMAP hbitmap, BITMAPINFO *info,
 127                                  struct gdi_image_bits *bits, struct bitblt_coords *src ) DECLSPEC_HIDDEN;
 128 extern COLORREF dibdrv_GetNearestColor( PHYSDEV dev, COLORREF color ) DECLSPEC_HIDDEN;
 129 extern COLORREF dibdrv_GetPixel( PHYSDEV dev, INT x, INT y ) DECLSPEC_HIDDEN;
 130 extern BOOL     dibdrv_GradientFill( PHYSDEV dev, TRIVERTEX *vert_array, ULONG nvert,
 131                                      void *grad_array, ULONG ngrad, ULONG mode ) DECLSPEC_HIDDEN;
 132 extern BOOL     dibdrv_LineTo( PHYSDEV dev, INT x, INT y ) DECLSPEC_HIDDEN;
 133 extern BOOL     dibdrv_PatBlt( PHYSDEV dev, struct bitblt_coords *dst, DWORD rop ) DECLSPEC_HIDDEN;
 134 extern BOOL     dibdrv_PaintRgn( PHYSDEV dev, HRGN hrgn ) DECLSPEC_HIDDEN;
 135 extern BOOL     dibdrv_Pie( PHYSDEV dev, INT left, INT top, INT right, INT bottom,
 136                             INT start_x, INT start_y, INT end_x, INT end_y ) DECLSPEC_HIDDEN;
 137 extern BOOL     dibdrv_PolyPolygon( PHYSDEV dev, const POINT *pt, const INT *counts, DWORD polygons ) DECLSPEC_HIDDEN;
 138 extern BOOL     dibdrv_PolyPolyline( PHYSDEV dev, const POINT* pt, const DWORD* counts,
 139                                      DWORD polylines ) DECLSPEC_HIDDEN;
 140 extern BOOL     dibdrv_Polygon( PHYSDEV dev, const POINT *pt, INT count ) DECLSPEC_HIDDEN;
 141 extern BOOL     dibdrv_Polyline( PHYSDEV dev, const POINT* pt, INT count ) DECLSPEC_HIDDEN;
 142 extern DWORD    dibdrv_PutImage( PHYSDEV dev, HBITMAP hbitmap, HRGN clip, BITMAPINFO *info,
 143                                  const struct gdi_image_bits *bits, struct bitblt_coords *src,
 144                                  struct bitblt_coords *dst, DWORD rop ) DECLSPEC_HIDDEN;
 145 extern BOOL     dibdrv_Rectangle( PHYSDEV dev, INT left, INT top, INT right, INT bottom ) DECLSPEC_HIDDEN;
 146 extern BOOL     dibdrv_RoundRect( PHYSDEV dev, INT left, INT top, INT right, INT bottom,
 147                                   INT ellipse_width, INT ellipse_height ) DECLSPEC_HIDDEN;
 148 extern HBRUSH   dibdrv_SelectBrush( PHYSDEV dev, HBRUSH hbrush, const struct brush_pattern *pattern ) DECLSPEC_HIDDEN;
 149 extern HPEN     dibdrv_SelectPen( PHYSDEV dev, HPEN hpen, const struct brush_pattern *pattern ) DECLSPEC_HIDDEN;
 150 extern COLORREF dibdrv_SetDCBrushColor( PHYSDEV dev, COLORREF color ) DECLSPEC_HIDDEN;
 151 extern COLORREF dibdrv_SetDCPenColor( PHYSDEV dev, COLORREF color ) DECLSPEC_HIDDEN;
 152 extern COLORREF dibdrv_SetPixel( PHYSDEV dev, INT x, INT y, COLORREF color ) DECLSPEC_HIDDEN;
 153 extern BOOL     dibdrv_StretchBlt( PHYSDEV dst_dev, struct bitblt_coords *dst,
 154                                    PHYSDEV src_dev, struct bitblt_coords *src, DWORD rop ) DECLSPEC_HIDDEN;
 155
 156 static inline dibdrv_physdev *get_dibdrv_pdev( PHYSDEV dev )
 157 {
 158     return (dibdrv_physdev *)dev;
 159 }
 160
 161 struct line_params
 162 {
 163     int err_start, err_add_1, err_add_2, bias;
 164     unsigned int length;
 165     int x_inc, y_inc;
 166     BOOL x_major;
 167 };
 168
 169 struct stretch_params
 170 {
 171     int err_start, err_add_1, err_add_2;
 172     unsigned int length;
 173     int dst_inc, src_inc;
 174 };
 175
 176 typedef struct primitive_funcs
 177 {
 178     void            (* solid_rects)(const dib_info *dib, int num, const RECT *rc, DWORD and, DWORD xor);
 179     void             (* solid_line)(const dib_info *dib, const POINT *start, const struct line_params *params,
 180                                     DWORD and, DWORD xor);
 181     void          (* pattern_rects)(const dib_info *dib, int num, const RECT *rc, const POINT *orign,
 182                                     const dib_info *brush, const rop_mask_bits *bits);
 183     void              (* copy_rect)(const dib_info *dst, const RECT *rc, const dib_info *src,
 184                                     const POINT *origin, int rop2, int overlap);
 185     void             (* blend_rect)(const dib_info *dst, const RECT *rc, const dib_info *src,
 186                                     const POINT *origin, BLENDFUNCTION blend);
 187     BOOL          (* gradient_rect)(const dib_info *dib, const RECT *rc, const TRIVERTEX *v, int mode);
 188     void             (* draw_glyph)(const dib_info *dst, const RECT *rc, const dib_info *glyph,
 189                                     const POINT *origin, DWORD text_pixel, const struct intensity_range *ranges);
 190     DWORD             (* get_pixel)(const dib_info *dib, int x, int y);
 191     DWORD     (* colorref_to_pixel)(const dib_info *dib, COLORREF color);
 192     COLORREF  (* pixel_to_colorref)(const dib_info *dib, DWORD pixel);
 193     void             (* convert_to)(dib_info *dst, const dib_info *src, const RECT *src_rect, BOOL dither);
 194     BOOL       (* create_rop_masks)(const dib_info *dib, const dib_info *hatch,
 195                                     const rop_mask *fg, const rop_mask *bg, rop_mask_bits *bits);
 196     void            (* stretch_row)(const dib_info *dst_dib, const POINT *dst_start,
 197                                     const dib_info *src_dib, const POINT *src_start,
 198                                     const struct stretch_params *params, int mode, BOOL keep_dst);
 199     void             (* shrink_row)(const dib_info *dst_dib, const POINT *dst_start,
 200                                     const dib_info *src_dib, const POINT *src_start,
 201                                     const struct stretch_params *params, int mode, BOOL keep_dst);
 202 } primitive_funcs;
 203
 204 extern const primitive_funcs funcs_8888 DECLSPEC_HIDDEN;
 205 extern const primitive_funcs funcs_32   DECLSPEC_HIDDEN;
 206 extern const primitive_funcs funcs_24   DECLSPEC_HIDDEN;
 207 extern const primitive_funcs funcs_555  DECLSPEC_HIDDEN;
 208 extern const primitive_funcs funcs_16   DECLSPEC_HIDDEN;
 209 extern const primitive_funcs funcs_8    DECLSPEC_HIDDEN;
 210 extern const primitive_funcs funcs_4    DECLSPEC_HIDDEN;
 211 extern const primitive_funcs funcs_1    DECLSPEC_HIDDEN;
 212 extern const primitive_funcs funcs_null DECLSPEC_HIDDEN;
 213
 214 struct rop_codes
 215 {
 216     DWORD a1, a2, x1, x2;
 217 };
 218
 219 #define OVERLAP_LEFT  0x01  /* dest starts left of source */
 220 #define OVERLAP_RIGHT 0x02  /* dest starts right of source */
 221 #define OVERLAP_ABOVE 0x04  /* dest starts above source */
 222 #define OVERLAP_BELOW 0x08  /* dest starts below source */
 223
 224 typedef struct
 225 {
 226     unsigned int dx, dy;
 227     int bias;
 228     DWORD octant;
 229 } bres_params;
 230
 231 struct clipped_rects
 232 {
 233     RECT *rects;
 234     int   count;
 235     RECT  buffer[32];
 236 };
 237
 238 extern void get_rop_codes(INT rop, struct rop_codes *codes) DECLSPEC_HIDDEN;
 239 extern void reset_dash_origin(dibdrv_physdev *pdev) DECLSPEC_HIDDEN;
 240 extern void init_dib_info_from_bitmapinfo(dib_info *dib, const BITMAPINFO *info, void *bits, enum dib_info_flags flags) DECLSPEC_HIDDEN;
 241 extern BOOL init_dib_info_from_bitmapobj(dib_info *dib, BITMAPOBJ *bmp, enum dib_info_flags flags) DECLSPEC_HIDDEN;
 242 extern void free_dib_info(dib_info *dib) DECLSPEC_HIDDEN;
 243 extern void free_pattern_brush(dib_brush *brush) DECLSPEC_HIDDEN;
 244 extern void copy_dib_color_info(dib_info *dst, const dib_info *src) DECLSPEC_HIDDEN;
 245 extern BOOL convert_dib(dib_info *dst, const dib_info *src) DECLSPEC_HIDDEN;
 246 extern COLORREF make_rgb_colorref( HDC hdc, dib_info *dib, COLORREF color, BOOL *got_pixel, DWORD *pixel ) DECLSPEC_HIDDEN;
 247 extern DWORD get_pixel_color(dibdrv_physdev *pdev, COLORREF color, BOOL mono_fixup) DECLSPEC_HIDDEN;
 248 extern BOOL brush_rect( dibdrv_physdev *pdev, dib_brush *brush, const RECT *rect, HRGN clip, INT rop ) DECLSPEC_HIDDEN;
 249 extern int get_clipped_rects( const dib_info *dib, const RECT *rc, HRGN clip, struct clipped_rects *clip_rects ) DECLSPEC_HIDDEN;
 250 extern void add_clipped_bounds( dibdrv_physdev *dev, const RECT *rect, HRGN clip ) 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 }