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