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 /*****************************************************************************
84 * IDirectDraw implementation structure
85 *****************************************************************************/
89 IWineD3DVertexDeclaration *decl;
92 struct IDirectDrawImpl
95 ICOM_VFIELD_MULTI(IDirectDraw7);
96 ICOM_VFIELD_MULTI(IDirectDraw4);
97 ICOM_VFIELD_MULTI(IDirectDraw3);
98 ICOM_VFIELD_MULTI(IDirectDraw2);
99 ICOM_VFIELD_MULTI(IDirectDraw);
100 ICOM_VFIELD_MULTI(IDirect3D7);
101 ICOM_VFIELD_MULTI(IDirect3D3);
102 ICOM_VFIELD_MULTI(IDirect3D2);
103 ICOM_VFIELD_MULTI(IDirect3D);
105 /* See comment in IDirectDraw::AddRef */
106 LONG ref7, ref4, ref2, ref3, ref1, numIfaces;
108 /* WineD3D linkage */
110 IWineD3DDevice *wineD3DDevice;
111 IDirectDrawSurfaceImpl *DepthStencilBuffer;
112 BOOL d3d_initialized;
114 /* Misc ddraw fields */
120 /* DirectDraw things, which are not handled by WineD3D */
121 DWORD cooperative_level;
123 DWORD orig_width, orig_height;
129 IDirectDrawSurfaceImpl *d3d_target;
131 IDirect3DDeviceImpl *d3ddevice;
138 /* The surface type to request */
139 WINED3DSURFTYPE ImplType;
142 /* Our private window class */
146 /* Helpers for surface creation */
147 IDirectDrawSurfaceImpl *tex_root;
150 /* For the dll unload cleanup code */
151 struct list ddraw_list_entry;
152 /* The surface list - can't relay this to WineD3D
155 struct list surface_list;
159 struct FvfToDecl *decls;
160 UINT numConvertedDecls, declArraySize;
163 /* Declare the VTables. They can be found ddraw.c */
164 const IDirectDraw7Vtbl IDirectDraw7_Vtbl;
165 const IDirectDraw4Vtbl IDirectDraw4_Vtbl;
166 const IDirectDraw3Vtbl IDirectDraw3_Vtbl;
167 const IDirectDraw2Vtbl IDirectDraw2_Vtbl;
168 const IDirectDrawVtbl IDirectDraw1_Vtbl;
170 /* Helper structures */
171 typedef struct EnumDisplayModesCBS
174 LPDDENUMMODESCALLBACK2 callback;
175 } EnumDisplayModesCBS;
177 typedef struct EnumSurfacesCBS
180 LPDDENUMSURFACESCALLBACK7 callback;
181 LPDDSURFACEDESC2 pDDSD;
185 /* Utility functions */
187 DDRAW_Convert_DDSCAPS_1_To_2(const DDSCAPS* pIn,
190 DDRAW_Convert_DDDEVICEIDENTIFIER_2_To_1(const DDDEVICEIDENTIFIER2* pIn,
191 DDDEVICEIDENTIFIER* pOut);
193 IDirectDrawImpl_Destroy(IDirectDrawImpl *This);
196 IDirectDrawImpl_RecreateSurfacesCallback(IDirectDrawSurface7 *surf,
197 DDSURFACEDESC2 *desc,
199 IWineD3DVertexDeclaration *
200 IDirectDrawImpl_FindDecl(IDirectDrawImpl *This,
204 remove_ddraw_object(IDirectDrawImpl *ddraw);
206 /* The default surface type */
207 extern WINED3DSURFTYPE DefaultSurfaceType;
209 /*****************************************************************************
210 * IDirectDrawSurface implementation structure
211 *****************************************************************************/
213 struct IDirectDrawSurfaceImpl
215 /* IUnknown fields */
216 ICOM_VFIELD_MULTI(IDirectDrawSurface7);
217 ICOM_VFIELD_MULTI(IDirectDrawSurface3);
218 ICOM_VFIELD_MULTI(IDirectDrawGammaControl);
219 ICOM_VFIELD_MULTI(IDirect3DTexture2);
220 ICOM_VFIELD_MULTI(IDirect3DTexture);
223 IUnknown *ifaceToRelease;
227 /* Connections to other Objects */
228 IDirectDrawImpl *ddraw;
229 IWineD3DSurface *WineD3DSurface;
230 IWineD3DBaseTexture *wineD3DTexture;
232 /* This implementation handles attaching surfaces to other surfaces */
233 IDirectDrawSurfaceImpl *next_attached;
234 IDirectDrawSurfaceImpl *first_attached;
236 /* Complex surfaces are organized in a tree, although the tree is degenerated to a list in most cases.
237 * In mipmap and primary surfaces each level has only one attachment, which is the next surface level.
238 * Only the cube texture root has 6 surfaces attached, which then have a normal mipmap chain attached
239 * to them. So hardcode the array to 6, a dynamic array or a list would be an overkill.
241 #define MAX_COMPLEX_ATTACHED 6
242 IDirectDrawSurfaceImpl *complex_array[MAX_COMPLEX_ATTACHED];
243 /* You can't traverse the tree upwards. Only a flag for Surface::Release because its needed there,
244 * but no pointer to prevent temptations to traverse it in the wrong direction.
246 BOOL is_complex_root;
248 /* Surface description, for GetAttachedSurface */
249 DDSURFACEDESC2 surface_desc;
252 DWORD uniqueness_value;
254 WINED3DSURFTYPE ImplType;
256 /* For D3DDevice creation */
259 /* Clipper objects */
260 IDirectDrawClipperImpl *clipper;
262 /* For the ddraw surface list */
263 struct list surface_list_entry;
268 /* VTable declaration. It's located in surface.c / surface_thunks.c */
269 const IDirectDrawSurface7Vtbl IDirectDrawSurface7_Vtbl;
270 const IDirectDrawSurface3Vtbl IDirectDrawSurface3_Vtbl;
271 const IDirectDrawGammaControlVtbl IDirectDrawGammaControl_Vtbl;
272 const IDirect3DTexture2Vtbl IDirect3DTexture2_Vtbl;
273 const IDirect3DTextureVtbl IDirect3DTexture1_Vtbl;
275 /* Get the number of bytes per pixel for a given surface */
276 #define PFGET_BPP(pf) (pf.dwFlags&DDPF_PALETTEINDEXED8?1:((pf.dwRGBBitCount+7)/8))
277 #define GET_BPP(desc) PFGET_BPP(desc.ddpfPixelFormat)
279 /*****************************************************************************
280 * IParent Implementation
281 *****************************************************************************/
284 /* IUnknown fields */
285 ICOM_VFIELD_MULTI(IParent);
288 /* IParentImpl fields */
293 const IParentVtbl IParent_Vtbl;
295 /*****************************************************************************
296 * IDirect3DDevice implementation
297 *****************************************************************************/
300 DDrawHandle_Unknown = 0,
301 DDrawHandle_Texture = 1,
302 DDrawHandle_Material = 2,
303 DDrawHandle_Matrix = 3,
304 DDrawHandle_StateBlock = 4
310 DDrawHandleTypes type;
313 struct IDirect3DDeviceImpl
316 ICOM_VFIELD_MULTI(IDirect3DDevice7);
317 ICOM_VFIELD_MULTI(IDirect3DDevice3);
318 ICOM_VFIELD_MULTI(IDirect3DDevice2);
319 ICOM_VFIELD_MULTI(IDirect3DDevice);
322 /* Other object connections */
323 IWineD3DDevice *wineD3DDevice;
324 IDirectDrawImpl *ddraw;
325 IWineD3DIndexBuffer *indexbuffer;
326 IDirectDrawSurfaceImpl *target;
327 BOOL OffScreenTarget;
329 /* Viewport management */
330 IDirect3DViewportImpl *viewport_list;
331 IDirect3DViewportImpl *current_viewport;
332 D3DVIEWPORT7 active_viewport;
337 /* Rendering functions to wrap D3D(1-3) to D3D7 */
338 D3DPRIMITIVETYPE primitive_type;
342 LPBYTE vertex_buffer;
346 /* Handle management */
347 struct HandleEntry *Handles;
351 /* Vtables in various versions */
352 const IDirect3DDevice7Vtbl IDirect3DDevice7_Vtbl;
353 const IDirect3DDevice3Vtbl IDirect3DDevice3_Vtbl;
354 const IDirect3DDevice2Vtbl IDirect3DDevice2_Vtbl;
355 const IDirect3DDeviceVtbl IDirect3DDevice1_Vtbl;
358 const GUID IID_D3DDEVICE_WineD3D;
360 /* Helper functions */
361 HRESULT IDirect3DImpl_GetCaps(IWineD3D *WineD3D, D3DDEVICEDESC *Desc123, D3DDEVICEDESC7 *Desc7);
362 DWORD IDirect3DDeviceImpl_CreateHandle(IDirect3DDeviceImpl *This);
363 WINED3DZBUFFERTYPE IDirect3DDeviceImpl_UpdateDepthStencil(IDirect3DDeviceImpl *This);
366 struct EnumTextureFormatsCBS
368 LPD3DENUMTEXTUREFORMATSCALLBACK cbv2;
369 LPD3DENUMPIXELFORMATSCALLBACK cbv7;
373 /*****************************************************************************
374 * IDirect3D implementation
375 *****************************************************************************/
377 /* No implementation structure as this is only another interface to DirectDraw */
380 const IDirect3DVtbl IDirect3D1_Vtbl;
381 const IDirect3D2Vtbl IDirect3D2_Vtbl;
382 const IDirect3D3Vtbl IDirect3D3_Vtbl;
383 const IDirect3D7Vtbl IDirect3D7_Vtbl;
385 /* Structure for EnumZBufferFormats */
386 struct EnumZBufferFormatsData
388 LPD3DENUMPIXELFORMATSCALLBACK Callback;
392 /*****************************************************************************
393 * IDirectDrawClipper implementation structure
394 *****************************************************************************/
395 struct IDirectDrawClipperImpl
397 /* IUnknown fields */
398 ICOM_VFIELD_MULTI(IDirectDrawClipper);
401 IWineD3DClipper *wineD3DClipper;
402 IDirectDrawImpl *ddraw_owner;
405 const IDirectDrawClipperVtbl IDirectDrawClipper_Vtbl;
407 typedef IWineD3DClipper* (WINAPI *fnWineDirect3DCreateClipper)(IUnknown *);
408 fnWineDirect3DCreateClipper pWineDirect3DCreateClipper;
410 /*****************************************************************************
411 * IDirectDrawPalette implementation structure
412 *****************************************************************************/
413 struct IDirectDrawPaletteImpl
415 /* IUnknown fields */
416 ICOM_VFIELD_MULTI(IDirectDrawPalette);
420 IWineD3DPalette *wineD3DPalette;
422 /* IDirectDrawPalette fields */
423 IDirectDrawImpl *ddraw_owner;
424 IUnknown *ifaceToRelease;
426 const IDirectDrawPaletteVtbl IDirectDrawPalette_Vtbl;
428 /******************************************************************************
429 * DirectDraw ClassFactory implementation - incomplete
430 ******************************************************************************/
433 ICOM_VFIELD_MULTI(IClassFactory);
436 HRESULT (*pfnCreateInstance)(IUnknown *pUnkOuter, REFIID iid, LPVOID *ppObj);
439 /* Helper structures */
440 struct object_creation_info
443 HRESULT (*pfnCreateInstance)(IUnknown *pUnkOuter, REFIID riid,
447 /******************************************************************************
448 * IDirect3DLight implementation structure - Wraps to D3D7
449 ******************************************************************************/
450 struct IDirect3DLightImpl
452 ICOM_VFIELD_MULTI(IDirect3DLight);
455 /* IDirect3DLight fields */
456 IDirectDrawImpl *ddraw;
458 /* If this light is active for one viewport, put the viewport here */
459 IDirect3DViewportImpl *active_viewport;
466 /* Chained list used for adding / removing from viewports */
467 IDirect3DLightImpl *next;
469 /* Activation function */
470 void (*activate)(IDirect3DLightImpl*);
471 void (*desactivate)(IDirect3DLightImpl*);
472 void (*update)(IDirect3DLightImpl*);
476 const IDirect3DLightVtbl IDirect3DLight_Vtbl;
478 /* Helper functions */
479 void light_update(IDirect3DLightImpl* This);
480 void light_activate(IDirect3DLightImpl* This);
481 void light_desactivate(IDirect3DLightImpl* This);
483 /******************************************************************************
484 * IDirect3DMaterial implementation structure - Wraps to D3D7
485 ******************************************************************************/
486 struct IDirect3DMaterialImpl
488 ICOM_VFIELD_MULTI(IDirect3DMaterial3);
489 ICOM_VFIELD_MULTI(IDirect3DMaterial2);
490 ICOM_VFIELD_MULTI(IDirect3DMaterial);
493 /* IDirect3DMaterial2 fields */
494 IDirectDrawImpl *ddraw;
495 IDirect3DDeviceImpl *active_device;
500 void (*activate)(IDirect3DMaterialImpl* this);
503 /* VTables in various versions */
504 const IDirect3DMaterialVtbl IDirect3DMaterial_Vtbl;
505 const IDirect3DMaterial2Vtbl IDirect3DMaterial2_Vtbl;
506 const IDirect3DMaterial3Vtbl IDirect3DMaterial3_Vtbl;
508 /* Helper functions */
509 void material_activate(IDirect3DMaterialImpl* This);
511 /*****************************************************************************
512 * IDirect3DViewport - Wraps to D3D7
513 *****************************************************************************/
514 struct IDirect3DViewportImpl
516 ICOM_VFIELD_MULTI(IDirect3DViewport3);
519 /* IDirect3DViewport fields */
520 IDirectDrawImpl *ddraw;
522 /* If this viewport is active for one device, put the device here */
523 IDirect3DDeviceImpl *active_device;
536 /* Activation function */
537 void (*activate)(IDirect3DViewportImpl*);
539 /* Field used to chain viewports together */
540 IDirect3DViewportImpl *next;
543 IDirect3DLightImpl *lights;
545 /* Background material */
546 IDirect3DMaterialImpl *background;
550 const IDirect3DViewport3Vtbl IDirect3DViewport3_Vtbl;
552 /* Helper functions */
553 void viewport_activate(IDirect3DViewportImpl* This);
555 /*****************************************************************************
556 * IDirect3DExecuteBuffer - Wraps to D3D7
557 *****************************************************************************/
558 struct IDirect3DExecuteBufferImpl
561 ICOM_VFIELD_MULTI(IDirect3DExecuteBuffer);
564 /* IDirect3DExecuteBuffer fields */
565 IDirectDrawImpl *ddraw;
566 IDirect3DDeviceImpl *d3ddev;
568 D3DEXECUTEBUFFERDESC desc;
571 /* This buffer will store the transformed vertices */
576 /* This flags is set to TRUE if we allocated ourselves the
583 const IDirect3DExecuteBufferVtbl IDirect3DExecuteBuffer_Vtbl;
585 /* The execute function */
587 IDirect3DExecuteBufferImpl_Execute(IDirect3DExecuteBufferImpl *This,
588 IDirect3DDeviceImpl *Device,
589 IDirect3DViewportImpl *ViewportImpl);
591 /*****************************************************************************
592 * IDirect3DVertexBuffer
593 *****************************************************************************/
594 struct IDirect3DVertexBufferImpl
596 /*** IUnknown Methods ***/
597 ICOM_VFIELD_MULTI(IDirect3DVertexBuffer7);
598 ICOM_VFIELD_MULTI(IDirect3DVertexBuffer);
601 /*** WineD3D and ddraw links ***/
602 IWineD3DVertexBuffer *wineD3DVertexBuffer;
603 IWineD3DVertexDeclaration *wineD3DVertexDeclaration;
604 IDirectDrawImpl *ddraw;
606 /*** Storage for D3D7 specific things ***/
611 const IDirect3DVertexBuffer7Vtbl IDirect3DVertexBuffer7_Vtbl;
612 const IDirect3DVertexBufferVtbl IDirect3DVertexBuffer1_Vtbl;
614 /*****************************************************************************
615 * Helper functions from utils.c
616 *****************************************************************************/
618 #define GET_TEXCOUNT_FROM_FVF(d3dvtVertexType) \
619 (((d3dvtVertexType) & D3DFVF_TEXCOUNT_MASK) >> D3DFVF_TEXCOUNT_SHIFT)
621 #define GET_TEXCOORD_SIZE_FROM_FVF(d3dvtVertexType, tex_num) \
622 (((((d3dvtVertexType) >> (16 + (2 * (tex_num)))) + 1) & 0x03) + 1)
624 void PixelFormat_WineD3DtoDD(DDPIXELFORMAT *DDPixelFormat, WINED3DFORMAT WineD3DFormat);
625 WINED3DFORMAT PixelFormat_DD2WineD3D(const DDPIXELFORMAT *DDPixelFormat);
626 void DDRAW_dump_surface_desc(const DDSURFACEDESC2 *lpddsd);
627 void DDRAW_dump_pixelformat(const DDPIXELFORMAT *PixelFormat);
628 void dump_D3DMATRIX(const D3DMATRIX *mat);
629 void DDRAW_dump_DDCAPS(const DDCAPS *lpcaps);
630 DWORD get_flexible_vertex_size(DWORD d3dvtVertexType);
631 void DDRAW_dump_DDSCAPS2(const DDSCAPS2 *in);
632 void DDRAW_dump_cooperativelevel(DWORD cooplevel);
634 /* This only needs to be here as long the processvertices functionality of
635 * IDirect3DExecuteBuffer isn't in WineD3D */
636 void multiply_matrix(LPD3DMATRIX dest, const D3DMATRIX *src1, const D3DMATRIX *src2);
638 /* Used for generic dumping */
645 #define FE(x) { x, #x }
651 void (*func)(const void *);
656 #define ME(x,f,e) { x, #x, (void (*)(const void *))(f), offsetof(STRUCT, e) }
658 #define DD_STRUCT_COPY_BYSIZE(to,from) \
660 DWORD __size = (to)->dwSize; \
661 DWORD __copysize = __size; \
662 DWORD __resetsize = __size; \
663 assert(to != from); \
664 if (__resetsize > sizeof(*to)) \
665 __resetsize = sizeof(*to); \
666 memset(to,0,__resetsize); \
667 if ((from)->dwSize < __size) \
668 __copysize = (from)->dwSize; \
669 memcpy(to,from,__copysize); \
670 (to)->dwSize = __size;/*restore size*/ \
676 HRESULT hr_ddraw_from_wined3d(HRESULT hr);