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"
40 /*****************************************************************************
41 * IParent - a helper interface
42 *****************************************************************************/
43 DEFINE_GUID(IID_IParent, 0xc20e4c88, 0x74e7, 0x4940, 0xba, 0x9f, 0x2e, 0x32, 0x3f, 0x9d, 0xc9, 0x81);
44 typedef struct IParent *LPPARENT, *PPARENT;
46 #define INTERFACE IParent
47 DECLARE_INTERFACE_(IParent,IUnknown)
49 /*** IUnknown methods ***/
50 STDMETHOD_(HRESULT,QueryInterface)(THIS_ REFIID riid, void** ppvObject) PURE;
51 STDMETHOD_(ULONG,AddRef)(THIS) PURE;
52 STDMETHOD_(ULONG,Release)(THIS) PURE;
56 #if !defined(__cplusplus) || defined(CINTERFACE)
57 /*** IUnknown methods ***/
58 #define IParent_QueryInterface(p,a,b) (p)->lpVtbl->QueryInterface(p,a,b)
59 #define IParent_AddRef(p) (p)->lpVtbl->AddRef(p)
60 #define IParent_Release(p) (p)->lpVtbl->Release(p)
64 /* Typdef the interfaces */
65 typedef struct IDirectDrawImpl IDirectDrawImpl;
66 typedef struct IDirectDrawSurfaceImpl IDirectDrawSurfaceImpl;
67 typedef struct IDirectDrawClipperImpl IDirectDrawClipperImpl;
68 typedef struct IDirectDrawPaletteImpl IDirectDrawPaletteImpl;
69 typedef struct IDirect3DDeviceImpl IDirect3DDeviceImpl;
70 typedef struct IDirect3DLightImpl IDirect3DLightImpl;
71 typedef struct IDirect3DViewportImpl IDirect3DViewportImpl;
72 typedef struct IDirect3DMaterialImpl IDirect3DMaterialImpl;
73 typedef struct IDirect3DExecuteBufferImpl IDirect3DExecuteBufferImpl;
74 typedef struct IDirect3DVertexBufferImpl IDirect3DVertexBufferImpl;
75 typedef struct IParentImpl IParentImpl;
77 /*****************************************************************************
78 * IDirectDraw implementation structure
79 *****************************************************************************/
81 struct IDirectDrawImpl
84 ICOM_VFIELD_MULTI(IDirectDraw7);
85 ICOM_VFIELD_MULTI(IDirectDraw4);
86 ICOM_VFIELD_MULTI(IDirectDraw2);
87 ICOM_VFIELD_MULTI(IDirectDraw);
88 ICOM_VFIELD_MULTI(IDirect3D7);
89 ICOM_VFIELD_MULTI(IDirect3D3);
90 ICOM_VFIELD_MULTI(IDirect3D2);
91 ICOM_VFIELD_MULTI(IDirect3D);
97 IWineD3DDevice *wineD3DDevice;
98 IDirectDrawSurfaceImpl *DepthStencilBuffer;
101 /* misc ddraw fields */
107 /* DirectDraw things, which are not handled by WineD3D */
108 DWORD cooperative_level;
110 DWORD orig_width, orig_height;
119 IDirectDrawSurfaceImpl *d3d_target;
121 IDirect3DDeviceImpl *d3ddevice;
127 /* The surface type to request */
128 WINED3DSURFTYPE ImplType;
130 /* The surface list - can't relay this to WineD3D
133 IDirectDrawSurfaceImpl *surface_list;
135 /* Our private window class */
139 /* Helpers for surface creation */
140 IDirectDrawSurfaceImpl *tex_root;
143 /* For the dll unload cleanup code */
144 IDirectDrawImpl *next;
149 /* Declare the VTables. They can be found ddraw.c */
150 const IDirectDraw7Vtbl IDirectDraw7_Vtbl;
151 const IDirectDraw4Vtbl IDirectDraw4_Vtbl;
152 const IDirectDraw2Vtbl IDirectDraw2_Vtbl;
153 const IDirectDrawVtbl IDirectDraw1_Vtbl;
155 /* Helper structures */
156 typedef struct EnumDisplayModesCBS
159 LPDDENUMMODESCALLBACK2 callback;
160 } EnumDisplayModesCBS;
162 typedef struct EnumSurfacesCBS
165 LPDDENUMSURFACESCALLBACK7 callback;
166 LPDDSURFACEDESC2 pDDSD;
170 /* Utility functions */
172 DDRAW_Convert_DDSCAPS_1_To_2(const DDSCAPS* pIn,
175 DDRAW_Convert_DDDEVICEIDENTIFIER_2_To_1(const DDDEVICEIDENTIFIER2* pIn,
176 DDDEVICEIDENTIFIER* pOut);
178 IDirectDrawImpl_Destroy(IDirectDrawImpl *This);
181 IDirectDrawImpl_RecreateSurfacesCallback(IDirectDrawSurface7 *surf,
182 DDSURFACEDESC2 *desc,
184 /* The cleanup list */
185 extern IDirectDrawImpl *ddraw_list;
187 /* The default surface type */
188 extern WINED3DSURFTYPE DefaultSurfaceType;
190 /*****************************************************************************
191 * IDirectDrawSurface implementation structure
192 *****************************************************************************/
194 struct IDirectDrawSurfaceImpl
196 /* IUnknown fields */
197 ICOM_VFIELD_MULTI(IDirectDrawSurface7);
198 ICOM_VFIELD_MULTI(IDirectDrawSurface3);
199 ICOM_VFIELD_MULTI(IDirectDrawGammaControl);
200 ICOM_VFIELD_MULTI(IDirect3DTexture2);
201 ICOM_VFIELD_MULTI(IDirect3DTexture);
207 /* Connections to other Objects */
208 IDirectDrawImpl *ddraw;
209 IWineD3DSurface *WineD3DSurface;
210 IWineD3DTexture *wineD3DTexture;
212 /* This implementation handles attaching surfaces to other surfaces */
213 IDirectDrawSurfaceImpl *next_attached;
214 IDirectDrawSurfaceImpl *first_attached;
215 IDirectDrawSurfaceImpl *next_complex;
216 IDirectDrawSurfaceImpl *first_complex;
218 /* Surface description, for GetAttachedSurface */
219 DDSURFACEDESC2 surface_desc;
222 DWORD uniqueness_value;
224 WINED3DSURFTYPE ImplType;
226 /* For D3DDevice creation */
229 /* Clipper objects */
230 IDirectDrawClipperImpl *clipper;
232 /* For the ddraw surface list */
233 IDirectDrawSurfaceImpl *next;
234 IDirectDrawSurfaceImpl *prev;
237 /* VTable declaration. It's located in surface.c / surface_thunks.c */
238 const IDirectDrawSurface7Vtbl IDirectDrawSurface7_Vtbl;
239 const IDirectDrawSurface3Vtbl IDirectDrawSurface3_Vtbl;
240 const IDirectDrawGammaControlVtbl IDirectDrawGammaControl_Vtbl;
241 const IDirect3DTexture2Vtbl IDirect3DTexture2_Vtbl;
242 const IDirect3DTextureVtbl IDirect3DTexture1_Vtbl;
244 /* Get the number of bytes per pixel for a given surface */
245 #define PFGET_BPP(pf) (pf.dwFlags&DDPF_PALETTEINDEXED8?1:((pf.dwRGBBitCount+7)/8))
246 #define GET_BPP(desc) PFGET_BPP(desc.ddpfPixelFormat)
248 /*****************************************************************************
249 * IParent Implementation
250 *****************************************************************************/
253 /* IUnknown fields */
254 ICOM_VFIELD_MULTI(IParent);
257 /* IParentImpl fields */
262 const IParentVtbl IParent_Vtbl;
264 /*****************************************************************************
265 * IDirect3DDevice implementation
266 *****************************************************************************/
267 struct IDirect3DDeviceImpl
270 ICOM_VFIELD_MULTI(IDirect3DDevice7);
271 ICOM_VFIELD_MULTI(IDirect3DDevice3);
272 ICOM_VFIELD_MULTI(IDirect3DDevice2);
273 ICOM_VFIELD_MULTI(IDirect3DDevice);
276 /* Other object connections */
277 IWineD3DDevice *wineD3DDevice;
278 IDirectDrawImpl *ddraw;
279 IWineD3DIndexBuffer *indexbuffer;
280 IDirectDrawSurfaceImpl *target;
281 BOOL OffScreenTarget;
283 /* Viewport management */
284 IDirect3DViewportImpl *viewport_list;
285 IDirect3DViewportImpl *current_viewport;
286 D3DVIEWPORT7 active_viewport;
291 /* Rendering functions to wrap D3D(1-3) to D3D7 */
292 D3DPRIMITIVETYPE primitive_type;
296 LPBYTE vertex_buffer;
301 /* Vtables in various versions */
302 const IDirect3DDevice7Vtbl IDirect3DDevice7_Vtbl;
303 const IDirect3DDevice3Vtbl IDirect3DDevice3_Vtbl;
304 const IDirect3DDevice2Vtbl IDirect3DDevice2_Vtbl;
305 const IDirect3DDeviceVtbl IDirect3DDevice1_Vtbl;
308 const GUID IID_D3DDEVICE_WineD3D;
310 /* Helper functions */
311 HRESULT IDirect3DImpl_GetCaps(IWineD3D *WineD3D, D3DDEVICEDESC *Desc123, D3DDEVICEDESC7 *Desc7);
314 struct EnumTextureFormatsCBS
316 LPD3DENUMTEXTUREFORMATSCALLBACK cbv2;
317 LPD3DENUMPIXELFORMATSCALLBACK cbv7;
321 /*****************************************************************************
322 * IDirect3D implementation
323 *****************************************************************************/
325 /* No implementation structure as this is only another interface to DirectDraw */
328 const IDirect3DVtbl IDirect3D1_Vtbl;
329 const IDirect3D2Vtbl IDirect3D2_Vtbl;
330 const IDirect3D3Vtbl IDirect3D3_Vtbl;
331 const IDirect3D7Vtbl IDirect3D7_Vtbl;
333 /* Structure for EnumZBufferFormats */
334 struct EnumZBufferFormatsData
336 LPD3DENUMPIXELFORMATSCALLBACK Callback;
340 /*****************************************************************************
341 * IDirectDrawClipper implementation structure
342 *****************************************************************************/
343 struct IDirectDrawClipperImpl
345 /* IUnknown fields */
346 ICOM_VFIELD_MULTI(IDirectDrawClipper);
349 /* IDirectDrawClipper fields */
352 IDirectDrawImpl* ddraw_owner;
353 struct IDirectDrawClipperImpl* prev_ddraw;
354 struct IDirectDrawClipperImpl* next_ddraw;
357 const IDirectDrawClipperVtbl IDirectDrawClipper_Vtbl;
359 /*****************************************************************************
360 * IDirectDrawPalette implementation structure
361 *****************************************************************************/
362 struct IDirectDrawPaletteImpl
364 /* IUnknown fields */
365 ICOM_VFIELD_MULTI(IDirectDrawPalette);
369 IWineD3DPalette *wineD3DPalette;
371 /* IDirectDrawPalette fields */
372 IDirectDrawImpl *ddraw_owner;
374 const IDirectDrawPaletteVtbl IDirectDrawPalette_Vtbl;
376 /******************************************************************************
377 * DirectDraw ClassFactory Implementation - incomplete
378 ******************************************************************************/
381 ICOM_VFIELD_MULTI(IClassFactory);
384 HRESULT (*pfnCreateInstance)(IUnknown *pUnkOuter, REFIID iid, LPVOID *ppObj);
387 /* Helper structures */
388 struct object_creation_info
391 HRESULT (*pfnCreateInstance)(IUnknown *pUnkOuter, REFIID riid,
395 /******************************************************************************
396 * IDirect3DLight implementation structure - Wraps to D3D7
397 ******************************************************************************/
398 struct IDirect3DLightImpl
400 ICOM_VFIELD_MULTI(IDirect3DLight);
403 /* IDirect3DLight fields */
404 IDirectDrawImpl *ddraw;
406 /* If this light is active for one viewport, put the viewport here */
407 IDirect3DViewportImpl *active_viewport;
414 /* Chained list used for adding / removing from viewports */
415 IDirect3DLightImpl *next;
417 /* Activation function */
418 void (*activate)(IDirect3DLightImpl*);
419 void (*desactivate)(IDirect3DLightImpl*);
420 void (*update)(IDirect3DLightImpl*);
424 const IDirect3DLightVtbl IDirect3DLight_Vtbl;
426 /* Helper functions */
427 void light_update(IDirect3DLightImpl* This);
428 void light_activate(IDirect3DLightImpl* This);
429 void light_desactivate(IDirect3DLightImpl* This);
431 /******************************************************************************
432 * IDirect3DMaterial implementation structure - Wraps to D3D7
433 ******************************************************************************/
434 struct IDirect3DMaterialImpl
436 ICOM_VFIELD_MULTI(IDirect3DMaterial3);
437 ICOM_VFIELD_MULTI(IDirect3DMaterial2);
438 ICOM_VFIELD_MULTI(IDirect3DMaterial);
441 /* IDirect3DMaterial2 fields */
442 IDirectDrawImpl *ddraw;
443 IDirect3DDeviceImpl *active_device;
447 void (*activate)(IDirect3DMaterialImpl* this);
450 /* VTables in varios versions */
451 const IDirect3DMaterialVtbl IDirect3DMaterial_Vtbl;
452 const IDirect3DMaterial2Vtbl IDirect3DMaterial2_Vtbl;
453 const IDirect3DMaterial3Vtbl IDirect3DMaterial3_Vtbl;
455 /* Helper functions */
456 void material_activate(IDirect3DMaterialImpl* This);
458 /*****************************************************************************
459 * IDirect3DViewport - Wraps to D3D7
460 *****************************************************************************/
461 struct IDirect3DViewportImpl
463 ICOM_VFIELD_MULTI(IDirect3DViewport3);
466 /* IDirect3DViewport fields */
467 IDirectDrawImpl *ddraw;
469 /* If this viewport is active for one device, put the device here */
470 IDirect3DDeviceImpl *active_device;
483 /* Activation function */
484 void (*activate)(IDirect3DViewportImpl*);
486 /* Field used to chain viewports together */
487 IDirect3DViewportImpl *next;
490 IDirect3DLightImpl *lights;
492 /* Background material */
493 IDirect3DMaterialImpl *background;
497 const IDirect3DViewport3Vtbl IDirect3DViewport3_Vtbl;
499 /* Helper functions */
500 void viewport_activate(IDirect3DViewportImpl* This);
502 /*****************************************************************************
503 * IDirect3DExecuteBuffer - Wraps to D3D7
504 *****************************************************************************/
505 struct IDirect3DExecuteBufferImpl
508 ICOM_VFIELD_MULTI(IDirect3DExecuteBuffer);
511 /* IDirect3DExecuteBuffer fields */
512 IDirectDrawImpl *ddraw;
513 IDirect3DDeviceImpl *d3ddev;
515 D3DEXECUTEBUFFERDESC desc;
518 /* This buffer will store the transformed vertices */
523 /* This flags is set to TRUE if we allocated ourselves the
530 const IDirect3DExecuteBufferVtbl IDirect3DExecuteBuffer_Vtbl;
532 /* The execute function */
534 IDirect3DExecuteBufferImpl_Execute(IDirect3DExecuteBufferImpl *This,
535 IDirect3DDeviceImpl *Device,
536 IDirect3DViewportImpl *ViewportImpl);
538 /*****************************************************************************
539 * IDirect3DVertexBuffer
540 *****************************************************************************/
541 struct IDirect3DVertexBufferImpl
543 /*** IUnknown Methods ***/
544 ICOM_VFIELD_MULTI(IDirect3DVertexBuffer7);
545 ICOM_VFIELD_MULTI(IDirect3DVertexBuffer);
548 /*** WineD3D link ***/
549 IWineD3DVertexBuffer *wineD3DVertexBuffer;
551 /*** Storage for D3D7 specific things ***/
556 const IDirect3DVertexBuffer7Vtbl IDirect3DVertexBuffer7_Vtbl;
557 const IDirect3DVertexBufferVtbl IDirect3DVertexBuffer1_Vtbl;
559 /*****************************************************************************
560 * Helper functions from utils.c
561 *****************************************************************************/
563 #define GET_TEXCOUNT_FROM_FVF(d3dvtVertexType) \
564 (((d3dvtVertexType) & D3DFVF_TEXCOUNT_MASK) >> D3DFVF_TEXCOUNT_SHIFT)
566 #define GET_TEXCOORD_SIZE_FROM_FVF(d3dvtVertexType, tex_num) \
567 (((((d3dvtVertexType) >> (16 + (2 * (tex_num)))) + 1) & 0x03) + 1)
569 void PixelFormat_WineD3DtoDD(DDPIXELFORMAT *DDPixelFormat, WINED3DFORMAT WineD3DFormat);
570 WINED3DFORMAT PixelFormat_DD2WineD3D(DDPIXELFORMAT *DDPixelFormat);
571 void DDRAW_dump_surface_desc(const DDSURFACEDESC2 *lpddsd);
572 void DDRAW_dump_pixelformat(const DDPIXELFORMAT *PixelFormat);
573 void dump_D3DMATRIX(D3DMATRIX *mat);
574 void DDRAW_dump_DDCAPS(const DDCAPS *lpcaps);
575 DWORD get_flexible_vertex_size(DWORD d3dvtVertexType);
576 void DDRAW_dump_DDSCAPS2(const DDSCAPS2 *in);
577 void DDRAW_dump_cooperativelevel(DWORD cooplevel);
579 /* This only needs to be here as long the processvertices functionality of
580 * IDirect3DExecuteBuffer isn't in WineD3D */
581 void multiply_matrix(LPD3DMATRIX dest, LPD3DMATRIX src1, LPD3DMATRIX src2);
583 /* Used for generic dumping */
590 #define FE(x) { x, #x }
596 void (*func)(const void *);
601 #define DDRAW_dump_flags(flags,names,num_names) DDRAW_dump_flags_(flags, names, num_names, 1)
602 #define ME(x,f,e) { x, #x, (void (*)(const void *))(f), offsetof(STRUCT, e) }
604 #define DD_STRUCT_COPY_BYSIZE(to,from) \
606 DWORD __size = (to)->dwSize; \
607 DWORD __copysize = __size; \
608 DWORD __resetsize = __size; \
609 assert(to != from); \
610 if (__resetsize > sizeof(*to)) \
611 __resetsize = sizeof(*to); \
612 memset(to,0,__resetsize); \
613 if ((from)->dwSize < __size) \
614 __copysize = (from)->dwSize; \
615 memcpy(to,from,__copysize); \
616 (to)->dwSize = __size;/*restore size*/ \
622 HRESULT hr_ddraw_from_wined3d(HRESULT hr);