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_DestroyDepthStencilSurface(IWineD3DSurface *pSurface);
81 /*****************************************************************************
82 * IDirectDraw implementation structure
83 *****************************************************************************/
85 struct IDirectDrawImpl
88 ICOM_VFIELD_MULTI(IDirectDraw7);
89 ICOM_VFIELD_MULTI(IDirectDraw4);
90 ICOM_VFIELD_MULTI(IDirectDraw2);
91 ICOM_VFIELD_MULTI(IDirectDraw);
92 ICOM_VFIELD_MULTI(IDirect3D7);
93 ICOM_VFIELD_MULTI(IDirect3D3);
94 ICOM_VFIELD_MULTI(IDirect3D2);
95 ICOM_VFIELD_MULTI(IDirect3D);
97 /* See comment in IDirectDraw::AddRef */
98 LONG ref7, ref4, ref2, ref1, numIfaces;
100 /* WineD3D linkage */
102 IWineD3DDevice *wineD3DDevice;
103 IDirectDrawSurfaceImpl *DepthStencilBuffer;
104 BOOL d3d_initialized;
106 /* Misc ddraw fields */
112 /* DirectDraw things, which are not handled by WineD3D */
113 DWORD cooperative_level;
115 DWORD orig_width, orig_height;
124 IDirectDrawSurfaceImpl *d3d_target;
126 IDirect3DDeviceImpl *d3ddevice;
133 /* The surface type to request */
134 WINED3DSURFTYPE ImplType;
137 /* Our private window class */
141 /* Helpers for surface creation */
142 IDirectDrawSurfaceImpl *tex_root;
145 /* For the dll unload cleanup code */
146 struct list ddraw_list_entry;
147 /* The surface list - can't relay this to WineD3D
150 struct list surface_list;
154 /* Declare the VTables. They can be found ddraw.c */
155 const IDirectDraw7Vtbl IDirectDraw7_Vtbl;
156 const IDirectDraw4Vtbl IDirectDraw4_Vtbl;
157 const IDirectDraw2Vtbl IDirectDraw2_Vtbl;
158 const IDirectDrawVtbl IDirectDraw1_Vtbl;
160 /* Helper structures */
161 typedef struct EnumDisplayModesCBS
164 LPDDENUMMODESCALLBACK2 callback;
165 } EnumDisplayModesCBS;
167 typedef struct EnumSurfacesCBS
170 LPDDENUMSURFACESCALLBACK7 callback;
171 LPDDSURFACEDESC2 pDDSD;
175 /* Utility functions */
177 DDRAW_Convert_DDSCAPS_1_To_2(const DDSCAPS* pIn,
180 DDRAW_Convert_DDDEVICEIDENTIFIER_2_To_1(const DDDEVICEIDENTIFIER2* pIn,
181 DDDEVICEIDENTIFIER* pOut);
183 IDirectDrawImpl_Destroy(IDirectDrawImpl *This);
186 IDirectDrawImpl_RecreateSurfacesCallback(IDirectDrawSurface7 *surf,
187 DDSURFACEDESC2 *desc,
190 remove_ddraw_object(IDirectDrawImpl *ddraw);
192 /* The default surface type */
193 extern WINED3DSURFTYPE DefaultSurfaceType;
195 /*****************************************************************************
196 * IDirectDrawSurface implementation structure
197 *****************************************************************************/
199 struct IDirectDrawSurfaceImpl
201 /* IUnknown fields */
202 ICOM_VFIELD_MULTI(IDirectDrawSurface7);
203 ICOM_VFIELD_MULTI(IDirectDrawSurface3);
204 ICOM_VFIELD_MULTI(IDirectDrawGammaControl);
205 ICOM_VFIELD_MULTI(IDirect3DTexture2);
206 ICOM_VFIELD_MULTI(IDirect3DTexture);
209 IUnknown *ifaceToRelease;
213 /* Connections to other Objects */
214 IDirectDrawImpl *ddraw;
215 IWineD3DSurface *WineD3DSurface;
216 IWineD3DTexture *wineD3DTexture;
218 /* This implementation handles attaching surfaces to other surfaces */
219 IDirectDrawSurfaceImpl *next_attached;
220 IDirectDrawSurfaceImpl *first_attached;
221 IDirectDrawSurfaceImpl *next_complex;
222 IDirectDrawSurfaceImpl *first_complex;
224 /* Surface description, for GetAttachedSurface */
225 DDSURFACEDESC2 surface_desc;
228 DWORD uniqueness_value;
230 WINED3DSURFTYPE ImplType;
232 /* For D3DDevice creation */
235 /* Clipper objects */
236 IDirectDrawClipperImpl *clipper;
238 /* For the ddraw surface list */
239 struct list surface_list_entry;
244 /* VTable declaration. It's located in surface.c / surface_thunks.c */
245 const IDirectDrawSurface7Vtbl IDirectDrawSurface7_Vtbl;
246 const IDirectDrawSurface3Vtbl IDirectDrawSurface3_Vtbl;
247 const IDirectDrawGammaControlVtbl IDirectDrawGammaControl_Vtbl;
248 const IDirect3DTexture2Vtbl IDirect3DTexture2_Vtbl;
249 const IDirect3DTextureVtbl IDirect3DTexture1_Vtbl;
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)
255 /*****************************************************************************
256 * IParent Implementation
257 *****************************************************************************/
260 /* IUnknown fields */
261 ICOM_VFIELD_MULTI(IParent);
264 /* IParentImpl fields */
269 const IParentVtbl IParent_Vtbl;
271 /*****************************************************************************
272 * IDirect3DDevice implementation
273 *****************************************************************************/
276 DDrawHandle_Unknown = 0,
277 DDrawHandle_Texture = 1,
278 DDrawHandle_Material = 2,
279 DDrawHandle_Matrix = 3,
280 DDrawHandle_StateBlock = 4
286 DDrawHandleTypes type;
289 struct IDirect3DDeviceImpl
292 ICOM_VFIELD_MULTI(IDirect3DDevice7);
293 ICOM_VFIELD_MULTI(IDirect3DDevice3);
294 ICOM_VFIELD_MULTI(IDirect3DDevice2);
295 ICOM_VFIELD_MULTI(IDirect3DDevice);
298 /* Other object connections */
299 IWineD3DDevice *wineD3DDevice;
300 IDirectDrawImpl *ddraw;
301 IWineD3DIndexBuffer *indexbuffer;
302 IDirectDrawSurfaceImpl *target;
303 BOOL OffScreenTarget;
305 /* Viewport management */
306 IDirect3DViewportImpl *viewport_list;
307 IDirect3DViewportImpl *current_viewport;
308 D3DVIEWPORT7 active_viewport;
313 /* Rendering functions to wrap D3D(1-3) to D3D7 */
314 D3DPRIMITIVETYPE primitive_type;
318 LPBYTE vertex_buffer;
322 /* Handle management */
323 struct HandleEntry *Handles;
327 /* Vtables in various versions */
328 const IDirect3DDevice7Vtbl IDirect3DDevice7_Vtbl;
329 const IDirect3DDevice3Vtbl IDirect3DDevice3_Vtbl;
330 const IDirect3DDevice2Vtbl IDirect3DDevice2_Vtbl;
331 const IDirect3DDeviceVtbl IDirect3DDevice1_Vtbl;
334 const GUID IID_D3DDEVICE_WineD3D;
336 /* Helper functions */
337 HRESULT IDirect3DImpl_GetCaps(IWineD3D *WineD3D, D3DDEVICEDESC *Desc123, D3DDEVICEDESC7 *Desc7);
338 DWORD IDirect3DDeviceImpl_CreateHandle(IDirect3DDeviceImpl *This);
341 struct EnumTextureFormatsCBS
343 LPD3DENUMTEXTUREFORMATSCALLBACK cbv2;
344 LPD3DENUMPIXELFORMATSCALLBACK cbv7;
348 /*****************************************************************************
349 * IDirect3D implementation
350 *****************************************************************************/
352 /* No implementation structure as this is only another interface to DirectDraw */
355 const IDirect3DVtbl IDirect3D1_Vtbl;
356 const IDirect3D2Vtbl IDirect3D2_Vtbl;
357 const IDirect3D3Vtbl IDirect3D3_Vtbl;
358 const IDirect3D7Vtbl IDirect3D7_Vtbl;
360 /* Structure for EnumZBufferFormats */
361 struct EnumZBufferFormatsData
363 LPD3DENUMPIXELFORMATSCALLBACK Callback;
367 /*****************************************************************************
368 * IDirectDrawClipper implementation structure
369 *****************************************************************************/
370 struct IDirectDrawClipperImpl
372 /* IUnknown fields */
373 ICOM_VFIELD_MULTI(IDirectDrawClipper);
376 /* IDirectDrawClipper fields */
379 IDirectDrawImpl* ddraw_owner;
380 struct IDirectDrawClipperImpl* prev_ddraw;
381 struct IDirectDrawClipperImpl* next_ddraw;
384 const IDirectDrawClipperVtbl IDirectDrawClipper_Vtbl;
386 /*****************************************************************************
387 * IDirectDrawPalette implementation structure
388 *****************************************************************************/
389 struct IDirectDrawPaletteImpl
391 /* IUnknown fields */
392 ICOM_VFIELD_MULTI(IDirectDrawPalette);
396 IWineD3DPalette *wineD3DPalette;
398 /* IDirectDrawPalette fields */
399 IDirectDrawImpl *ddraw_owner;
400 IUnknown *ifaceToRelease;
402 const IDirectDrawPaletteVtbl IDirectDrawPalette_Vtbl;
404 /******************************************************************************
405 * DirectDraw ClassFactory implementation - incomplete
406 ******************************************************************************/
409 ICOM_VFIELD_MULTI(IClassFactory);
412 HRESULT (*pfnCreateInstance)(IUnknown *pUnkOuter, REFIID iid, LPVOID *ppObj);
415 /* Helper structures */
416 struct object_creation_info
419 HRESULT (*pfnCreateInstance)(IUnknown *pUnkOuter, REFIID riid,
423 /******************************************************************************
424 * IDirect3DLight implementation structure - Wraps to D3D7
425 ******************************************************************************/
426 struct IDirect3DLightImpl
428 ICOM_VFIELD_MULTI(IDirect3DLight);
431 /* IDirect3DLight fields */
432 IDirectDrawImpl *ddraw;
434 /* If this light is active for one viewport, put the viewport here */
435 IDirect3DViewportImpl *active_viewport;
442 /* Chained list used for adding / removing from viewports */
443 IDirect3DLightImpl *next;
445 /* Activation function */
446 void (*activate)(IDirect3DLightImpl*);
447 void (*desactivate)(IDirect3DLightImpl*);
448 void (*update)(IDirect3DLightImpl*);
452 const IDirect3DLightVtbl IDirect3DLight_Vtbl;
454 /* Helper functions */
455 void light_update(IDirect3DLightImpl* This);
456 void light_activate(IDirect3DLightImpl* This);
457 void light_desactivate(IDirect3DLightImpl* This);
459 /******************************************************************************
460 * IDirect3DMaterial implementation structure - Wraps to D3D7
461 ******************************************************************************/
462 struct IDirect3DMaterialImpl
464 ICOM_VFIELD_MULTI(IDirect3DMaterial3);
465 ICOM_VFIELD_MULTI(IDirect3DMaterial2);
466 ICOM_VFIELD_MULTI(IDirect3DMaterial);
469 /* IDirect3DMaterial2 fields */
470 IDirectDrawImpl *ddraw;
471 IDirect3DDeviceImpl *active_device;
476 void (*activate)(IDirect3DMaterialImpl* this);
479 /* VTables in various versions */
480 const IDirect3DMaterialVtbl IDirect3DMaterial_Vtbl;
481 const IDirect3DMaterial2Vtbl IDirect3DMaterial2_Vtbl;
482 const IDirect3DMaterial3Vtbl IDirect3DMaterial3_Vtbl;
484 /* Helper functions */
485 void material_activate(IDirect3DMaterialImpl* This);
487 /*****************************************************************************
488 * IDirect3DViewport - Wraps to D3D7
489 *****************************************************************************/
490 struct IDirect3DViewportImpl
492 ICOM_VFIELD_MULTI(IDirect3DViewport3);
495 /* IDirect3DViewport fields */
496 IDirectDrawImpl *ddraw;
498 /* If this viewport is active for one device, put the device here */
499 IDirect3DDeviceImpl *active_device;
512 /* Activation function */
513 void (*activate)(IDirect3DViewportImpl*);
515 /* Field used to chain viewports together */
516 IDirect3DViewportImpl *next;
519 IDirect3DLightImpl *lights;
521 /* Background material */
522 IDirect3DMaterialImpl *background;
526 const IDirect3DViewport3Vtbl IDirect3DViewport3_Vtbl;
528 /* Helper functions */
529 void viewport_activate(IDirect3DViewportImpl* This);
531 /*****************************************************************************
532 * IDirect3DExecuteBuffer - Wraps to D3D7
533 *****************************************************************************/
534 struct IDirect3DExecuteBufferImpl
537 ICOM_VFIELD_MULTI(IDirect3DExecuteBuffer);
540 /* IDirect3DExecuteBuffer fields */
541 IDirectDrawImpl *ddraw;
542 IDirect3DDeviceImpl *d3ddev;
544 D3DEXECUTEBUFFERDESC desc;
547 /* This buffer will store the transformed vertices */
552 /* This flags is set to TRUE if we allocated ourselves the
559 const IDirect3DExecuteBufferVtbl IDirect3DExecuteBuffer_Vtbl;
561 /* The execute function */
563 IDirect3DExecuteBufferImpl_Execute(IDirect3DExecuteBufferImpl *This,
564 IDirect3DDeviceImpl *Device,
565 IDirect3DViewportImpl *ViewportImpl);
567 /*****************************************************************************
568 * IDirect3DVertexBuffer
569 *****************************************************************************/
570 struct IDirect3DVertexBufferImpl
572 /*** IUnknown Methods ***/
573 ICOM_VFIELD_MULTI(IDirect3DVertexBuffer7);
574 ICOM_VFIELD_MULTI(IDirect3DVertexBuffer);
577 /*** WineD3D link ***/
578 IWineD3DVertexBuffer *wineD3DVertexBuffer;
580 /*** Storage for D3D7 specific things ***/
585 const IDirect3DVertexBuffer7Vtbl IDirect3DVertexBuffer7_Vtbl;
586 const IDirect3DVertexBufferVtbl IDirect3DVertexBuffer1_Vtbl;
588 /*****************************************************************************
589 * Helper functions from utils.c
590 *****************************************************************************/
592 #define GET_TEXCOUNT_FROM_FVF(d3dvtVertexType) \
593 (((d3dvtVertexType) & D3DFVF_TEXCOUNT_MASK) >> D3DFVF_TEXCOUNT_SHIFT)
595 #define GET_TEXCOORD_SIZE_FROM_FVF(d3dvtVertexType, tex_num) \
596 (((((d3dvtVertexType) >> (16 + (2 * (tex_num)))) + 1) & 0x03) + 1)
598 void PixelFormat_WineD3DtoDD(DDPIXELFORMAT *DDPixelFormat, WINED3DFORMAT WineD3DFormat);
599 WINED3DFORMAT PixelFormat_DD2WineD3D(DDPIXELFORMAT *DDPixelFormat);
600 void DDRAW_dump_surface_desc(const DDSURFACEDESC2 *lpddsd);
601 void DDRAW_dump_pixelformat(const DDPIXELFORMAT *PixelFormat);
602 void dump_D3DMATRIX(D3DMATRIX *mat);
603 void DDRAW_dump_DDCAPS(const DDCAPS *lpcaps);
604 DWORD get_flexible_vertex_size(DWORD d3dvtVertexType);
605 void DDRAW_dump_DDSCAPS2(const DDSCAPS2 *in);
606 void DDRAW_dump_cooperativelevel(DWORD cooplevel);
608 /* This only needs to be here as long the processvertices functionality of
609 * IDirect3DExecuteBuffer isn't in WineD3D */
610 void multiply_matrix(LPD3DMATRIX dest, LPD3DMATRIX src1, LPD3DMATRIX src2);
612 /* Used for generic dumping */
619 #define FE(x) { x, #x }
625 void (*func)(const void *);
630 #define DDRAW_dump_flags(flags,names,num_names) DDRAW_dump_flags_(flags, names, num_names, 1)
631 #define ME(x,f,e) { x, #x, (void (*)(const void *))(f), offsetof(STRUCT, e) }
633 #define DD_STRUCT_COPY_BYSIZE(to,from) \
635 DWORD __size = (to)->dwSize; \
636 DWORD __copysize = __size; \
637 DWORD __resetsize = __size; \
638 assert(to != from); \
639 if (__resetsize > sizeof(*to)) \
640 __resetsize = sizeof(*to); \
641 memset(to,0,__resetsize); \
642 if ((from)->dwSize < __size) \
643 __copysize = (from)->dwSize; \
644 memcpy(to,from,__copysize); \
645 (to)->dwSize = __size;/*restore size*/ \
651 HRESULT hr_ddraw_from_wined3d(HRESULT hr);