gdi32: Leave it up to the driver to push the new device on the DC stack in CreateDC.
[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 struct gdi_dc_funcs;
25
26 typedef struct gdi_physdev
27 {
28     const struct gdi_dc_funcs *funcs;
29     struct gdi_physdev        *next;
30     HDC                        hdc;
31 } *PHYSDEV;
32
33 struct bitblt_coords
34 {
35     int  log_x;     /* original position and size, in logical coords */
36     int  log_y;
37     int  log_width;
38     int  log_height;
39     int  x;         /* mapped position and size, in device coords */
40     int  y;
41     int  width;
42     int  height;
43     RECT visrect;   /* rectangle clipped to the visible part, in device coords */
44     DWORD layout;   /* DC layout */
45 };
46
47 struct gdi_image_bits
48 {
49     void   *ptr;       /* pointer to the bits */
50     BOOL    is_copy;   /* whether this is a copy of the bits that can be modified */
51     void  (*free)(struct gdi_image_bits *);  /* callback for freeing the bits */
52     void   *param;     /* extra parameter for callback private use */
53 };
54
55 struct gdi_dc_funcs
56 {
57     INT      (*pAbortDoc)(PHYSDEV);
58     BOOL     (*pAbortPath)(PHYSDEV);
59     BOOL     (*pAlphaBlend)(PHYSDEV,struct bitblt_coords*,PHYSDEV,struct bitblt_coords*,BLENDFUNCTION);
60     BOOL     (*pAngleArc)(PHYSDEV,INT,INT,DWORD,FLOAT,FLOAT);
61     BOOL     (*pArc)(PHYSDEV,INT,INT,INT,INT,INT,INT,INT,INT);
62     BOOL     (*pArcTo)(PHYSDEV,INT,INT,INT,INT,INT,INT,INT,INT);
63     BOOL     (*pBeginPath)(PHYSDEV);
64     INT      (*pChoosePixelFormat)(PHYSDEV,const PIXELFORMATDESCRIPTOR *);
65     BOOL     (*pChord)(PHYSDEV,INT,INT,INT,INT,INT,INT,INT,INT);
66     BOOL     (*pCloseFigure)(PHYSDEV);
67     BOOL     (*pCreateBitmap)(PHYSDEV,HBITMAP);
68     BOOL     (*pCreateCompatibleDC)(PHYSDEV,PHYSDEV*);
69     BOOL     (*pCreateDC)(PHYSDEV*,LPCWSTR,LPCWSTR,LPCWSTR,const DEVMODEW*);
70     HBITMAP  (*pCreateDIBSection)(PHYSDEV,HBITMAP,BITMAPINFO *,UINT);
71     BOOL     (*pDeleteBitmap)(HBITMAP);
72     BOOL     (*pDeleteDC)(PHYSDEV);
73     BOOL     (*pDeleteObject)(PHYSDEV,HGDIOBJ);
74     INT      (*pDescribePixelFormat)(PHYSDEV,INT,UINT,PIXELFORMATDESCRIPTOR *);
75     DWORD    (*pDeviceCapabilities)(LPSTR,LPCSTR,LPCSTR,WORD,LPSTR,LPDEVMODEA);
76     BOOL     (*pEllipse)(PHYSDEV,INT,INT,INT,INT);
77     INT      (*pEndDoc)(PHYSDEV);
78     INT      (*pEndPage)(PHYSDEV);
79     BOOL     (*pEndPath)(PHYSDEV);
80     BOOL     (*pEnumDeviceFonts)(PHYSDEV,LPLOGFONTW,FONTENUMPROCW,LPARAM);
81     INT      (*pEnumICMProfiles)(PHYSDEV,ICMENUMPROCW,LPARAM);
82     INT      (*pExcludeClipRect)(PHYSDEV,INT,INT,INT,INT);
83     INT      (*pExtDeviceMode)(LPSTR,HWND,LPDEVMODEA,LPSTR,LPSTR,LPDEVMODEA,LPSTR,DWORD);
84     INT      (*pExtEscape)(PHYSDEV,INT,INT,LPCVOID,INT,LPVOID);
85     BOOL     (*pExtFloodFill)(PHYSDEV,INT,INT,COLORREF,UINT);
86     INT      (*pExtSelectClipRgn)(PHYSDEV,HRGN,INT);
87     BOOL     (*pExtTextOut)(PHYSDEV,INT,INT,UINT,const RECT*,LPCWSTR,UINT,const INT*);
88     BOOL     (*pFillPath)(PHYSDEV);
89     BOOL     (*pFillRgn)(PHYSDEV,HRGN,HBRUSH);
90     BOOL     (*pFlattenPath)(PHYSDEV);
91     BOOL     (*pFrameRgn)(PHYSDEV,HRGN,HBRUSH,INT,INT);
92     BOOL     (*pGdiComment)(PHYSDEV,UINT,CONST BYTE*);
93     BOOL     (*pGetCharWidth)(PHYSDEV,UINT,UINT,LPINT);
94     INT      (*pGetDeviceCaps)(PHYSDEV,INT);
95     BOOL     (*pGetDeviceGammaRamp)(PHYSDEV,LPVOID);
96     BOOL     (*pGetICMProfile)(PHYSDEV,LPDWORD,LPWSTR);
97     DWORD    (*pGetImage)(PHYSDEV,HBITMAP,BITMAPINFO*,struct gdi_image_bits*,struct bitblt_coords*);
98     COLORREF (*pGetNearestColor)(PHYSDEV,COLORREF);
99     COLORREF (*pGetPixel)(PHYSDEV,INT,INT);
100     INT      (*pGetPixelFormat)(PHYSDEV);
101     UINT     (*pGetSystemPaletteEntries)(PHYSDEV,UINT,UINT,LPPALETTEENTRY);
102     BOOL     (*pGetTextExtentExPoint)(PHYSDEV,LPCWSTR,INT,INT,LPINT,LPINT,LPSIZE);
103     BOOL     (*pGetTextMetrics)(PHYSDEV,TEXTMETRICW*);
104     INT      (*pIntersectClipRect)(PHYSDEV,INT,INT,INT,INT);
105     BOOL     (*pInvertRgn)(PHYSDEV,HRGN);
106     BOOL     (*pLineTo)(PHYSDEV,INT,INT);
107     BOOL     (*pModifyWorldTransform)(PHYSDEV,const XFORM*,DWORD);
108     BOOL     (*pMoveTo)(PHYSDEV,INT,INT);
109     INT      (*pOffsetClipRgn)(PHYSDEV,INT,INT);
110     BOOL     (*pOffsetViewportOrgEx)(PHYSDEV,INT,INT,POINT*);
111     BOOL     (*pOffsetWindowOrgEx)(PHYSDEV,INT,INT,POINT*);
112     BOOL     (*pPaintRgn)(PHYSDEV,HRGN);
113     BOOL     (*pPatBlt)(PHYSDEV,struct bitblt_coords*,DWORD);
114     BOOL     (*pPie)(PHYSDEV,INT,INT,INT,INT,INT,INT,INT,INT);
115     BOOL     (*pPolyBezier)(PHYSDEV,const POINT*,DWORD);
116     BOOL     (*pPolyBezierTo)(PHYSDEV,const POINT*,DWORD);
117     BOOL     (*pPolyDraw)(PHYSDEV,const POINT*,const BYTE *,DWORD);
118     BOOL     (*pPolyPolygon)(PHYSDEV,const POINT*,const INT*,UINT);
119     BOOL     (*pPolyPolyline)(PHYSDEV,const POINT*,const DWORD*,DWORD);
120     BOOL     (*pPolygon)(PHYSDEV,const POINT*,INT);
121     BOOL     (*pPolyline)(PHYSDEV,const POINT*,INT);
122     BOOL     (*pPolylineTo)(PHYSDEV,const POINT*,INT);
123     DWORD    (*pPutImage)(PHYSDEV,HBITMAP,HRGN,BITMAPINFO*,const struct gdi_image_bits*,struct bitblt_coords*,struct bitblt_coords*,DWORD);
124     UINT     (*pRealizeDefaultPalette)(PHYSDEV);
125     UINT     (*pRealizePalette)(PHYSDEV,HPALETTE,BOOL);
126     BOOL     (*pRectangle)(PHYSDEV,INT,INT,INT,INT);
127     HDC      (*pResetDC)(PHYSDEV,const DEVMODEW*);
128     BOOL     (*pRestoreDC)(PHYSDEV,INT);
129     BOOL     (*pRoundRect)(PHYSDEV,INT,INT,INT,INT,INT,INT);
130     INT      (*pSaveDC)(PHYSDEV);
131     BOOL     (*pScaleViewportExtEx)(PHYSDEV,INT,INT,INT,INT,SIZE*);
132     BOOL     (*pScaleWindowExtEx)(PHYSDEV,INT,INT,INT,INT,SIZE*);
133     HBITMAP  (*pSelectBitmap)(PHYSDEV,HBITMAP);
134     HBRUSH   (*pSelectBrush)(PHYSDEV,HBRUSH);
135     BOOL     (*pSelectClipPath)(PHYSDEV,INT);
136     HFONT    (*pSelectFont)(PHYSDEV,HFONT,HANDLE);
137     HPALETTE (*pSelectPalette)(PHYSDEV,HPALETTE,BOOL);
138     HPEN     (*pSelectPen)(PHYSDEV,HPEN);
139     INT      (*pSetArcDirection)(PHYSDEV,INT);
140     COLORREF (*pSetBkColor)(PHYSDEV,COLORREF);
141     INT      (*pSetBkMode)(PHYSDEV,INT);
142     COLORREF (*pSetDCBrushColor)(PHYSDEV, COLORREF);
143     COLORREF (*pSetDCPenColor)(PHYSDEV, COLORREF);
144     UINT     (*pSetDIBColorTable)(PHYSDEV,UINT,UINT,const RGBQUAD*);
145     INT      (*pSetDIBitsToDevice)(PHYSDEV,INT,INT,DWORD,DWORD,INT,INT,UINT,UINT,LPCVOID,BITMAPINFO*,UINT);
146     VOID     (*pSetDeviceClipping)(PHYSDEV,HRGN,HRGN);
147     BOOL     (*pSetDeviceGammaRamp)(PHYSDEV,LPVOID);
148     DWORD    (*pSetLayout)(PHYSDEV,DWORD);
149     INT      (*pSetMapMode)(PHYSDEV,INT);
150     DWORD    (*pSetMapperFlags)(PHYSDEV,DWORD);
151     COLORREF (*pSetPixel)(PHYSDEV,INT,INT,COLORREF);
152     BOOL     (*pSetPixelFormat)(PHYSDEV,INT,const PIXELFORMATDESCRIPTOR *);
153     INT      (*pSetPolyFillMode)(PHYSDEV,INT);
154     INT      (*pSetROP2)(PHYSDEV,INT);
155     INT      (*pSetRelAbs)(PHYSDEV,INT);
156     INT      (*pSetStretchBltMode)(PHYSDEV,INT);
157     UINT     (*pSetTextAlign)(PHYSDEV,UINT);
158     INT      (*pSetTextCharacterExtra)(PHYSDEV,INT);
159     COLORREF (*pSetTextColor)(PHYSDEV,COLORREF);
160     BOOL     (*pSetTextJustification)(PHYSDEV,INT,INT);
161     BOOL     (*pSetViewportExtEx)(PHYSDEV,INT,INT,SIZE*);
162     BOOL     (*pSetViewportOrgEx)(PHYSDEV,INT,INT,POINT*);
163     BOOL     (*pSetWindowExtEx)(PHYSDEV,INT,INT,SIZE*);
164     BOOL     (*pSetWindowOrgEx)(PHYSDEV,INT,INT,POINT*);
165     BOOL     (*pSetWorldTransform)(PHYSDEV,const XFORM*);
166     INT      (*pStartDoc)(PHYSDEV,const DOCINFOW*);
167     INT      (*pStartPage)(PHYSDEV);
168     BOOL     (*pStretchBlt)(PHYSDEV,struct bitblt_coords*,PHYSDEV,struct bitblt_coords*,DWORD);
169     INT      (*pStretchDIBits)(PHYSDEV,INT,INT,INT,INT,INT,INT,INT,INT,const void*,BITMAPINFO*,UINT,DWORD);
170     BOOL     (*pStrokeAndFillPath)(PHYSDEV);
171     BOOL     (*pStrokePath)(PHYSDEV);
172     BOOL     (*pSwapBuffers)(PHYSDEV);
173     BOOL     (*pUnrealizePalette)(HPALETTE);
174     BOOL     (*pWidenPath)(PHYSDEV);
175
176     /* OpenGL32 */
177     BOOL     (*pwglCopyContext)(HGLRC,HGLRC,UINT);
178     HGLRC    (*pwglCreateContext)(PHYSDEV);
179     HGLRC    (*pwglCreateContextAttribsARB)(PHYSDEV,HGLRC,const int*);
180     BOOL     (*pwglDeleteContext)(HGLRC);
181     HDC      (*pwglGetPbufferDCARB)(PHYSDEV,void*);
182     PROC     (*pwglGetProcAddress)(LPCSTR);
183     BOOL     (*pwglMakeContextCurrentARB)(PHYSDEV,PHYSDEV,HGLRC);
184     BOOL     (*pwglMakeCurrent)(PHYSDEV,HGLRC);
185     BOOL     (*pwglSetPixelFormatWINE)(PHYSDEV,INT,const PIXELFORMATDESCRIPTOR*);
186     BOOL     (*pwglShareLists)(HGLRC,HGLRC);
187     BOOL     (*pwglUseFontBitmapsA)(PHYSDEV,DWORD,DWORD,DWORD);
188     BOOL     (*pwglUseFontBitmapsW)(PHYSDEV,DWORD,DWORD,DWORD);
189 };
190
191 /* increment this when you change the DC function table */
192 #define WINE_GDI_DRIVER_VERSION 13
193
194 static inline PHYSDEV get_physdev_entry_point( PHYSDEV dev, size_t offset )
195 {
196     while (!((void **)dev->funcs)[offset / sizeof(void *)]) dev = dev->next;
197     return dev;
198 }
199
200 #define GET_NEXT_PHYSDEV(dev,func) \
201     get_physdev_entry_point( (dev)->next, FIELD_OFFSET(struct gdi_dc_funcs,func))
202
203 static inline void push_dc_driver( PHYSDEV *dev, PHYSDEV physdev, const struct gdi_dc_funcs *funcs )
204 {
205     physdev->funcs = funcs;
206     physdev->next = *dev;
207     physdev->hdc = (*dev)->hdc;
208     *dev = physdev;
209 }
210
211 static inline PHYSDEV pop_dc_driver( PHYSDEV *dev )
212 {
213     PHYSDEV ret = *dev;
214     *dev = ret->next;
215     return ret;
216 }
217
218 #endif /* __WINE_WINE_GDI_DRIVER_H */