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
;
132 IDirectDrawSurfaceImpl
*d3d_target
;
134 IDirect3DDeviceImpl
*d3ddevice
;
142 /* The surface type to request */
143 WINED3DSURFTYPE ImplType
;
146 /* Our private window class */
150 /* Helpers for surface creation */
151 IDirectDrawSurfaceImpl
*tex_root
;
154 /* For the dll unload cleanup code */
155 struct list ddraw_list_entry
;
156 /* The surface list - can't relay this to WineD3D
159 struct list surface_list
;
163 struct FvfToDecl
*decls
;
164 UINT numConvertedDecls
, declArraySize
;
167 /* Declare the VTables. They can be found ddraw.c */
168 const IDirectDraw7Vtbl IDirectDraw7_Vtbl
;
169 const IDirectDraw4Vtbl IDirectDraw4_Vtbl
;
170 const IDirectDraw3Vtbl IDirectDraw3_Vtbl
;
171 const IDirectDraw2Vtbl IDirectDraw2_Vtbl
;
172 const IDirectDrawVtbl IDirectDraw1_Vtbl
;
174 /* Helper structures */
175 typedef struct EnumDisplayModesCBS
178 LPDDENUMMODESCALLBACK2 callback
;
179 } EnumDisplayModesCBS
;
181 typedef struct EnumSurfacesCBS
184 LPDDENUMSURFACESCALLBACK7 callback
;
185 LPDDSURFACEDESC2 pDDSD
;
189 /* Utility functions */
191 DDRAW_Convert_DDSCAPS_1_To_2(const DDSCAPS
* pIn
,
194 DDRAW_Convert_DDDEVICEIDENTIFIER_2_To_1(const DDDEVICEIDENTIFIER2
* pIn
,
195 DDDEVICEIDENTIFIER
* pOut
);
197 IDirectDrawImpl_Destroy(IDirectDrawImpl
*This
);
200 IDirectDrawImpl_RecreateSurfacesCallback(IDirectDrawSurface7
*surf
,
201 DDSURFACEDESC2
*desc
,
203 IWineD3DVertexDeclaration
*
204 IDirectDrawImpl_FindDecl(IDirectDrawImpl
*This
,
207 /* The default surface type */
208 extern WINED3DSURFTYPE DefaultSurfaceType
;
210 /*****************************************************************************
211 * IDirectDrawSurface implementation structure
212 *****************************************************************************/
214 struct IDirectDrawSurfaceImpl
216 /* IUnknown fields */
217 ICOM_VFIELD_MULTI(IDirectDrawSurface7
);
218 ICOM_VFIELD_MULTI(IDirectDrawSurface3
);
219 ICOM_VFIELD_MULTI(IDirectDrawGammaControl
);
220 ICOM_VFIELD_MULTI(IDirect3DTexture2
);
221 ICOM_VFIELD_MULTI(IDirect3DTexture
);
224 IUnknown
*ifaceToRelease
;
228 /* Connections to other Objects */
229 IDirectDrawImpl
*ddraw
;
230 IWineD3DSurface
*WineD3DSurface
;
231 IWineD3DBaseTexture
*wineD3DTexture
;
232 IWineD3DSwapChain
*wineD3DSwapChain
;
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
;
339 /* Required to keep track which of two available texture blending modes in d3ddevice3 is used */
340 BOOL legacyTextureBlending
;
345 /* Rendering functions to wrap D3D(1-3) to D3D7 */
346 D3DPRIMITIVETYPE primitive_type
;
350 LPBYTE vertex_buffer
;
354 /* Handle management */
355 struct HandleEntry
*Handles
;
357 D3DMATRIXHANDLE world
, proj
, view
;
360 /* Vtables in various versions */
361 const IDirect3DDevice7Vtbl IDirect3DDevice7_FPUSetup_Vtbl
;
362 const IDirect3DDevice7Vtbl IDirect3DDevice7_FPUPreserve_Vtbl
;
363 const IDirect3DDevice3Vtbl IDirect3DDevice3_Vtbl
;
364 const IDirect3DDevice2Vtbl IDirect3DDevice2_Vtbl
;
365 const IDirect3DDeviceVtbl IDirect3DDevice1_Vtbl
;
368 const GUID IID_D3DDEVICE_WineD3D
;
370 /* Helper functions */
371 HRESULT
IDirect3DImpl_GetCaps(IWineD3D
*WineD3D
, D3DDEVICEDESC
*Desc123
, D3DDEVICEDESC7
*Desc7
);
372 DWORD
IDirect3DDeviceImpl_CreateHandle(IDirect3DDeviceImpl
*This
);
373 WINED3DZBUFFERTYPE
IDirect3DDeviceImpl_UpdateDepthStencil(IDirect3DDeviceImpl
*This
);
376 struct EnumTextureFormatsCBS
378 LPD3DENUMTEXTUREFORMATSCALLBACK cbv2
;
379 LPD3DENUMPIXELFORMATSCALLBACK cbv7
;
383 /*****************************************************************************
384 * IDirect3D implementation
385 *****************************************************************************/
387 /* No implementation structure as this is only another interface to DirectDraw */
390 const IDirect3DVtbl IDirect3D1_Vtbl
;
391 const IDirect3D2Vtbl IDirect3D2_Vtbl
;
392 const IDirect3D3Vtbl IDirect3D3_Vtbl
;
393 const IDirect3D7Vtbl IDirect3D7_Vtbl
;
395 /* Structure for EnumZBufferFormats */
396 struct EnumZBufferFormatsData
398 LPD3DENUMPIXELFORMATSCALLBACK Callback
;
402 /*****************************************************************************
403 * IDirectDrawClipper implementation structure
404 *****************************************************************************/
405 struct IDirectDrawClipperImpl
407 /* IUnknown fields */
408 ICOM_VFIELD_MULTI(IDirectDrawClipper
);
411 IWineD3DClipper
*wineD3DClipper
;
412 IDirectDrawImpl
*ddraw_owner
;
415 const IDirectDrawClipperVtbl IDirectDrawClipper_Vtbl
;
417 typedef IWineD3DClipper
* (WINAPI
*fnWineDirect3DCreateClipper
)(IUnknown
*);
418 fnWineDirect3DCreateClipper pWineDirect3DCreateClipper
;
420 /*****************************************************************************
421 * IDirectDrawPalette implementation structure
422 *****************************************************************************/
423 struct IDirectDrawPaletteImpl
425 /* IUnknown fields */
426 ICOM_VFIELD_MULTI(IDirectDrawPalette
);
430 IWineD3DPalette
*wineD3DPalette
;
432 /* IDirectDrawPalette fields */
433 IDirectDrawImpl
*ddraw_owner
;
434 IUnknown
*ifaceToRelease
;
436 const IDirectDrawPaletteVtbl IDirectDrawPalette_Vtbl
;
438 /******************************************************************************
439 * DirectDraw ClassFactory implementation - incomplete
440 ******************************************************************************/
443 ICOM_VFIELD_MULTI(IClassFactory
);
446 HRESULT (*pfnCreateInstance
)(IUnknown
*pUnkOuter
, REFIID iid
, LPVOID
*ppObj
);
449 /* Helper structures */
450 struct object_creation_info
453 HRESULT (*pfnCreateInstance
)(IUnknown
*pUnkOuter
, REFIID riid
,
457 /******************************************************************************
458 * IDirect3DLight implementation structure - Wraps to D3D7
459 ******************************************************************************/
460 struct IDirect3DLightImpl
462 ICOM_VFIELD_MULTI(IDirect3DLight
);
465 /* IDirect3DLight fields */
466 IDirectDrawImpl
*ddraw
;
468 /* If this light is active for one viewport, put the viewport here */
469 IDirect3DViewportImpl
*active_viewport
;
476 /* Chained list used for adding / removing from viewports */
477 IDirect3DLightImpl
*next
;
479 /* Activation function */
480 void (*activate
)(IDirect3DLightImpl
*);
481 void (*desactivate
)(IDirect3DLightImpl
*);
482 void (*update
)(IDirect3DLightImpl
*);
486 const IDirect3DLightVtbl IDirect3DLight_Vtbl
;
488 /* Helper functions */
489 void light_update(IDirect3DLightImpl
* This
);
490 void light_activate(IDirect3DLightImpl
* This
);
491 void light_desactivate(IDirect3DLightImpl
* This
);
493 /******************************************************************************
494 * IDirect3DMaterial implementation structure - Wraps to D3D7
495 ******************************************************************************/
496 struct IDirect3DMaterialImpl
498 ICOM_VFIELD_MULTI(IDirect3DMaterial3
);
499 ICOM_VFIELD_MULTI(IDirect3DMaterial2
);
500 ICOM_VFIELD_MULTI(IDirect3DMaterial
);
503 /* IDirect3DMaterial2 fields */
504 IDirectDrawImpl
*ddraw
;
505 IDirect3DDeviceImpl
*active_device
;
510 void (*activate
)(IDirect3DMaterialImpl
* this);
513 /* VTables in various versions */
514 const IDirect3DMaterialVtbl IDirect3DMaterial_Vtbl
;
515 const IDirect3DMaterial2Vtbl IDirect3DMaterial2_Vtbl
;
516 const IDirect3DMaterial3Vtbl IDirect3DMaterial3_Vtbl
;
518 /* Helper functions */
519 void material_activate(IDirect3DMaterialImpl
* This
);
521 /*****************************************************************************
522 * IDirect3DViewport - Wraps to D3D7
523 *****************************************************************************/
524 struct IDirect3DViewportImpl
526 ICOM_VFIELD_MULTI(IDirect3DViewport3
);
529 /* IDirect3DViewport fields */
530 IDirectDrawImpl
*ddraw
;
532 /* If this viewport is active for one device, put the device here */
533 IDirect3DDeviceImpl
*active_device
;
546 /* Activation function */
547 void (*activate
)(IDirect3DViewportImpl
*, BOOL
);
549 /* Field used to chain viewports together */
550 IDirect3DViewportImpl
*next
;
553 IDirect3DLightImpl
*lights
;
555 /* Background material */
556 IDirect3DMaterialImpl
*background
;
560 const IDirect3DViewport3Vtbl IDirect3DViewport3_Vtbl
;
562 /* Helper functions */
563 void viewport_activate(IDirect3DViewportImpl
* This
, BOOL ignore_lights
);
565 /*****************************************************************************
566 * IDirect3DExecuteBuffer - Wraps to D3D7
567 *****************************************************************************/
568 struct IDirect3DExecuteBufferImpl
571 ICOM_VFIELD_MULTI(IDirect3DExecuteBuffer
);
574 /* IDirect3DExecuteBuffer fields */
575 IDirectDrawImpl
*ddraw
;
576 IDirect3DDeviceImpl
*d3ddev
;
578 D3DEXECUTEBUFFERDESC desc
;
581 /* This buffer will store the transformed vertices */
586 /* This flags is set to TRUE if we allocated ourselves the
593 const IDirect3DExecuteBufferVtbl IDirect3DExecuteBuffer_Vtbl
;
595 /* The execute function */
597 IDirect3DExecuteBufferImpl_Execute(IDirect3DExecuteBufferImpl
*This
,
598 IDirect3DDeviceImpl
*Device
,
599 IDirect3DViewportImpl
*ViewportImpl
);
601 /*****************************************************************************
602 * IDirect3DVertexBuffer
603 *****************************************************************************/
604 struct IDirect3DVertexBufferImpl
606 /*** IUnknown Methods ***/
607 ICOM_VFIELD_MULTI(IDirect3DVertexBuffer7
);
608 ICOM_VFIELD_MULTI(IDirect3DVertexBuffer
);
611 /*** WineD3D and ddraw links ***/
612 IWineD3DVertexBuffer
*wineD3DVertexBuffer
;
613 IWineD3DVertexDeclaration
*wineD3DVertexDeclaration
;
614 IDirectDrawImpl
*ddraw
;
616 /*** Storage for D3D7 specific things ***/
621 const IDirect3DVertexBuffer7Vtbl IDirect3DVertexBuffer7_Vtbl
;
622 const IDirect3DVertexBufferVtbl IDirect3DVertexBuffer1_Vtbl
;
624 /*****************************************************************************
625 * Helper functions from utils.c
626 *****************************************************************************/
628 #define GET_TEXCOUNT_FROM_FVF(d3dvtVertexType) \
629 (((d3dvtVertexType) & D3DFVF_TEXCOUNT_MASK) >> D3DFVF_TEXCOUNT_SHIFT)
631 #define GET_TEXCOORD_SIZE_FROM_FVF(d3dvtVertexType, tex_num) \
632 (((((d3dvtVertexType) >> (16 + (2 * (tex_num)))) + 1) & 0x03) + 1)
634 void PixelFormat_WineD3DtoDD(DDPIXELFORMAT
*DDPixelFormat
, WINED3DFORMAT WineD3DFormat
);
635 WINED3DFORMAT
PixelFormat_DD2WineD3D(const DDPIXELFORMAT
*DDPixelFormat
);
636 void DDRAW_dump_surface_desc(const DDSURFACEDESC2
*lpddsd
);
637 void DDRAW_dump_pixelformat(const DDPIXELFORMAT
*PixelFormat
);
638 void dump_D3DMATRIX(const D3DMATRIX
*mat
);
639 void DDRAW_dump_DDCAPS(const DDCAPS
*lpcaps
);
640 DWORD
get_flexible_vertex_size(DWORD d3dvtVertexType
);
641 void DDRAW_dump_DDSCAPS2(const DDSCAPS2
*in
);
642 void DDRAW_dump_cooperativelevel(DWORD cooplevel
);
644 /* This only needs to be here as long the processvertices functionality of
645 * IDirect3DExecuteBuffer isn't in WineD3D */
646 void multiply_matrix(LPD3DMATRIX dest
, const D3DMATRIX
*src1
, const D3DMATRIX
*src2
);
648 /* Helper function in main.c */
649 BOOL
LoadWineD3D(void);
651 /* Used for generic dumping */
658 #define FE(x) { x, #x }
664 void (*func
)(const void *);
669 #define ME(x,f,e) { x, #x, (void (*)(const void *))(f), offsetof(STRUCT, e) }
671 #define DD_STRUCT_COPY_BYSIZE(to,from) \
673 DWORD __size = (to)->dwSize; \
674 DWORD __copysize = __size; \
675 DWORD __resetsize = __size; \
676 assert(to != from); \
677 if (__resetsize > sizeof(*to)) \
678 __resetsize = sizeof(*to); \
679 memset(to,0,__resetsize); \
680 if ((from)->dwSize < __size) \
681 __copysize = (from)->dwSize; \
682 memcpy(to,from,__copysize); \
683 (to)->dwSize = __size;/*restore size*/ \
689 HRESULT
hr_ddraw_from_wined3d(HRESULT hr
);