2 * Copyright 2006 Stefan Dösinger
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.
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.
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
19 #ifndef __WINE_DLLS_DDRAW_DDRAW_PRIVATE_H
20 #define __WINE_DLLS_DDRAW_DDRAW_PRIVATE_H
22 /* MAY NOT CONTAIN X11 or DGA specific includes/defines/structs! */
36 #include "ddcomimpl.h"
38 #include "wine/wined3d_interface.h"
39 #include "wine/list.h"
41 /*****************************************************************************
42 * IParent - a helper interface
43 *****************************************************************************/
44 DEFINE_GUID(IID_IParent, 0xc20e4c88, 0x74e7, 0x4940, 0xba, 0x9f, 0x2e, 0x32, 0x3f, 0x9d, 0xc9, 0x81);
45 typedef struct IParent *LPPARENT, *PPARENT;
47 #define INTERFACE IParent
48 DECLARE_INTERFACE_(IParent,IUnknown)
50 /*** IUnknown methods ***/
51 STDMETHOD_(HRESULT,QueryInterface)(THIS_ REFIID riid, void** ppvObject) PURE;
52 STDMETHOD_(ULONG,AddRef)(THIS) PURE;
53 STDMETHOD_(ULONG,Release)(THIS) PURE;
57 #if !defined(__cplusplus) || defined(CINTERFACE)
58 /*** IUnknown methods ***/
59 #define IParent_QueryInterface(p,a,b) (p)->lpVtbl->QueryInterface(p,a,b)
60 #define IParent_AddRef(p) (p)->lpVtbl->AddRef(p)
61 #define IParent_Release(p) (p)->lpVtbl->Release(p)
65 /* Typdef the interfaces */
66 typedef struct IDirectDrawImpl IDirectDrawImpl;
67 typedef struct IDirectDrawSurfaceImpl IDirectDrawSurfaceImpl;
68 typedef struct IDirectDrawClipperImpl IDirectDrawClipperImpl;
69 typedef struct IDirectDrawPaletteImpl IDirectDrawPaletteImpl;
70 typedef struct IDirect3DDeviceImpl IDirect3DDeviceImpl;
71 typedef struct IDirect3DLightImpl IDirect3DLightImpl;
72 typedef struct IDirect3DViewportImpl IDirect3DViewportImpl;
73 typedef struct IDirect3DMaterialImpl IDirect3DMaterialImpl;
74 typedef struct IDirect3DExecuteBufferImpl IDirect3DExecuteBufferImpl;
75 typedef struct IDirect3DVertexBufferImpl IDirect3DVertexBufferImpl;
76 typedef struct IParentImpl IParentImpl;
78 /* Callbacks for implicit object destruction */
79 extern ULONG WINAPI D3D7CB_DestroySwapChain(IWineD3DSwapChain *pSwapChain);
81 extern ULONG WINAPI D3D7CB_DestroyDepthStencilSurface(IWineD3DSurface *pSurface);
83 /* Global critical section */
84 extern CRITICAL_SECTION ddraw_cs;
86 extern DWORD force_refresh_rate;
88 /*****************************************************************************
89 * IDirectDraw implementation structure
90 *****************************************************************************/
94 IWineD3DVertexDeclaration *decl;
97 struct IDirectDrawImpl
100 ICOM_VFIELD_MULTI(IDirectDraw7);
101 ICOM_VFIELD_MULTI(IDirectDraw4);
102 ICOM_VFIELD_MULTI(IDirectDraw3);
103 ICOM_VFIELD_MULTI(IDirectDraw2);
104 ICOM_VFIELD_MULTI(IDirectDraw);
105 ICOM_VFIELD_MULTI(IDirect3D7);
106 ICOM_VFIELD_MULTI(IDirect3D3);
107 ICOM_VFIELD_MULTI(IDirect3D2);
108 ICOM_VFIELD_MULTI(IDirect3D);
110 /* See comment in IDirectDraw::AddRef */
111 LONG ref7, ref4, ref2, ref3, ref1, numIfaces;
113 /* WineD3D linkage */
115 IWineD3DDevice *wineD3DDevice;
116 IDirectDrawSurfaceImpl *DepthStencilBuffer;
117 BOOL d3d_initialized;
119 /* Misc ddraw fields */
125 /* DirectDraw things, which are not handled by WineD3D */
126 DWORD cooperative_level;
128 DWORD orig_width, orig_height;
134 IDirectDrawSurfaceImpl *d3d_target;
136 IDirect3DDeviceImpl *d3ddevice;
143 /* The surface type to request */
144 WINED3DSURFTYPE ImplType;
147 /* Our private window class */
151 /* Helpers for surface creation */
152 IDirectDrawSurfaceImpl *tex_root;
155 /* For the dll unload cleanup code */
156 struct list ddraw_list_entry;
157 /* The surface list - can't relay this to WineD3D
160 struct list surface_list;
164 struct FvfToDecl *decls;
165 UINT numConvertedDecls, declArraySize;
168 /* Declare the VTables. They can be found ddraw.c */
169 const IDirectDraw7Vtbl IDirectDraw7_Vtbl;
170 const IDirectDraw4Vtbl IDirectDraw4_Vtbl;
171 const IDirectDraw3Vtbl IDirectDraw3_Vtbl;
172 const IDirectDraw2Vtbl IDirectDraw2_Vtbl;
173 const IDirectDrawVtbl IDirectDraw1_Vtbl;
175 /* Helper structures */
176 typedef struct EnumDisplayModesCBS
179 LPDDENUMMODESCALLBACK2 callback;
180 } EnumDisplayModesCBS;
182 typedef struct EnumSurfacesCBS
185 LPDDENUMSURFACESCALLBACK7 callback;
186 LPDDSURFACEDESC2 pDDSD;
190 /* Utility functions */
192 DDRAW_Convert_DDSCAPS_1_To_2(const DDSCAPS* pIn,
195 DDRAW_Convert_DDDEVICEIDENTIFIER_2_To_1(const DDDEVICEIDENTIFIER2* pIn,
196 DDDEVICEIDENTIFIER* pOut);
198 IDirectDrawImpl_Destroy(IDirectDrawImpl *This);
201 IDirectDrawImpl_RecreateSurfacesCallback(IDirectDrawSurface7 *surf,
202 DDSURFACEDESC2 *desc,
204 IWineD3DVertexDeclaration *
205 IDirectDrawImpl_FindDecl(IDirectDrawImpl *This,
208 /* The default surface type */
209 extern WINED3DSURFTYPE DefaultSurfaceType;
211 /*****************************************************************************
212 * IDirectDrawSurface implementation structure
213 *****************************************************************************/
215 struct IDirectDrawSurfaceImpl
217 /* IUnknown fields */
218 ICOM_VFIELD_MULTI(IDirectDrawSurface7);
219 ICOM_VFIELD_MULTI(IDirectDrawSurface3);
220 ICOM_VFIELD_MULTI(IDirectDrawGammaControl);
221 ICOM_VFIELD_MULTI(IDirect3DTexture2);
222 ICOM_VFIELD_MULTI(IDirect3DTexture);
225 IUnknown *ifaceToRelease;
229 /* Connections to other Objects */
230 IDirectDrawImpl *ddraw;
231 IWineD3DSurface *WineD3DSurface;
232 IWineD3DBaseTexture *wineD3DTexture;
234 /* This implementation handles attaching surfaces to other surfaces */
235 IDirectDrawSurfaceImpl *next_attached;
236 IDirectDrawSurfaceImpl *first_attached;
238 /* Complex surfaces are organized in a tree, although the tree is degenerated to a list in most cases.
239 * In mipmap and primary surfaces each level has only one attachment, which is the next surface level.
240 * Only the cube texture root has 6 surfaces attached, which then have a normal mipmap chain attached
241 * to them. So hardcode the array to 6, a dynamic array or a list would be an overkill.
243 #define MAX_COMPLEX_ATTACHED 6
244 IDirectDrawSurfaceImpl *complex_array[MAX_COMPLEX_ATTACHED];
245 /* You can't traverse the tree upwards. Only a flag for Surface::Release because its needed there,
246 * but no pointer to prevent temptations to traverse it in the wrong direction.
248 BOOL is_complex_root;
250 /* Surface description, for GetAttachedSurface */
251 DDSURFACEDESC2 surface_desc;
254 DWORD uniqueness_value;
256 WINED3DSURFTYPE ImplType;
258 /* For D3DDevice creation */
261 /* Clipper objects */
262 IDirectDrawClipperImpl *clipper;
264 /* For the ddraw surface list */
265 struct list surface_list_entry;
270 /* VTable declaration. It's located in surface.c / surface_thunks.c */
271 const IDirectDrawSurface7Vtbl IDirectDrawSurface7_Vtbl;
272 const IDirectDrawSurface3Vtbl IDirectDrawSurface3_Vtbl;
273 const IDirectDrawGammaControlVtbl IDirectDrawGammaControl_Vtbl;
274 const IDirect3DTexture2Vtbl IDirect3DTexture2_Vtbl;
275 const IDirect3DTextureVtbl IDirect3DTexture1_Vtbl;
277 HRESULT WINAPI IDirectDrawSurfaceImpl_AddAttachedSurface(IDirectDrawSurfaceImpl *This, IDirectDrawSurfaceImpl *Surf);
278 void IDirectDrawSurfaceImpl_Destroy(IDirectDrawSurfaceImpl *This);
280 /* Get the number of bytes per pixel for a given surface */
281 #define PFGET_BPP(pf) (pf.dwFlags&DDPF_PALETTEINDEXED8?1:((pf.dwRGBBitCount+7)/8))
282 #define GET_BPP(desc) PFGET_BPP(desc.ddpfPixelFormat)
284 /*****************************************************************************
285 * IParent Implementation
286 *****************************************************************************/
289 /* IUnknown fields */
290 ICOM_VFIELD_MULTI(IParent);
293 /* IParentImpl fields */
298 const IParentVtbl IParent_Vtbl;
300 /*****************************************************************************
301 * IDirect3DDevice implementation
302 *****************************************************************************/
305 DDrawHandle_Unknown = 0,
306 DDrawHandle_Texture = 1,
307 DDrawHandle_Material = 2,
308 DDrawHandle_Matrix = 3,
309 DDrawHandle_StateBlock = 4
315 DDrawHandleTypes type;
318 struct IDirect3DDeviceImpl
321 ICOM_VFIELD_MULTI(IDirect3DDevice7);
322 ICOM_VFIELD_MULTI(IDirect3DDevice3);
323 ICOM_VFIELD_MULTI(IDirect3DDevice2);
324 ICOM_VFIELD_MULTI(IDirect3DDevice);
327 /* Other object connections */
328 IWineD3DDevice *wineD3DDevice;
329 IDirectDrawImpl *ddraw;
330 IWineD3DIndexBuffer *indexbuffer;
331 IDirectDrawSurfaceImpl *target;
332 BOOL OffScreenTarget;
334 /* Viewport management */
335 IDirect3DViewportImpl *viewport_list;
336 IDirect3DViewportImpl *current_viewport;
337 D3DVIEWPORT7 active_viewport;
342 /* Rendering functions to wrap D3D(1-3) to D3D7 */
343 D3DPRIMITIVETYPE primitive_type;
347 LPBYTE vertex_buffer;
351 /* Handle management */
352 struct HandleEntry *Handles;
354 D3DMATRIXHANDLE world, proj, view;
357 /* Vtables in various versions */
358 const IDirect3DDevice7Vtbl IDirect3DDevice7_Vtbl;
359 const IDirect3DDevice3Vtbl IDirect3DDevice3_Vtbl;
360 const IDirect3DDevice2Vtbl IDirect3DDevice2_Vtbl;
361 const IDirect3DDeviceVtbl IDirect3DDevice1_Vtbl;
364 const GUID IID_D3DDEVICE_WineD3D;
366 /* Helper functions */
367 HRESULT IDirect3DImpl_GetCaps(IWineD3D *WineD3D, D3DDEVICEDESC *Desc123, D3DDEVICEDESC7 *Desc7);
368 DWORD IDirect3DDeviceImpl_CreateHandle(IDirect3DDeviceImpl *This);
369 WINED3DZBUFFERTYPE IDirect3DDeviceImpl_UpdateDepthStencil(IDirect3DDeviceImpl *This);
372 struct EnumTextureFormatsCBS
374 LPD3DENUMTEXTUREFORMATSCALLBACK cbv2;
375 LPD3DENUMPIXELFORMATSCALLBACK cbv7;
379 /*****************************************************************************
380 * IDirect3D implementation
381 *****************************************************************************/
383 /* No implementation structure as this is only another interface to DirectDraw */
386 const IDirect3DVtbl IDirect3D1_Vtbl;
387 const IDirect3D2Vtbl IDirect3D2_Vtbl;
388 const IDirect3D3Vtbl IDirect3D3_Vtbl;
389 const IDirect3D7Vtbl IDirect3D7_Vtbl;
391 /* Structure for EnumZBufferFormats */
392 struct EnumZBufferFormatsData
394 LPD3DENUMPIXELFORMATSCALLBACK Callback;
398 /*****************************************************************************
399 * IDirectDrawClipper implementation structure
400 *****************************************************************************/
401 struct IDirectDrawClipperImpl
403 /* IUnknown fields */
404 ICOM_VFIELD_MULTI(IDirectDrawClipper);
407 IWineD3DClipper *wineD3DClipper;
408 IDirectDrawImpl *ddraw_owner;
411 const IDirectDrawClipperVtbl IDirectDrawClipper_Vtbl;
413 typedef IWineD3DClipper* (WINAPI *fnWineDirect3DCreateClipper)(IUnknown *);
414 fnWineDirect3DCreateClipper pWineDirect3DCreateClipper;
416 /*****************************************************************************
417 * IDirectDrawPalette implementation structure
418 *****************************************************************************/
419 struct IDirectDrawPaletteImpl
421 /* IUnknown fields */
422 ICOM_VFIELD_MULTI(IDirectDrawPalette);
426 IWineD3DPalette *wineD3DPalette;
428 /* IDirectDrawPalette fields */
429 IDirectDrawImpl *ddraw_owner;
430 IUnknown *ifaceToRelease;
432 const IDirectDrawPaletteVtbl IDirectDrawPalette_Vtbl;
434 /******************************************************************************
435 * DirectDraw ClassFactory implementation - incomplete
436 ******************************************************************************/
439 ICOM_VFIELD_MULTI(IClassFactory);
442 HRESULT (*pfnCreateInstance)(IUnknown *pUnkOuter, REFIID iid, LPVOID *ppObj);
445 /* Helper structures */
446 struct object_creation_info
449 HRESULT (*pfnCreateInstance)(IUnknown *pUnkOuter, REFIID riid,
453 /******************************************************************************
454 * IDirect3DLight implementation structure - Wraps to D3D7
455 ******************************************************************************/
456 struct IDirect3DLightImpl
458 ICOM_VFIELD_MULTI(IDirect3DLight);
461 /* IDirect3DLight fields */
462 IDirectDrawImpl *ddraw;
464 /* If this light is active for one viewport, put the viewport here */
465 IDirect3DViewportImpl *active_viewport;
472 /* Chained list used for adding / removing from viewports */
473 IDirect3DLightImpl *next;
475 /* Activation function */
476 void (*activate)(IDirect3DLightImpl*);
477 void (*desactivate)(IDirect3DLightImpl*);
478 void (*update)(IDirect3DLightImpl*);
482 const IDirect3DLightVtbl IDirect3DLight_Vtbl;
484 /* Helper functions */
485 void light_update(IDirect3DLightImpl* This);
486 void light_activate(IDirect3DLightImpl* This);
487 void light_desactivate(IDirect3DLightImpl* This);
489 /******************************************************************************
490 * IDirect3DMaterial implementation structure - Wraps to D3D7
491 ******************************************************************************/
492 struct IDirect3DMaterialImpl
494 ICOM_VFIELD_MULTI(IDirect3DMaterial3);
495 ICOM_VFIELD_MULTI(IDirect3DMaterial2);
496 ICOM_VFIELD_MULTI(IDirect3DMaterial);
499 /* IDirect3DMaterial2 fields */
500 IDirectDrawImpl *ddraw;
501 IDirect3DDeviceImpl *active_device;
506 void (*activate)(IDirect3DMaterialImpl* this);
509 /* VTables in various versions */
510 const IDirect3DMaterialVtbl IDirect3DMaterial_Vtbl;
511 const IDirect3DMaterial2Vtbl IDirect3DMaterial2_Vtbl;
512 const IDirect3DMaterial3Vtbl IDirect3DMaterial3_Vtbl;
514 /* Helper functions */
515 void material_activate(IDirect3DMaterialImpl* This);
517 /*****************************************************************************
518 * IDirect3DViewport - Wraps to D3D7
519 *****************************************************************************/
520 struct IDirect3DViewportImpl
522 ICOM_VFIELD_MULTI(IDirect3DViewport3);
525 /* IDirect3DViewport fields */
526 IDirectDrawImpl *ddraw;
528 /* If this viewport is active for one device, put the device here */
529 IDirect3DDeviceImpl *active_device;
542 /* Activation function */
543 void (*activate)(IDirect3DViewportImpl*);
545 /* Field used to chain viewports together */
546 IDirect3DViewportImpl *next;
549 IDirect3DLightImpl *lights;
551 /* Background material */
552 IDirect3DMaterialImpl *background;
556 const IDirect3DViewport3Vtbl IDirect3DViewport3_Vtbl;
558 /* Helper functions */
559 void viewport_activate(IDirect3DViewportImpl* This);
561 /*****************************************************************************
562 * IDirect3DExecuteBuffer - Wraps to D3D7
563 *****************************************************************************/
564 struct IDirect3DExecuteBufferImpl
567 ICOM_VFIELD_MULTI(IDirect3DExecuteBuffer);
570 /* IDirect3DExecuteBuffer fields */
571 IDirectDrawImpl *ddraw;
572 IDirect3DDeviceImpl *d3ddev;
574 D3DEXECUTEBUFFERDESC desc;
577 /* This buffer will store the transformed vertices */
582 /* This flags is set to TRUE if we allocated ourselves the
589 const IDirect3DExecuteBufferVtbl IDirect3DExecuteBuffer_Vtbl;
591 /* The execute function */
593 IDirect3DExecuteBufferImpl_Execute(IDirect3DExecuteBufferImpl *This,
594 IDirect3DDeviceImpl *Device,
595 IDirect3DViewportImpl *ViewportImpl);
597 /*****************************************************************************
598 * IDirect3DVertexBuffer
599 *****************************************************************************/
600 struct IDirect3DVertexBufferImpl
602 /*** IUnknown Methods ***/
603 ICOM_VFIELD_MULTI(IDirect3DVertexBuffer7);
604 ICOM_VFIELD_MULTI(IDirect3DVertexBuffer);
607 /*** WineD3D and ddraw links ***/
608 IWineD3DVertexBuffer *wineD3DVertexBuffer;
609 IWineD3DVertexDeclaration *wineD3DVertexDeclaration;
610 IDirectDrawImpl *ddraw;
612 /*** Storage for D3D7 specific things ***/
617 const IDirect3DVertexBuffer7Vtbl IDirect3DVertexBuffer7_Vtbl;
618 const IDirect3DVertexBufferVtbl IDirect3DVertexBuffer1_Vtbl;
620 /*****************************************************************************
621 * Helper functions from utils.c
622 *****************************************************************************/
624 #define GET_TEXCOUNT_FROM_FVF(d3dvtVertexType) \
625 (((d3dvtVertexType) & D3DFVF_TEXCOUNT_MASK) >> D3DFVF_TEXCOUNT_SHIFT)
627 #define GET_TEXCOORD_SIZE_FROM_FVF(d3dvtVertexType, tex_num) \
628 (((((d3dvtVertexType) >> (16 + (2 * (tex_num)))) + 1) & 0x03) + 1)
630 void PixelFormat_WineD3DtoDD(DDPIXELFORMAT *DDPixelFormat, WINED3DFORMAT WineD3DFormat);
631 WINED3DFORMAT PixelFormat_DD2WineD3D(const DDPIXELFORMAT *DDPixelFormat);
632 void DDRAW_dump_surface_desc(const DDSURFACEDESC2 *lpddsd);
633 void DDRAW_dump_pixelformat(const DDPIXELFORMAT *PixelFormat);
634 void dump_D3DMATRIX(const D3DMATRIX *mat);
635 void DDRAW_dump_DDCAPS(const DDCAPS *lpcaps);
636 DWORD get_flexible_vertex_size(DWORD d3dvtVertexType);
637 void DDRAW_dump_DDSCAPS2(const DDSCAPS2 *in);
638 void DDRAW_dump_cooperativelevel(DWORD cooplevel);
640 /* This only needs to be here as long the processvertices functionality of
641 * IDirect3DExecuteBuffer isn't in WineD3D */
642 void multiply_matrix(LPD3DMATRIX dest, const D3DMATRIX *src1, const D3DMATRIX *src2);
644 /* Used for generic dumping */
651 #define FE(x) { x, #x }
657 void (*func)(const void *);
662 #define ME(x,f,e) { x, #x, (void (*)(const void *))(f), offsetof(STRUCT, e) }
664 #define DD_STRUCT_COPY_BYSIZE(to,from) \
666 DWORD __size = (to)->dwSize; \
667 DWORD __copysize = __size; \
668 DWORD __resetsize = __size; \
669 assert(to != from); \
670 if (__resetsize > sizeof(*to)) \
671 __resetsize = sizeof(*to); \
672 memset(to,0,__resetsize); \
673 if ((from)->dwSize < __size) \
674 __copysize = (from)->dwSize; \
675 memcpy(to,from,__copysize); \
676 (to)->dwSize = __size;/*restore size*/ \
682 HRESULT hr_ddraw_from_wined3d(HRESULT hr);