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
  67 typedef struct dib_brush
  68 {
  69     UINT     style;
  70     UINT     hatch;
  71     INT      rop;   /* rop2 last used to create the brush bits */
  72     COLORREF colorref;
  73     dib_info dib;
  74     rop_mask_bits masks;
  75     struct brush_pattern pattern;
  76     BOOL (*rects)(struct dibdrv_physdev *pdev, struct dib_brush *brush, dib_info *dib,
  77                   int num, const RECT *rects, INT rop);
  78 } dib_brush;
  79
  80 struct intensity_range
  81 {
  82     BYTE r_min, r_max;
  83     BYTE g_min, g_max;
  84     BYTE b_min, b_max;
  85 };
  86
  87 typedef struct dibdrv_physdev
  88 {
  89     struct gdi_physdev dev;
  90     dib_info dib;
  91     dib_brush brush;
  92
  93     HRGN clip;
  94     RECT *bounds;
  95
  96     /* pen */
  97     DWORD pen_style, pen_endcap, pen_join;
  98     BOOL pen_uses_region, pen_is_ext;
  99     int pen_width;
 100     dib_brush pen_brush;
 101     dash_pattern pen_pattern;
 102     dash_pos dash_pos;
 103     rop_mask dash_masks[2];
 104     BOOL   (* pen_lines)(struct dibdrv_physdev *pdev, int num, POINT *pts, BOOL close, HRGN region);
 105 } dibdrv_physdev;
 106
 107 extern BOOL     dibdrv_AlphaBlend( PHYSDEV dst_dev, struct bitblt_coords *dst,
 108                                    PHYSDEV src_dev, struct bitblt_coords *src, BLENDFUNCTION blend ) DECLSPEC_HIDDEN;
 109 extern BOOL     dibdrv_Arc( PHYSDEV dev, INT left, INT top, INT right, INT bottom,
 110                             INT start_x, INT start_y, INT end_x, INT end_y ) DECLSPEC_HIDDEN;
 111 extern BOOL     dibdrv_ArcTo( 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 DWORD    dibdrv_BlendImage( PHYSDEV dev, BITMAPINFO *info, const struct gdi_image_bits *bits,
 114                                    struct bitblt_coords *src, struct bitblt_coords *dst, BLENDFUNCTION func ) DECLSPEC_HIDDEN;
 115 extern BOOL     dibdrv_Chord( 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 int      dibdrv_DescribePixelFormat( PHYSDEV dev, int fmt, UINT size, PIXELFORMATDESCRIPTOR *descr ) DECLSPEC_HIDDEN;
 118 extern BOOL     dibdrv_Ellipse( PHYSDEV dev, INT left, INT top, INT right, INT bottom ) DECLSPEC_HIDDEN;
 119 extern BOOL     dibdrv_ExtFloodFill( PHYSDEV dev, INT x, INT y, COLORREF color, UINT type ) 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, BITMAPINFO *info, struct gdi_image_bits *bits,
 123                                  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_GradientFill( PHYSDEV dev, TRIVERTEX *vert_array, ULONG nvert,
 127                                      void *grad_array, ULONG ngrad, ULONG mode ) DECLSPEC_HIDDEN;
 128 extern BOOL     dibdrv_LineTo( PHYSDEV dev, INT x, INT y ) DECLSPEC_HIDDEN;
 129 extern BOOL     dibdrv_PatBlt( PHYSDEV dev, struct bitblt_coords *dst, DWORD rop ) DECLSPEC_HIDDEN;
 130 extern BOOL     dibdrv_PaintRgn( PHYSDEV dev, HRGN hrgn ) DECLSPEC_HIDDEN;
 131 extern BOOL     dibdrv_Pie( PHYSDEV dev, INT left, INT top, INT right, INT bottom,
 132                             INT start_x, INT start_y, INT end_x, INT end_y ) DECLSPEC_HIDDEN;
 133 extern BOOL     dibdrv_PolyPolygon( PHYSDEV dev, const POINT *pt, const INT *counts, DWORD polygons ) DECLSPEC_HIDDEN;
 134 extern BOOL     dibdrv_PolyPolyline( PHYSDEV dev, const POINT* pt, const DWORD* counts,
 135                                      DWORD polylines ) DECLSPEC_HIDDEN;
 136 extern BOOL     dibdrv_Polygon( PHYSDEV dev, const POINT *pt, INT count ) DECLSPEC_HIDDEN;
 137 extern BOOL     dibdrv_Polyline( PHYSDEV dev, const POINT* pt, INT count ) DECLSPEC_HIDDEN;
 138 extern DWORD    dibdrv_PutImage( PHYSDEV dev, HRGN clip, BITMAPINFO *info,
 139                                  const struct gdi_image_bits *bits, struct bitblt_coords *src,
 140                                  struct bitblt_coords *dst, DWORD rop ) DECLSPEC_HIDDEN;
 141 extern BOOL     dibdrv_Rectangle( PHYSDEV dev, INT left, INT top, INT right, INT bottom ) DECLSPEC_HIDDEN;
 142 extern BOOL     dibdrv_RoundRect( PHYSDEV dev, INT left, INT top, INT right, INT bottom,
 143                                   INT ellipse_width, INT ellipse_height ) DECLSPEC_HIDDEN;
 144 extern HBRUSH   dibdrv_SelectBrush( PHYSDEV dev, HBRUSH hbrush, const struct brush_pattern *pattern ) DECLSPEC_HIDDEN;
 145 extern HPEN     dibdrv_SelectPen( PHYSDEV dev, HPEN hpen, const struct brush_pattern *pattern ) DECLSPEC_HIDDEN;
 146 extern COLORREF dibdrv_SetDCBrushColor( PHYSDEV dev, COLORREF color ) DECLSPEC_HIDDEN;
 147 extern COLORREF dibdrv_SetDCPenColor( PHYSDEV dev, COLORREF color ) DECLSPEC_HIDDEN;
 148 extern COLORREF dibdrv_SetPixel( PHYSDEV dev, INT x, INT y, COLORREF color ) DECLSPEC_HIDDEN;
 149 extern BOOL     dibdrv_SetPixelFormat( PHYSDEV dev, int fmt, const PIXELFORMATDESCRIPTOR *descr ) DECLSPEC_HIDDEN;
 150 extern BOOL     dibdrv_StretchBlt( PHYSDEV dst_dev, struct bitblt_coords *dst,
 151                                    PHYSDEV src_dev, struct bitblt_coords *src, DWORD rop ) DECLSPEC_HIDDEN;
 152 extern struct opengl_funcs *dibdrv_wine_get_wgl_driver( PHYSDEV dev, UINT version ) DECLSPEC_HIDDEN;
 153
 154 static inline dibdrv_physdev *get_dibdrv_pdev( PHYSDEV dev )
 155 {
 156     return (dibdrv_physdev *)dev;
 157 }
 158
 159 struct line_params
 160 {
 161     int err_start, err_add_1, err_add_2, bias;
 162     unsigned int length;
 163     int x_inc, y_inc;
 164     BOOL x_major;
 165 };
 166
 167 struct stretch_params
 168 {
 169     int err_start, err_add_1, err_add_2;
 170     unsigned int length;
 171     int dst_inc, src_inc;
 172 };
 173
 174 typedef struct primitive_funcs
 175 {
 176     void            (* solid_rects)(const dib_info *dib, int num, const RECT *rc, DWORD and, DWORD xor);
 177     void             (* solid_line)(const dib_info *dib, const POINT *start, const struct line_params *params,
 178                                     DWORD and, DWORD xor);
 179     void          (* pattern_rects)(const dib_info *dib, int num, const RECT *rc, const POINT *orign,
 180                                     const dib_info *brush, const rop_mask_bits *bits);
 181     void              (* copy_rect)(const dib_info *dst, const RECT *rc, const dib_info *src,
 182                                     const POINT *origin, int rop2, int overlap);
 183     void             (* blend_rect)(const dib_info *dst, const RECT *rc, const dib_info *src,
 184                                     const POINT *origin, BLENDFUNCTION blend);
 185     BOOL          (* gradient_rect)(const dib_info *dib, const RECT *rc, const TRIVERTEX *v, int mode);
 186     void             (* draw_glyph)(const dib_info *dst, const RECT *rc, const dib_info *glyph,
 187                                     const POINT *origin, DWORD text_pixel, const struct intensity_range *ranges);
 188     DWORD             (* get_pixel)(const dib_info *dib, int x, int y);
 189     DWORD     (* colorref_to_pixel)(const dib_info *dib, COLORREF color);
 190     COLORREF  (* pixel_to_colorref)(const dib_info *dib, DWORD pixel);
 191     void             (* convert_to)(dib_info *dst, const dib_info *src, const RECT *src_rect, BOOL dither);
 192     void       (* create_rop_masks)(const dib_info *dib, const BYTE *hatch_ptr,
 193                                     const rop_mask *fg, const rop_mask *bg, rop_mask_bits *bits);
 194     void    (* create_dither_masks)(const dib_info *dib, int rop2, COLORREF color, 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) DECLSPEC_HIDDEN;
 240 extern BOOL init_dib_info_from_bitmapobj(dib_info *dib, BITMAPOBJ *bmp) 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 int clip_rect_to_dib( const dib_info *dib, RECT *rc ) DECLSPEC_HIDDEN;
 248 extern int get_clipped_rects( const dib_info *dib, const RECT *rc, HRGN clip, struct clipped_rects *clip_rects ) DECLSPEC_HIDDEN;
 249 extern void add_clipped_bounds( dibdrv_physdev *dev, const RECT *rect, HRGN clip ) DECLSPEC_HIDDEN;
 250 extern int clip_line(const POINT *start, const POINT *end, const RECT *clip,
 251                      const bres_params *params, POINT *pt1, POINT *pt2) DECLSPEC_HIDDEN;
 252
 253 static inline void init_clipped_rects( struct clipped_rects *clip_rects )
 254 {
 255     clip_rects->count = 0;
 256     clip_rects->rects = clip_rects->buffer;
 257 }
 258
 259 static inline void free_clipped_rects( struct clipped_rects *clip_rects )
 260 {
 261     if (clip_rects->rects != clip_rects->buffer) HeapFree( GetProcessHeap(), 0, clip_rects->rects );
 262 }
 263
 264 /* compute the x coordinate corresponding to y on the specified edge */
 265 static inline int edge_coord( int y, int x1, int y1, int x2, int y2 )
 266 {
 267     if (x2 > x1)  /* always follow the edge from right to left to get correct rounding */
 268         return x2 + (y - y2) * (x2 - x1) / (y2 - y1);
 269     else
 270         return x1 + (y - y1) * (x2 - x1) / (y2 - y1);
 271 }
 272
 273 static inline const RGBQUAD *get_dib_color_table( const dib_info *dib )
 274 {
 275     return dib->color_table ? dib->color_table : get_default_color_table( dib->bit_count );
 276 }