ddraw: Use unsafe_impl_from_IDirectDrawSurface() for application provided interfaces.
[wine] / dlls / ddraw / ddraw_private.h
1 /*
2  * Copyright 2006 Stefan Dösinger
3  *
4  * This library is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Lesser General Public
6  * License as published by the Free Software Foundation; either
7  * version 2.1 of the License, or (at your option) any later version.
8  *
9  * This library is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12  * Lesser General Public License for more details.
13  *
14  * You should have received a copy of the GNU Lesser General Public
15  * License along with this library; if not, write to the Free Software
16  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
17  */
18
19 #ifndef __WINE_DLLS_DDRAW_DDRAW_PRIVATE_H
20 #define __WINE_DLLS_DDRAW_DDRAW_PRIVATE_H
21
22 #include <assert.h>
23 #define COBJMACROS
24 #define NONAMELESSSTRUCT
25 #define NONAMELESSUNION
26 #include "wine/debug.h"
27
28 #include "winbase.h"
29 #include "wingdi.h"
30 #include "winuser.h"
31
32 #include "d3d.h"
33 #include "ddraw.h"
34 #ifdef DDRAW_INIT_GUID
35 #include "initguid.h"
36 #endif
37 #include "wine/list.h"
38 #include "wine/wined3d.h"
39
40 extern const struct wined3d_parent_ops ddraw_surface_wined3d_parent_ops DECLSPEC_HIDDEN;
41 extern const struct wined3d_parent_ops ddraw_null_wined3d_parent_ops DECLSPEC_HIDDEN;
42
43 /* Typdef the interfaces */
44 typedef struct IDirectDrawImpl            IDirectDrawImpl;
45 typedef struct IDirectDrawSurfaceImpl     IDirectDrawSurfaceImpl;
46 typedef struct IDirectDrawClipperImpl     IDirectDrawClipperImpl;
47 typedef struct IDirectDrawPaletteImpl     IDirectDrawPaletteImpl;
48 typedef struct IDirect3DDeviceImpl        IDirect3DDeviceImpl;
49 typedef struct IDirect3DLightImpl         IDirect3DLightImpl;
50 typedef struct IDirect3DViewportImpl      IDirect3DViewportImpl;
51 typedef struct IDirect3DMaterialImpl      IDirect3DMaterialImpl;
52 typedef struct IDirect3DExecuteBufferImpl IDirect3DExecuteBufferImpl;
53 typedef struct IDirect3DVertexBufferImpl  IDirect3DVertexBufferImpl;
54
55 /* Global critical section */
56 extern CRITICAL_SECTION ddraw_cs DECLSPEC_HIDDEN;
57
58 extern DWORD force_refresh_rate DECLSPEC_HIDDEN;
59
60 /*****************************************************************************
61  * IDirectDraw implementation structure
62  *****************************************************************************/
63 struct FvfToDecl
64 {
65     DWORD fvf;
66     struct wined3d_vertex_declaration *decl;
67 };
68
69 struct IDirectDrawImpl
70 {
71     /* Interfaces */
72     IDirectDraw7 IDirectDraw7_iface;
73     IDirectDraw4 IDirectDraw4_iface;
74     IDirectDraw3 IDirectDraw3_iface;
75     IDirectDraw2 IDirectDraw2_iface;
76     IDirectDraw IDirectDraw_iface;
77     IDirect3D7 IDirect3D7_iface;
78     IDirect3D3 IDirect3D3_iface;
79     IDirect3D2 IDirect3D2_iface;
80     IDirect3D IDirect3D_iface;
81     struct wined3d_device_parent device_parent;
82
83     /* See comment in IDirectDraw::AddRef */
84     LONG                    ref7, ref4, ref2, ref3, ref1, numIfaces;
85
86     /* WineD3D linkage */
87     struct wined3d *wineD3D;
88     struct wined3d_device *wined3d_device;
89     BOOL                    d3d_initialized;
90
91     /* Misc ddraw fields */
92     UINT                    total_vidmem;
93     DWORD                   cur_scanline;
94     BOOL                    fake_vblank;
95     BOOL                    initialized;
96
97     /* DirectDraw things, which are not handled by WineD3D */
98     DWORD                   cooperative_level;
99
100     DWORD                   orig_width, orig_height;
101     DWORD                   orig_bpp;
102
103     /* D3D things */
104     IDirectDrawSurfaceImpl  *d3d_target;
105     HWND                    d3d_window;
106     IDirect3DDeviceImpl     *d3ddevice;
107     int                     d3dversion;
108
109     /* Various HWNDs */
110     HWND                    focuswindow;
111     HWND                    devicewindow;
112     HWND                    dest_window;
113
114     /* The surface type to request */
115     WINED3DSURFTYPE         ImplType;
116
117     /* Helpers for surface creation */
118     IDirectDrawSurfaceImpl *tex_root;
119     BOOL                    depthstencil;
120
121     /* For the dll unload cleanup code */
122     struct list ddraw_list_entry;
123     /* The surface list - can't relay this to WineD3D
124      * because of IParent
125      */
126     struct list surface_list;
127     LONG surfaces;
128
129     /* FVF management */
130     struct FvfToDecl       *decls;
131     UINT                    numConvertedDecls, declArraySize;
132 };
133
134 #define DDRAW_WINDOW_CLASS_NAME "ddraw_wc"
135
136 HRESULT ddraw_init(IDirectDrawImpl *ddraw, WINED3DDEVTYPE device_type) DECLSPEC_HIDDEN;
137
138 /* Utility functions */
139 void DDRAW_Convert_DDSCAPS_1_To_2(const DDSCAPS *pIn, DDSCAPS2 *pOut) DECLSPEC_HIDDEN;
140 void DDRAW_Convert_DDDEVICEIDENTIFIER_2_To_1(const DDDEVICEIDENTIFIER2 *pIn, DDDEVICEIDENTIFIER *pOut) DECLSPEC_HIDDEN;
141 HRESULT WINAPI ddraw_recreate_surfaces_cb(IDirectDrawSurface7 *surf,
142         DDSURFACEDESC2 *desc, void *Context) DECLSPEC_HIDDEN;
143 struct wined3d_vertex_declaration *ddraw_find_decl(IDirectDrawImpl *This, DWORD fvf) DECLSPEC_HIDDEN;
144
145 /* The default surface type */
146 extern WINED3DSURFTYPE DefaultSurfaceType DECLSPEC_HIDDEN;
147
148 /*****************************************************************************
149  * IDirectDrawSurface implementation structure
150  *****************************************************************************/
151
152 struct IDirectDrawSurfaceImpl
153 {
154     /* IUnknown fields */
155     IDirectDrawSurface7 IDirectDrawSurface7_iface;
156     IDirectDrawSurface4 IDirectDrawSurface4_iface;
157     IDirectDrawSurface3 IDirectDrawSurface3_iface;
158     IDirectDrawSurface2 IDirectDrawSurface2_iface;
159     IDirectDrawGammaControl IDirectDrawGammaControl_iface;
160     const IDirect3DTexture2Vtbl *IDirect3DTexture2_vtbl;
161     const IDirect3DTextureVtbl *IDirect3DTexture_vtbl;
162
163     LONG                     ref;
164     IUnknown                *ifaceToRelease;
165
166     int                     version;
167
168     /* Connections to other Objects */
169     IDirectDrawImpl         *ddraw;
170     struct wined3d_surface *wined3d_surface;
171     struct wined3d_texture *wined3d_texture;
172     struct wined3d_swapchain *wined3d_swapchain;
173
174     /* This implementation handles attaching surfaces to other surfaces */
175     IDirectDrawSurfaceImpl  *next_attached;
176     IDirectDrawSurfaceImpl  *first_attached;
177
178     /* Complex surfaces are organized in a tree, although the tree is degenerated to a list in most cases.
179      * In mipmap and primary surfaces each level has only one attachment, which is the next surface level.
180      * Only the cube texture root has 6 surfaces attached, which then have a normal mipmap chain attached
181      * to them. So hardcode the array to 6, a dynamic array or a list would be an overkill.
182      */
183 #define MAX_COMPLEX_ATTACHED 6
184     IDirectDrawSurfaceImpl  *complex_array[MAX_COMPLEX_ATTACHED];
185     /* You can't traverse the tree upwards. Only a flag for Surface::Release because its needed there,
186      * but no pointer to prevent temptations to traverse it in the wrong direction.
187      */
188     BOOL                    is_complex_root;
189
190     /* Surface description, for GetAttachedSurface */
191     DDSURFACEDESC2          surface_desc;
192
193     /* Misc things */
194     DWORD                   uniqueness_value;
195     UINT                    mipmap_level;
196     WINED3DSURFTYPE         ImplType;
197
198     /* For D3DDevice creation */
199     BOOL                    isRenderTarget;
200
201     /* Clipper objects */
202     IDirectDrawClipperImpl  *clipper;
203
204     /* For the ddraw surface list */
205     struct list             surface_list_entry;
206
207     DWORD                   Handle;
208 };
209
210 HRESULT ddraw_surface_create_texture(IDirectDrawSurfaceImpl *surface) DECLSPEC_HIDDEN;
211 void ddraw_surface_destroy(IDirectDrawSurfaceImpl *surface) DECLSPEC_HIDDEN;
212 HRESULT ddraw_surface_init(IDirectDrawSurfaceImpl *surface, IDirectDrawImpl *ddraw,
213         DDSURFACEDESC2 *desc, UINT mip_level, WINED3DSURFTYPE surface_type) DECLSPEC_HIDDEN;
214
215 static inline IDirectDrawSurfaceImpl *surface_from_texture1(IDirect3DTexture *iface)
216 {
217     return (IDirectDrawSurfaceImpl *)((char*)iface - FIELD_OFFSET(IDirectDrawSurfaceImpl, IDirect3DTexture_vtbl));
218 }
219
220 static inline IDirectDrawSurfaceImpl *surface_from_texture2(IDirect3DTexture2 *iface)
221 {
222     return (IDirectDrawSurfaceImpl *)((char*)iface - FIELD_OFFSET(IDirectDrawSurfaceImpl, IDirect3DTexture2_vtbl));
223 }
224
225 static inline IDirectDrawSurfaceImpl *impl_from_IDirectDrawSurface2(IDirectDrawSurface2 *iface)
226 {
227     return CONTAINING_RECORD(iface, IDirectDrawSurfaceImpl, IDirectDrawSurface2_iface);
228 }
229
230 static inline IDirectDrawSurfaceImpl *impl_from_IDirectDrawSurface3(IDirectDrawSurface3 *iface)
231 {
232     return CONTAINING_RECORD(iface, IDirectDrawSurfaceImpl, IDirectDrawSurface3_iface);
233 }
234
235 static inline IDirectDrawSurfaceImpl *impl_from_IDirectDrawSurface4(IDirectDrawSurface4 *iface)
236 {
237     return CONTAINING_RECORD(iface, IDirectDrawSurfaceImpl, IDirectDrawSurface4_iface);
238 }
239
240 static inline IDirectDrawSurfaceImpl *impl_from_IDirectDrawSurface7(IDirectDrawSurface7 *iface)
241 {
242     return CONTAINING_RECORD(iface, IDirectDrawSurfaceImpl, IDirectDrawSurface7_iface);
243 }
244
245 IDirectDrawSurfaceImpl *unsafe_impl_from_IDirectDrawSurface(IDirectDrawSurface *iface) DECLSPEC_HIDDEN;
246 IDirectDrawSurfaceImpl *unsafe_impl_from_IDirectDrawSurface2(IDirectDrawSurface2 *iface) DECLSPEC_HIDDEN;
247 IDirectDrawSurfaceImpl *unsafe_impl_from_IDirectDrawSurface3(IDirectDrawSurface3 *iface) DECLSPEC_HIDDEN;
248 IDirectDrawSurfaceImpl *unsafe_impl_from_IDirectDrawSurface4(IDirectDrawSurface4 *iface) DECLSPEC_HIDDEN;
249 IDirectDrawSurfaceImpl *unsafe_impl_from_IDirectDrawSurface7(IDirectDrawSurface7 *iface) DECLSPEC_HIDDEN;
250
251 /* Get the number of bytes per pixel for a given surface */
252 #define PFGET_BPP(pf) (pf.dwFlags&DDPF_PALETTEINDEXED8?1:((pf.dwRGBBitCount+7)/8))
253 #define GET_BPP(desc) PFGET_BPP(desc.ddpfPixelFormat)
254
255 #define DDRAW_INVALID_HANDLE ~0U
256
257 enum ddraw_handle_type
258 {
259     DDRAW_HANDLE_FREE,
260     DDRAW_HANDLE_MATERIAL,
261     DDRAW_HANDLE_MATRIX,
262     DDRAW_HANDLE_STATEBLOCK,
263     DDRAW_HANDLE_SURFACE,
264 };
265
266 struct ddraw_handle_entry
267 {
268     void *object;
269     enum ddraw_handle_type type;
270 };
271
272 struct ddraw_handle_table
273 {
274     struct ddraw_handle_entry *entries;
275     struct ddraw_handle_entry *free_entries;
276     UINT table_size;
277     UINT entry_count;
278 };
279
280 BOOL ddraw_handle_table_init(struct ddraw_handle_table *t, UINT initial_size) DECLSPEC_HIDDEN;
281 void ddraw_handle_table_destroy(struct ddraw_handle_table *t) DECLSPEC_HIDDEN;
282 DWORD ddraw_allocate_handle(struct ddraw_handle_table *t, void *object, enum ddraw_handle_type type) DECLSPEC_HIDDEN;
283 void *ddraw_free_handle(struct ddraw_handle_table *t, DWORD handle, enum ddraw_handle_type type) DECLSPEC_HIDDEN;
284 void *ddraw_get_object(struct ddraw_handle_table *t, DWORD handle, enum ddraw_handle_type type) DECLSPEC_HIDDEN;
285
286 struct IDirect3DDeviceImpl
287 {
288     /* IUnknown */
289     const IDirect3DDevice7Vtbl *lpVtbl;
290     const IDirect3DDevice3Vtbl *IDirect3DDevice3_vtbl;
291     const IDirect3DDevice2Vtbl *IDirect3DDevice2_vtbl;
292     const IDirect3DDeviceVtbl *IDirect3DDevice_vtbl;
293     LONG                    ref;
294
295     /* Other object connections */
296     struct wined3d_device *wined3d_device;
297     IDirectDrawImpl         *ddraw;
298     struct wined3d_buffer *indexbuffer;
299     IDirectDrawSurfaceImpl  *target;
300
301     /* Viewport management */
302     struct list viewport_list;
303     IDirect3DViewportImpl *current_viewport;
304     D3DVIEWPORT7 active_viewport;
305
306     /* Required to keep track which of two available texture blending modes in d3ddevice3 is used */
307     BOOL legacyTextureBlending;
308
309     /* Light state */
310     DWORD material;
311
312     /* Rendering functions to wrap D3D(1-3) to D3D7 */
313     D3DPRIMITIVETYPE primitive_type;
314     DWORD vertex_type;
315     DWORD render_flags;
316     DWORD nb_vertices;
317     LPBYTE vertex_buffer;
318     DWORD vertex_size;
319     DWORD buffer_size;
320
321     /* Handle management */
322     struct ddraw_handle_table handle_table;
323     D3DMATRIXHANDLE          world, proj, view;
324 };
325
326 HRESULT d3d_device_init(IDirect3DDeviceImpl *device, IDirectDrawImpl *ddraw,
327         IDirectDrawSurfaceImpl *target) DECLSPEC_HIDDEN;
328
329 /* The IID */
330 extern const GUID IID_D3DDEVICE_WineD3D DECLSPEC_HIDDEN;
331
332 /* Helper functions */
333 HRESULT IDirect3DImpl_GetCaps(const struct wined3d *wined3d,
334         D3DDEVICEDESC *Desc123, D3DDEVICEDESC7 *Desc7) DECLSPEC_HIDDEN;
335 WINED3DZBUFFERTYPE IDirect3DDeviceImpl_UpdateDepthStencil(IDirect3DDeviceImpl *This) DECLSPEC_HIDDEN;
336
337 static inline IDirect3DDeviceImpl *device_from_device1(IDirect3DDevice *iface)
338 {
339     return (IDirect3DDeviceImpl *)((char*)iface - FIELD_OFFSET(IDirect3DDeviceImpl, IDirect3DDevice_vtbl));
340 }
341
342 static inline IDirect3DDeviceImpl *device_from_device2(IDirect3DDevice2 *iface)
343 {
344     return (IDirect3DDeviceImpl *)((char*)iface - FIELD_OFFSET(IDirect3DDeviceImpl, IDirect3DDevice2_vtbl));
345 }
346
347 static inline IDirect3DDeviceImpl *device_from_device3(IDirect3DDevice3 *iface)
348 {
349     return (IDirect3DDeviceImpl *)((char*)iface - FIELD_OFFSET(IDirect3DDeviceImpl, IDirect3DDevice3_vtbl));
350 }
351
352 /*****************************************************************************
353  * IDirectDrawClipper implementation structure
354  *****************************************************************************/
355 struct IDirectDrawClipperImpl
356 {
357     /* IUnknown fields */
358     const IDirectDrawClipperVtbl *lpVtbl;
359     LONG ref;
360
361     struct wined3d_clipper *wineD3DClipper;
362     BOOL initialized;
363 };
364
365 HRESULT ddraw_clipper_init(IDirectDrawClipperImpl *clipper) DECLSPEC_HIDDEN;
366
367 /*****************************************************************************
368  * IDirectDrawPalette implementation structure
369  *****************************************************************************/
370 struct IDirectDrawPaletteImpl
371 {
372     /* IUnknown fields */
373     const IDirectDrawPaletteVtbl *lpVtbl;
374     LONG ref;
375
376     struct wined3d_palette *wineD3DPalette;
377
378     /* IDirectDrawPalette fields */
379     IUnknown                  *ifaceToRelease;
380 };
381
382 HRESULT ddraw_palette_init(IDirectDrawPaletteImpl *palette,
383         IDirectDrawImpl *ddraw, DWORD flags, PALETTEENTRY *entries) DECLSPEC_HIDDEN;
384
385 /* Helper structures */
386 struct object_creation_info
387 {
388     const CLSID *clsid;
389     HRESULT (*pfnCreateInstance)(IUnknown *pUnkOuter, REFIID riid,
390                                  void **ppObj);
391 };
392
393 /******************************************************************************
394  * IDirect3DLight implementation structure - Wraps to D3D7
395  ******************************************************************************/
396 struct IDirect3DLightImpl
397 {
398     IDirect3DLight IDirect3DLight_iface;
399     LONG ref;
400
401     /* IDirect3DLight fields */
402     IDirectDrawImpl           *ddraw;
403
404     /* If this light is active for one viewport, put the viewport here */
405     IDirect3DViewportImpl     *active_viewport;
406
407     D3DLIGHT2 light;
408     D3DLIGHT7 light7;
409
410     DWORD dwLightIndex;
411
412     struct list entry;
413 };
414
415 /* Helper functions */
416 void light_activate(IDirect3DLightImpl *light) DECLSPEC_HIDDEN;
417 void light_deactivate(IDirect3DLightImpl *light) DECLSPEC_HIDDEN;
418 void d3d_light_init(IDirect3DLightImpl *light, IDirectDrawImpl *ddraw) DECLSPEC_HIDDEN;
419 IDirect3DLightImpl *unsafe_impl_from_IDirect3DLight(IDirect3DLight *iface) DECLSPEC_HIDDEN;
420
421 /******************************************************************************
422  * IDirect3DMaterial implementation structure - Wraps to D3D7
423  ******************************************************************************/
424 struct IDirect3DMaterialImpl
425 {
426     IDirect3DMaterial3 IDirect3DMaterial3_iface;
427     IDirect3DMaterial2 IDirect3DMaterial2_iface;
428     IDirect3DMaterial IDirect3DMaterial_iface;
429     LONG  ref;
430
431     /* IDirect3DMaterial2 fields */
432     IDirectDrawImpl               *ddraw;
433     IDirect3DDeviceImpl           *active_device;
434
435     D3DMATERIAL mat;
436     DWORD Handle;
437 };
438
439 /* Helper functions */
440 void material_activate(IDirect3DMaterialImpl* This) DECLSPEC_HIDDEN;
441 IDirect3DMaterialImpl *d3d_material_create(IDirectDrawImpl *ddraw) DECLSPEC_HIDDEN;
442
443 /*****************************************************************************
444  * IDirect3DViewport - Wraps to D3D7
445  *****************************************************************************/
446 struct IDirect3DViewportImpl
447 {
448     const IDirect3DViewport3Vtbl *lpVtbl;
449     LONG ref;
450
451     /* IDirect3DViewport fields */
452     IDirectDrawImpl           *ddraw;
453
454     /* If this viewport is active for one device, put the device here */
455     IDirect3DDeviceImpl       *active_device;
456
457     DWORD                     num_lights;
458     DWORD                     map_lights;
459
460     int                       use_vp2;
461
462     union
463     {
464         D3DVIEWPORT vp1;
465         D3DVIEWPORT2 vp2;
466     } viewports;
467
468     struct list entry;
469     struct list light_list;
470
471     /* Background material */
472     IDirect3DMaterialImpl     *background;
473 };
474
475 /* Helper functions */
476 void viewport_activate(IDirect3DViewportImpl* This, BOOL ignore_lights) DECLSPEC_HIDDEN;
477 void d3d_viewport_init(IDirect3DViewportImpl *viewport, IDirectDrawImpl *ddraw) DECLSPEC_HIDDEN;
478
479 /*****************************************************************************
480  * IDirect3DExecuteBuffer - Wraps to D3D7
481  *****************************************************************************/
482 struct IDirect3DExecuteBufferImpl
483 {
484     /* IUnknown */
485     const IDirect3DExecuteBufferVtbl *lpVtbl;
486     LONG                 ref;
487
488     /* IDirect3DExecuteBuffer fields */
489     IDirectDrawImpl      *ddraw;
490     IDirect3DDeviceImpl  *d3ddev;
491
492     D3DEXECUTEBUFFERDESC desc;
493     D3DEXECUTEDATA       data;
494
495     /* This buffer will store the transformed vertices */
496     void                 *vertex_data;
497     WORD                 *indices;
498     int                  nb_indices;
499
500     /* This flags is set to TRUE if we allocated ourselves the
501      * data buffer
502      */
503     BOOL                 need_free;
504 };
505
506 HRESULT d3d_execute_buffer_init(IDirect3DExecuteBufferImpl *execute_buffer,
507         IDirect3DDeviceImpl *device, D3DEXECUTEBUFFERDESC *desc) DECLSPEC_HIDDEN;
508
509 /* The execute function */
510 HRESULT d3d_execute_buffer_execute(IDirect3DExecuteBufferImpl *execute_buffer,
511         IDirect3DDeviceImpl *device, IDirect3DViewportImpl *viewport) DECLSPEC_HIDDEN;
512
513 /*****************************************************************************
514  * IDirect3DVertexBuffer
515  *****************************************************************************/
516 struct IDirect3DVertexBufferImpl
517 {
518     /*** IUnknown Methods ***/
519     const IDirect3DVertexBuffer7Vtbl *lpVtbl;
520     const IDirect3DVertexBufferVtbl *IDirect3DVertexBuffer_vtbl;
521     LONG                 ref;
522
523     /*** WineD3D and ddraw links ***/
524     struct wined3d_buffer *wineD3DVertexBuffer;
525     struct wined3d_vertex_declaration *wineD3DVertexDeclaration;
526     IDirectDrawImpl *ddraw;
527
528     /*** Storage for D3D7 specific things ***/
529     DWORD                Caps;
530     DWORD                fvf;
531 };
532
533 HRESULT d3d_vertex_buffer_init(IDirect3DVertexBufferImpl *buffer,
534         IDirectDrawImpl *ddraw, D3DVERTEXBUFFERDESC *desc) DECLSPEC_HIDDEN;
535
536 static inline IDirect3DVertexBufferImpl *vb_from_vb1(IDirect3DVertexBuffer *iface)
537 {
538     return (IDirect3DVertexBufferImpl *)((char*)iface
539             - FIELD_OFFSET(IDirect3DVertexBufferImpl, IDirect3DVertexBuffer_vtbl));
540 }
541
542 /*****************************************************************************
543  * Helper functions from utils.c
544  *****************************************************************************/
545
546 #define GET_TEXCOUNT_FROM_FVF(d3dvtVertexType) \
547     (((d3dvtVertexType) & D3DFVF_TEXCOUNT_MASK) >> D3DFVF_TEXCOUNT_SHIFT)
548
549 #define GET_TEXCOORD_SIZE_FROM_FVF(d3dvtVertexType, tex_num) \
550     (((((d3dvtVertexType) >> (16 + (2 * (tex_num)))) + 1) & 0x03) + 1)
551
552 void PixelFormat_WineD3DtoDD(DDPIXELFORMAT *DDPixelFormat, enum wined3d_format_id WineD3DFormat) DECLSPEC_HIDDEN;
553 enum wined3d_format_id PixelFormat_DD2WineD3D(const DDPIXELFORMAT *DDPixelFormat) DECLSPEC_HIDDEN;
554 void DDRAW_dump_surface_desc(const DDSURFACEDESC2 *lpddsd) DECLSPEC_HIDDEN;
555 void dump_D3DMATRIX(const D3DMATRIX *mat) DECLSPEC_HIDDEN;
556 void DDRAW_dump_DDCAPS(const DDCAPS *lpcaps) DECLSPEC_HIDDEN;
557 DWORD get_flexible_vertex_size(DWORD d3dvtVertexType) DECLSPEC_HIDDEN;
558 void DDRAW_dump_DDSCAPS2(const DDSCAPS2 *in) DECLSPEC_HIDDEN;
559 void DDRAW_dump_cooperativelevel(DWORD cooplevel) DECLSPEC_HIDDEN;
560
561 /* This only needs to be here as long the processvertices functionality of
562  * IDirect3DExecuteBuffer isn't in WineD3D */
563 void multiply_matrix(LPD3DMATRIX dest, const D3DMATRIX *src1, const D3DMATRIX *src2) DECLSPEC_HIDDEN;
564
565 /* Used for generic dumping */
566 typedef struct
567 {
568     DWORD val;
569     const char* name;
570 } flag_info;
571
572 #define FE(x) { x, #x }
573
574 typedef struct
575 {
576     DWORD val;
577     const char* name;
578     void (*func)(const void *);
579     ptrdiff_t offset;
580 } member_info;
581
582 /* Structure copy */
583 #define ME(x,f,e) { x, #x, (void (*)(const void *))(f), offsetof(STRUCT, e) }
584
585 #define DD_STRUCT_COPY_BYSIZE_(to,from,from_size)                 \
586     do {                                                          \
587         DWORD __size = (to)->dwSize;                              \
588         DWORD __copysize = min(__size, from_size);                \
589         assert(to != from);                                       \
590         memcpy(to, from, __copysize);                             \
591         memset((char*)(to) + __copysize, 0, __size - __copysize); \
592         (to)->dwSize = __size; /* restore size */                 \
593     } while (0)
594
595 #define DD_STRUCT_COPY_BYSIZE(to,from) DD_STRUCT_COPY_BYSIZE_(to,from,(from)->dwSize)
596
597 #define SIZEOF_END_PADDING(type, last_field) \
598     (sizeof(type) - offsetof(type, last_field) - sizeof(((type *)0)->last_field))
599
600 static inline void copy_to_surfacedesc2(DDSURFACEDESC2 *to, DDSURFACEDESC2 *from)
601 {
602     DWORD from_size = from->dwSize;
603     if (from_size == sizeof(DDSURFACEDESC))
604         from_size -= SIZEOF_END_PADDING(DDSURFACEDESC, ddsCaps);
605     to->dwSize = sizeof(DDSURFACEDESC2); /* for struct copy */
606     DD_STRUCT_COPY_BYSIZE_(to, from, from_size);
607 }
608
609 HRESULT hr_ddraw_from_wined3d(HRESULT hr) DECLSPEC_HIDDEN;
610
611 #endif