wined3d: wined3d_device_get_creation_parameters() never fails.
[wine] / include / wine / gdi_driver.h
1 /*
2  * Definitions for Wine GDI drivers
3  *
4  * Copyright 2011 Alexandre Julliard
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 #ifndef __WINE_WINE_GDI_DRIVER_H
22 #define __WINE_WINE_GDI_DRIVER_H
23
24 #include "wine/list.h"
25
26 struct gdi_dc_funcs;
27 struct opengl_funcs;
28
29 typedef struct gdi_physdev
30 {
31     const struct gdi_dc_funcs *funcs;
32     struct gdi_physdev        *next;
33     HDC                        hdc;
34 } *PHYSDEV;
35
36 struct bitblt_coords
37 {
38     int  log_x;     /* original position and size, in logical coords */
39     int  log_y;
40     int  log_width;
41     int  log_height;
42     int  x;         /* mapped position and size, in device coords */
43     int  y;
44     int  width;
45     int  height;
46     RECT visrect;   /* rectangle clipped to the visible part, in device coords */
47     DWORD layout;   /* DC layout */
48 };
49
50 struct gdi_image_bits
51 {
52     void   *ptr;       /* pointer to the bits */
53     BOOL    is_copy;   /* whether this is a copy of the bits that can be modified */
54     void  (*free)(struct gdi_image_bits *);  /* callback for freeing the bits */
55     void   *param;     /* extra parameter for callback private use */
56 };
57
58 struct brush_pattern
59 {
60     BITMAPINFO           *info;     /* DIB info */
61     struct gdi_image_bits bits;     /* DIB bits */
62     UINT                  usage;    /* color usage for DIB info */
63 };
64
65 struct gdi_dc_funcs
66 {
67     INT      (*pAbortDoc)(PHYSDEV);
68     BOOL     (*pAbortPath)(PHYSDEV);
69     BOOL     (*pAlphaBlend)(PHYSDEV,struct bitblt_coords*,PHYSDEV,struct bitblt_coords*,BLENDFUNCTION);
70     BOOL     (*pAngleArc)(PHYSDEV,INT,INT,DWORD,FLOAT,FLOAT);
71     BOOL     (*pArc)(PHYSDEV,INT,INT,INT,INT,INT,INT,INT,INT);
72     BOOL     (*pArcTo)(PHYSDEV,INT,INT,INT,INT,INT,INT,INT,INT);
73     BOOL     (*pBeginPath)(PHYSDEV);
74     DWORD    (*pBlendImage)(PHYSDEV,BITMAPINFO*,const struct gdi_image_bits*,struct bitblt_coords*,struct bitblt_coords*,BLENDFUNCTION);
75     BOOL     (*pChord)(PHYSDEV,INT,INT,INT,INT,INT,INT,INT,INT);
76     BOOL     (*pCloseFigure)(PHYSDEV);
77     BOOL     (*pCreateCompatibleDC)(PHYSDEV,PHYSDEV*);
78     BOOL     (*pCreateDC)(PHYSDEV*,LPCWSTR,LPCWSTR,LPCWSTR,const DEVMODEW*);
79     BOOL     (*pDeleteDC)(PHYSDEV);
80     BOOL     (*pDeleteObject)(PHYSDEV,HGDIOBJ);
81     DWORD    (*pDeviceCapabilities)(LPSTR,LPCSTR,LPCSTR,WORD,LPSTR,LPDEVMODEA);
82     BOOL     (*pEllipse)(PHYSDEV,INT,INT,INT,INT);
83     INT      (*pEndDoc)(PHYSDEV);
84     INT      (*pEndPage)(PHYSDEV);
85     BOOL     (*pEndPath)(PHYSDEV);
86     BOOL     (*pEnumFonts)(PHYSDEV,LPLOGFONTW,FONTENUMPROCW,LPARAM);
87     INT      (*pEnumICMProfiles)(PHYSDEV,ICMENUMPROCW,LPARAM);
88     INT      (*pExcludeClipRect)(PHYSDEV,INT,INT,INT,INT);
89     INT      (*pExtDeviceMode)(LPSTR,HWND,LPDEVMODEA,LPSTR,LPSTR,LPDEVMODEA,LPSTR,DWORD);
90     INT      (*pExtEscape)(PHYSDEV,INT,INT,LPCVOID,INT,LPVOID);
91     BOOL     (*pExtFloodFill)(PHYSDEV,INT,INT,COLORREF,UINT);
92     INT      (*pExtSelectClipRgn)(PHYSDEV,HRGN,INT);
93     BOOL     (*pExtTextOut)(PHYSDEV,INT,INT,UINT,const RECT*,LPCWSTR,UINT,const INT*);
94     BOOL     (*pFillPath)(PHYSDEV);
95     BOOL     (*pFillRgn)(PHYSDEV,HRGN,HBRUSH);
96     BOOL     (*pFlattenPath)(PHYSDEV);
97     BOOL     (*pFontIsLinked)(PHYSDEV);
98     BOOL     (*pFrameRgn)(PHYSDEV,HRGN,HBRUSH,INT,INT);
99     BOOL     (*pGdiComment)(PHYSDEV,UINT,CONST BYTE*);
100     BOOL     (*pGdiRealizationInfo)(PHYSDEV,void*);
101     UINT     (*pGetBoundsRect)(PHYSDEV,RECT*,UINT);
102     BOOL     (*pGetCharABCWidths)(PHYSDEV,UINT,UINT,LPABC);
103     BOOL     (*pGetCharABCWidthsI)(PHYSDEV,UINT,UINT,WORD*,LPABC);
104     BOOL     (*pGetCharWidth)(PHYSDEV,UINT,UINT,LPINT);
105     INT      (*pGetDeviceCaps)(PHYSDEV,INT);
106     BOOL     (*pGetDeviceGammaRamp)(PHYSDEV,LPVOID);
107     DWORD    (*pGetFontData)(PHYSDEV,DWORD,DWORD,LPVOID,DWORD);
108     DWORD    (*pGetFontUnicodeRanges)(PHYSDEV,LPGLYPHSET);
109     DWORD    (*pGetGlyphIndices)(PHYSDEV,LPCWSTR,INT,LPWORD,DWORD);
110     DWORD    (*pGetGlyphOutline)(PHYSDEV,UINT,UINT,LPGLYPHMETRICS,DWORD,LPVOID,const MAT2*);
111     BOOL     (*pGetICMProfile)(PHYSDEV,LPDWORD,LPWSTR);
112     DWORD    (*pGetImage)(PHYSDEV,BITMAPINFO*,struct gdi_image_bits*,struct bitblt_coords*);
113     DWORD    (*pGetKerningPairs)(PHYSDEV,DWORD,LPKERNINGPAIR);
114     COLORREF (*pGetNearestColor)(PHYSDEV,COLORREF);
115     UINT     (*pGetOutlineTextMetrics)(PHYSDEV,UINT,LPOUTLINETEXTMETRICW);
116     COLORREF (*pGetPixel)(PHYSDEV,INT,INT);
117     UINT     (*pGetSystemPaletteEntries)(PHYSDEV,UINT,UINT,LPPALETTEENTRY);
118     UINT     (*pGetTextCharsetInfo)(PHYSDEV,LPFONTSIGNATURE,DWORD);
119     BOOL     (*pGetTextExtentExPoint)(PHYSDEV,LPCWSTR,INT,INT,LPINT,LPINT,LPSIZE);
120     BOOL     (*pGetTextExtentExPointI)(PHYSDEV,const WORD*,INT,INT,LPINT,LPINT,LPSIZE);
121     INT      (*pGetTextFace)(PHYSDEV,INT,LPWSTR);
122     BOOL     (*pGetTextMetrics)(PHYSDEV,TEXTMETRICW*);
123     BOOL     (*pGradientFill)(PHYSDEV,TRIVERTEX*,ULONG,void*,ULONG,ULONG);
124     INT      (*pIntersectClipRect)(PHYSDEV,INT,INT,INT,INT);
125     BOOL     (*pInvertRgn)(PHYSDEV,HRGN);
126     BOOL     (*pLineTo)(PHYSDEV,INT,INT);
127     BOOL     (*pModifyWorldTransform)(PHYSDEV,const XFORM*,DWORD);
128     BOOL     (*pMoveTo)(PHYSDEV,INT,INT);
129     INT      (*pOffsetClipRgn)(PHYSDEV,INT,INT);
130     BOOL     (*pOffsetViewportOrgEx)(PHYSDEV,INT,INT,POINT*);
131     BOOL     (*pOffsetWindowOrgEx)(PHYSDEV,INT,INT,POINT*);
132     BOOL     (*pPaintRgn)(PHYSDEV,HRGN);
133     BOOL     (*pPatBlt)(PHYSDEV,struct bitblt_coords*,DWORD);
134     BOOL     (*pPie)(PHYSDEV,INT,INT,INT,INT,INT,INT,INT,INT);
135     BOOL     (*pPolyBezier)(PHYSDEV,const POINT*,DWORD);
136     BOOL     (*pPolyBezierTo)(PHYSDEV,const POINT*,DWORD);
137     BOOL     (*pPolyDraw)(PHYSDEV,const POINT*,const BYTE *,DWORD);
138     BOOL     (*pPolyPolygon)(PHYSDEV,const POINT*,const INT*,UINT);
139     BOOL     (*pPolyPolyline)(PHYSDEV,const POINT*,const DWORD*,DWORD);
140     BOOL     (*pPolygon)(PHYSDEV,const POINT*,INT);
141     BOOL     (*pPolyline)(PHYSDEV,const POINT*,INT);
142     BOOL     (*pPolylineTo)(PHYSDEV,const POINT*,INT);
143     DWORD    (*pPutImage)(PHYSDEV,HRGN,BITMAPINFO*,const struct gdi_image_bits*,struct bitblt_coords*,struct bitblt_coords*,DWORD);
144     UINT     (*pRealizeDefaultPalette)(PHYSDEV);
145     UINT     (*pRealizePalette)(PHYSDEV,HPALETTE,BOOL);
146     BOOL     (*pRectangle)(PHYSDEV,INT,INT,INT,INT);
147     HDC      (*pResetDC)(PHYSDEV,const DEVMODEW*);
148     BOOL     (*pRestoreDC)(PHYSDEV,INT);
149     BOOL     (*pRoundRect)(PHYSDEV,INT,INT,INT,INT,INT,INT);
150     INT      (*pSaveDC)(PHYSDEV);
151     BOOL     (*pScaleViewportExtEx)(PHYSDEV,INT,INT,INT,INT,SIZE*);
152     BOOL     (*pScaleWindowExtEx)(PHYSDEV,INT,INT,INT,INT,SIZE*);
153     HBITMAP  (*pSelectBitmap)(PHYSDEV,HBITMAP);
154     HBRUSH   (*pSelectBrush)(PHYSDEV,HBRUSH,const struct brush_pattern*);
155     BOOL     (*pSelectClipPath)(PHYSDEV,INT);
156     HFONT    (*pSelectFont)(PHYSDEV,HFONT);
157     HPALETTE (*pSelectPalette)(PHYSDEV,HPALETTE,BOOL);
158     HPEN     (*pSelectPen)(PHYSDEV,HPEN,const struct brush_pattern*);
159     INT      (*pSetArcDirection)(PHYSDEV,INT);
160     COLORREF (*pSetBkColor)(PHYSDEV,COLORREF);
161     INT      (*pSetBkMode)(PHYSDEV,INT);
162     UINT     (*pSetBoundsRect)(PHYSDEV,RECT*,UINT);
163     COLORREF (*pSetDCBrushColor)(PHYSDEV, COLORREF);
164     COLORREF (*pSetDCPenColor)(PHYSDEV, COLORREF);
165     INT      (*pSetDIBitsToDevice)(PHYSDEV,INT,INT,DWORD,DWORD,INT,INT,UINT,UINT,LPCVOID,BITMAPINFO*,UINT);
166     VOID     (*pSetDeviceClipping)(PHYSDEV,HRGN);
167     BOOL     (*pSetDeviceGammaRamp)(PHYSDEV,LPVOID);
168     DWORD    (*pSetLayout)(PHYSDEV,DWORD);
169     INT      (*pSetMapMode)(PHYSDEV,INT);
170     DWORD    (*pSetMapperFlags)(PHYSDEV,DWORD);
171     COLORREF (*pSetPixel)(PHYSDEV,INT,INT,COLORREF);
172     INT      (*pSetPolyFillMode)(PHYSDEV,INT);
173     INT      (*pSetROP2)(PHYSDEV,INT);
174     INT      (*pSetRelAbs)(PHYSDEV,INT);
175     INT      (*pSetStretchBltMode)(PHYSDEV,INT);
176     UINT     (*pSetTextAlign)(PHYSDEV,UINT);
177     INT      (*pSetTextCharacterExtra)(PHYSDEV,INT);
178     COLORREF (*pSetTextColor)(PHYSDEV,COLORREF);
179     BOOL     (*pSetTextJustification)(PHYSDEV,INT,INT);
180     BOOL     (*pSetViewportExtEx)(PHYSDEV,INT,INT,SIZE*);
181     BOOL     (*pSetViewportOrgEx)(PHYSDEV,INT,INT,POINT*);
182     BOOL     (*pSetWindowExtEx)(PHYSDEV,INT,INT,SIZE*);
183     BOOL     (*pSetWindowOrgEx)(PHYSDEV,INT,INT,POINT*);
184     BOOL     (*pSetWorldTransform)(PHYSDEV,const XFORM*);
185     INT      (*pStartDoc)(PHYSDEV,const DOCINFOW*);
186     INT      (*pStartPage)(PHYSDEV);
187     BOOL     (*pStretchBlt)(PHYSDEV,struct bitblt_coords*,PHYSDEV,struct bitblt_coords*,DWORD);
188     INT      (*pStretchDIBits)(PHYSDEV,INT,INT,INT,INT,INT,INT,INT,INT,const void*,BITMAPINFO*,UINT,DWORD);
189     BOOL     (*pStrokeAndFillPath)(PHYSDEV);
190     BOOL     (*pStrokePath)(PHYSDEV);
191     BOOL     (*pUnrealizePalette)(HPALETTE);
192     BOOL     (*pWidenPath)(PHYSDEV);
193     struct opengl_funcs * (*wine_get_wgl_driver)(PHYSDEV,UINT);
194
195     /* priority order for the driver on the stack */
196     UINT       priority;
197 };
198
199 /* increment this when you change the DC function table */
200 #define WINE_GDI_DRIVER_VERSION 44
201
202 #define GDI_PRIORITY_NULL_DRV        0  /* null driver */
203 #define GDI_PRIORITY_FONT_DRV      100  /* any font driver */
204 #define GDI_PRIORITY_GRAPHICS_DRV  200  /* any graphics driver */
205 #define GDI_PRIORITY_DIB_DRV       300  /* the DIB driver */
206 #define GDI_PRIORITY_PATH_DRV      400  /* the path driver */
207
208 static inline PHYSDEV get_physdev_entry_point( PHYSDEV dev, size_t offset )
209 {
210     while (!((void **)dev->funcs)[offset / sizeof(void *)]) dev = dev->next;
211     return dev;
212 }
213
214 #define GET_NEXT_PHYSDEV(dev,func) \
215     get_physdev_entry_point( (dev)->next, FIELD_OFFSET(struct gdi_dc_funcs,func))
216
217 static inline void push_dc_driver( PHYSDEV *dev, PHYSDEV physdev, const struct gdi_dc_funcs *funcs )
218 {
219     while ((*dev)->funcs->priority > funcs->priority) dev = &(*dev)->next;
220     physdev->funcs = funcs;
221     physdev->next = *dev;
222     physdev->hdc = (*dev)->hdc;
223     *dev = physdev;
224 }
225
226 /* support for window surfaces */
227
228 struct window_surface;
229
230 struct window_surface_funcs
231 {
232     void  (*lock)( struct window_surface *surface );
233     void  (*unlock)( struct window_surface *surface );
234     void* (*get_info)( struct window_surface *surface, BITMAPINFO *info );
235     RECT* (*get_bounds)( struct window_surface *surface );
236     void  (*flush)( struct window_surface *surface );
237     void  (*destroy)( struct window_surface *surface );
238 };
239
240 struct window_surface
241 {
242     const struct window_surface_funcs *funcs; /* driver-specific implementations  */
243     struct list                        entry; /* entry in global list managed by user32 */
244     LONG                               ref;   /* reference count */
245     RECT                               rect;  /* constant, no locking needed */
246     /* driver-specific fields here */
247 };
248
249 static inline ULONG window_surface_add_ref( struct window_surface *surface )
250 {
251     return InterlockedIncrement( &surface->ref );
252 }
253
254 static inline ULONG window_surface_release( struct window_surface *surface )
255 {
256     ULONG ret = InterlockedDecrement( &surface->ref );
257     if (!ret) surface->funcs->destroy( surface );
258     return ret;
259 }
260
261 /* the DC hook support is only exported on Win16, the 32-bit version is a Wine extension */
262
263 #define DCHC_INVALIDVISRGN      0x0001
264 #define DCHC_DELETEDC           0x0002
265 #define DCHF_INVALIDATEVISRGN   0x0001
266 #define DCHF_VALIDATEVISRGN     0x0002
267
268 typedef BOOL (CALLBACK *DCHOOKPROC)(HDC,WORD,DWORD_PTR,LPARAM);
269
270 WINGDIAPI DWORD_PTR WINAPI GetDCHook(HDC,DCHOOKPROC*);
271 WINGDIAPI BOOL      WINAPI SetDCHook(HDC,DCHOOKPROC,DWORD_PTR);
272 WINGDIAPI WORD      WINAPI SetHookFlags(HDC,WORD);
273
274 extern void CDECL __wine_make_gdi_object_system( HGDIOBJ handle, BOOL set );
275 extern void CDECL __wine_set_visible_region( HDC hdc, HRGN hrgn, const RECT *vis_rect,
276                                              const RECT *device_rect, struct window_surface *surface );
277 extern struct opengl_funcs * CDECL __wine_get_wgl_driver( HDC hdc, UINT version );
278
279 #endif /* __WINE_WINE_GDI_DRIVER_H */