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
24 #define NONAMELESSSTRUCT
25 #define NONAMELESSUNION
26 #include "wine/debug.h"
34 #ifdef DDRAW_INIT_GUID
37 #include "wine/list.h"
38 #include "wine/wined3d.h"
40 extern const struct wined3d_parent_ops ddraw_null_wined3d_parent_ops DECLSPEC_HIDDEN;
42 /*****************************************************************************
43 * IParent - a helper interface
44 *****************************************************************************/
45 DEFINE_GUID(IID_IParent, 0xc20e4c88, 0x74e7, 0x4940, 0xba, 0x9f, 0x2e, 0x32, 0x3f, 0x9d, 0xc9, 0x81);
46 typedef struct IParent *LPPARENT, *PPARENT;
48 #define INTERFACE IParent
49 DECLARE_INTERFACE_(IParent,IUnknown)
51 /*** IUnknown methods ***/
52 STDMETHOD_(HRESULT,QueryInterface)(THIS_ REFIID riid, void** ppvObject) PURE;
53 STDMETHOD_(ULONG,AddRef)(THIS) PURE;
54 STDMETHOD_(ULONG,Release)(THIS) PURE;
58 #if !defined(__cplusplus) || defined(CINTERFACE)
59 /*** IUnknown methods ***/
60 #define IParent_QueryInterface(p,a,b) (p)->lpVtbl->QueryInterface(p,a,b)
61 #define IParent_AddRef(p) (p)->lpVtbl->AddRef(p)
62 #define IParent_Release(p) (p)->lpVtbl->Release(p)
66 /* Typdef the interfaces */
67 typedef struct IDirectDrawImpl IDirectDrawImpl;
68 typedef struct IDirectDrawSurfaceImpl IDirectDrawSurfaceImpl;
69 typedef struct IDirectDrawClipperImpl IDirectDrawClipperImpl;
70 typedef struct IDirectDrawPaletteImpl IDirectDrawPaletteImpl;
71 typedef struct IDirect3DDeviceImpl IDirect3DDeviceImpl;
72 typedef struct IDirect3DLightImpl IDirect3DLightImpl;
73 typedef struct IDirect3DViewportImpl IDirect3DViewportImpl;
74 typedef struct IDirect3DMaterialImpl IDirect3DMaterialImpl;
75 typedef struct IDirect3DExecuteBufferImpl IDirect3DExecuteBufferImpl;
76 typedef struct IDirect3DVertexBufferImpl IDirect3DVertexBufferImpl;
77 typedef struct IParentImpl IParentImpl;
79 /* Callbacks for implicit object destruction */
80 extern ULONG WINAPI D3D7CB_DestroySwapChain(IWineD3DSwapChain *pSwapChain) DECLSPEC_HIDDEN;
82 /* Global critical section */
83 extern CRITICAL_SECTION ddraw_cs DECLSPEC_HIDDEN;
85 extern DWORD force_refresh_rate DECLSPEC_HIDDEN;
87 /*****************************************************************************
88 * IDirectDraw implementation structure
89 *****************************************************************************/
93 struct wined3d_vertex_declaration *decl;
96 struct IDirectDrawImpl
99 IDirectDraw7 IDirectDraw7_iface;
100 IDirectDraw4 IDirectDraw4_iface;
101 IDirectDraw3 IDirectDraw3_iface;
102 IDirectDraw2 IDirectDraw2_iface;
103 IDirectDraw IDirectDraw_iface;
104 IDirect3D7 IDirect3D7_iface;
105 IDirect3D3 IDirect3D3_iface;
106 IDirect3D2 IDirect3D2_iface;
107 IDirect3D IDirect3D_iface;
108 const IWineD3DDeviceParentVtbl *device_parent_vtbl;
110 /* See comment in IDirectDraw::AddRef */
111 LONG ref7, ref4, ref2, ref3, ref1, numIfaces;
113 /* WineD3D linkage */
114 struct wined3d *wineD3D;
115 IWineD3DDevice *wineD3DDevice;
116 BOOL d3d_initialized;
118 /* Misc ddraw fields */
124 /* DirectDraw things, which are not handled by WineD3D */
125 DWORD cooperative_level;
127 DWORD orig_width, orig_height;
131 IDirectDrawSurfaceImpl *d3d_target;
133 IDirect3DDeviceImpl *d3ddevice;
141 /* The surface type to request */
142 WINED3DSURFTYPE ImplType;
144 /* Helpers for surface creation */
145 IDirectDrawSurfaceImpl *tex_root;
148 /* For the dll unload cleanup code */
149 struct list ddraw_list_entry;
150 /* The surface list - can't relay this to WineD3D
153 struct list surface_list;
157 struct FvfToDecl *decls;
158 UINT numConvertedDecls, declArraySize;
161 #define DDRAW_WINDOW_CLASS_NAME "ddraw_wc"
163 HRESULT ddraw_init(IDirectDrawImpl *ddraw, WINED3DDEVTYPE device_type) DECLSPEC_HIDDEN;
165 /* Helper structures */
166 typedef struct EnumDisplayModesCBS
169 LPDDENUMMODESCALLBACK2 callback;
170 } EnumDisplayModesCBS;
172 typedef struct EnumSurfacesCBS
175 LPDDENUMSURFACESCALLBACK7 callback;
176 LPDDSURFACEDESC2 pDDSD;
180 /* Utility functions */
181 void DDRAW_Convert_DDSCAPS_1_To_2(const DDSCAPS *pIn, DDSCAPS2 *pOut) DECLSPEC_HIDDEN;
182 void DDRAW_Convert_DDDEVICEIDENTIFIER_2_To_1(const DDDEVICEIDENTIFIER2 *pIn, DDDEVICEIDENTIFIER *pOut) DECLSPEC_HIDDEN;
183 HRESULT WINAPI ddraw_recreate_surfaces_cb(IDirectDrawSurface7 *surf,
184 DDSURFACEDESC2 *desc, void *Context) DECLSPEC_HIDDEN;
185 struct wined3d_vertex_declaration *ddraw_find_decl(IDirectDrawImpl *This, DWORD fvf) DECLSPEC_HIDDEN;
187 /* The default surface type */
188 extern WINED3DSURFTYPE DefaultSurfaceType DECLSPEC_HIDDEN;
190 /*****************************************************************************
191 * IDirectDrawSurface implementation structure
192 *****************************************************************************/
194 struct IDirectDrawSurfaceImpl
196 /* IUnknown fields */
197 const IDirectDrawSurface7Vtbl *lpVtbl;
198 const IDirectDrawSurface3Vtbl *IDirectDrawSurface3_vtbl;
199 const IDirectDrawGammaControlVtbl *IDirectDrawGammaControl_vtbl;
200 const IDirect3DTexture2Vtbl *IDirect3DTexture2_vtbl;
201 const IDirect3DTextureVtbl *IDirect3DTexture_vtbl;
204 IUnknown *ifaceToRelease;
208 /* Connections to other Objects */
209 IDirectDrawImpl *ddraw;
210 IWineD3DSurface *WineD3DSurface;
211 IWineD3DBaseTexture *wineD3DTexture;
212 IWineD3DSwapChain *wineD3DSwapChain;
214 /* This implementation handles attaching surfaces to other surfaces */
215 IDirectDrawSurfaceImpl *next_attached;
216 IDirectDrawSurfaceImpl *first_attached;
218 /* Complex surfaces are organized in a tree, although the tree is degenerated to a list in most cases.
219 * In mipmap and primary surfaces each level has only one attachment, which is the next surface level.
220 * Only the cube texture root has 6 surfaces attached, which then have a normal mipmap chain attached
221 * to them. So hardcode the array to 6, a dynamic array or a list would be an overkill.
223 #define MAX_COMPLEX_ATTACHED 6
224 IDirectDrawSurfaceImpl *complex_array[MAX_COMPLEX_ATTACHED];
225 /* You can't traverse the tree upwards. Only a flag for Surface::Release because its needed there,
226 * but no pointer to prevent temptations to traverse it in the wrong direction.
228 BOOL is_complex_root;
230 /* Surface description, for GetAttachedSurface */
231 DDSURFACEDESC2 surface_desc;
234 DWORD uniqueness_value;
236 WINED3DSURFTYPE ImplType;
238 /* For D3DDevice creation */
241 /* Clipper objects */
242 IDirectDrawClipperImpl *clipper;
244 /* For the ddraw surface list */
245 struct list surface_list_entry;
250 void ddraw_surface_destroy(IDirectDrawSurfaceImpl *surface) DECLSPEC_HIDDEN;
251 HRESULT ddraw_surface_init(IDirectDrawSurfaceImpl *surface, IDirectDrawImpl *ddraw,
252 DDSURFACEDESC2 *desc, UINT mip_level, WINED3DSURFTYPE surface_type) DECLSPEC_HIDDEN;
254 static inline IDirectDrawSurfaceImpl *surface_from_texture1(IDirect3DTexture *iface)
256 return (IDirectDrawSurfaceImpl *)((char*)iface - FIELD_OFFSET(IDirectDrawSurfaceImpl, IDirect3DTexture_vtbl));
259 static inline IDirectDrawSurfaceImpl *surface_from_texture2(IDirect3DTexture2 *iface)
261 return (IDirectDrawSurfaceImpl *)((char*)iface - FIELD_OFFSET(IDirectDrawSurfaceImpl, IDirect3DTexture2_vtbl));
264 static inline IDirectDrawSurfaceImpl *surface_from_surface3(IDirectDrawSurface3 *iface)
266 return (IDirectDrawSurfaceImpl *)((char*)iface - FIELD_OFFSET(IDirectDrawSurfaceImpl, IDirectDrawSurface3_vtbl));
269 /* Get the number of bytes per pixel for a given surface */
270 #define PFGET_BPP(pf) (pf.dwFlags&DDPF_PALETTEINDEXED8?1:((pf.dwRGBBitCount+7)/8))
271 #define GET_BPP(desc) PFGET_BPP(desc.ddpfPixelFormat)
273 /*****************************************************************************
274 * IParent Implementation
275 *****************************************************************************/
278 /* IUnknown fields */
279 const IParentVtbl *lpVtbl;
282 /* IParentImpl fields */
287 void ddraw_parent_init(IParentImpl *parent) DECLSPEC_HIDDEN;
289 /*****************************************************************************
290 * IDirect3DDevice implementation
291 *****************************************************************************/
293 #define DDRAW_INVALID_HANDLE ~0U
295 enum ddraw_handle_type
298 DDRAW_HANDLE_MATERIAL,
300 DDRAW_HANDLE_STATEBLOCK,
301 DDRAW_HANDLE_SURFACE,
304 struct ddraw_handle_entry
307 enum ddraw_handle_type type;
310 struct ddraw_handle_table
312 struct ddraw_handle_entry *entries;
313 struct ddraw_handle_entry *free_entries;
318 BOOL ddraw_handle_table_init(struct ddraw_handle_table *t, UINT initial_size) DECLSPEC_HIDDEN;
319 void ddraw_handle_table_destroy(struct ddraw_handle_table *t) DECLSPEC_HIDDEN;
320 DWORD ddraw_allocate_handle(struct ddraw_handle_table *t, void *object, enum ddraw_handle_type type) DECLSPEC_HIDDEN;
321 void *ddraw_free_handle(struct ddraw_handle_table *t, DWORD handle, enum ddraw_handle_type type) DECLSPEC_HIDDEN;
322 void *ddraw_get_object(struct ddraw_handle_table *t, DWORD handle, enum ddraw_handle_type type) DECLSPEC_HIDDEN;
324 struct IDirect3DDeviceImpl
327 const IDirect3DDevice7Vtbl *lpVtbl;
328 const IDirect3DDevice3Vtbl *IDirect3DDevice3_vtbl;
329 const IDirect3DDevice2Vtbl *IDirect3DDevice2_vtbl;
330 const IDirect3DDeviceVtbl *IDirect3DDevice_vtbl;
333 /* Other object connections */
334 IWineD3DDevice *wineD3DDevice;
335 IDirectDrawImpl *ddraw;
336 IWineD3DBuffer *indexbuffer;
337 IDirectDrawSurfaceImpl *target;
339 /* Viewport management */
340 IDirect3DViewportImpl *viewport_list;
341 IDirect3DViewportImpl *current_viewport;
342 D3DVIEWPORT7 active_viewport;
344 /* Required to keep track which of two available texture blending modes in d3ddevice3 is used */
345 BOOL legacyTextureBlending;
350 /* Rendering functions to wrap D3D(1-3) to D3D7 */
351 D3DPRIMITIVETYPE primitive_type;
355 LPBYTE vertex_buffer;
359 /* Handle management */
360 struct ddraw_handle_table handle_table;
361 D3DMATRIXHANDLE world, proj, view;
364 HRESULT d3d_device_init(IDirect3DDeviceImpl *device, IDirectDrawImpl *ddraw,
365 IDirectDrawSurfaceImpl *target) DECLSPEC_HIDDEN;
368 extern const GUID IID_D3DDEVICE_WineD3D DECLSPEC_HIDDEN;
370 /* Helper functions */
371 HRESULT IDirect3DImpl_GetCaps(const struct wined3d *wined3d,
372 D3DDEVICEDESC *Desc123, D3DDEVICEDESC7 *Desc7) DECLSPEC_HIDDEN;
373 WINED3DZBUFFERTYPE IDirect3DDeviceImpl_UpdateDepthStencil(IDirect3DDeviceImpl *This) DECLSPEC_HIDDEN;
375 static inline IDirect3DDeviceImpl *device_from_device1(IDirect3DDevice *iface)
377 return (IDirect3DDeviceImpl *)((char*)iface - FIELD_OFFSET(IDirect3DDeviceImpl, IDirect3DDevice_vtbl));
380 static inline IDirect3DDeviceImpl *device_from_device2(IDirect3DDevice2 *iface)
382 return (IDirect3DDeviceImpl *)((char*)iface - FIELD_OFFSET(IDirect3DDeviceImpl, IDirect3DDevice2_vtbl));
385 static inline IDirect3DDeviceImpl *device_from_device3(IDirect3DDevice3 *iface)
387 return (IDirect3DDeviceImpl *)((char*)iface - FIELD_OFFSET(IDirect3DDeviceImpl, IDirect3DDevice3_vtbl));
391 struct EnumTextureFormatsCBS
393 LPD3DENUMTEXTUREFORMATSCALLBACK cbv2;
394 LPD3DENUMPIXELFORMATSCALLBACK cbv7;
398 /* Structure for EnumZBufferFormats */
399 struct EnumZBufferFormatsData
401 LPD3DENUMPIXELFORMATSCALLBACK Callback;
405 /*****************************************************************************
406 * IDirectDrawClipper implementation structure
407 *****************************************************************************/
408 struct IDirectDrawClipperImpl
410 /* IUnknown fields */
411 const IDirectDrawClipperVtbl *lpVtbl;
414 struct wined3d_clipper *wineD3DClipper;
418 HRESULT ddraw_clipper_init(IDirectDrawClipperImpl *clipper) DECLSPEC_HIDDEN;
420 /*****************************************************************************
421 * IDirectDrawPalette implementation structure
422 *****************************************************************************/
423 struct IDirectDrawPaletteImpl
425 /* IUnknown fields */
426 const IDirectDrawPaletteVtbl *lpVtbl;
429 struct wined3d_palette *wineD3DPalette;
431 /* IDirectDrawPalette fields */
432 IUnknown *ifaceToRelease;
435 HRESULT ddraw_palette_init(IDirectDrawPaletteImpl *palette,
436 IDirectDrawImpl *ddraw, DWORD flags, PALETTEENTRY *entries) DECLSPEC_HIDDEN;
438 /* Helper structures */
439 struct object_creation_info
442 HRESULT (*pfnCreateInstance)(IUnknown *pUnkOuter, REFIID riid,
446 /******************************************************************************
447 * IDirect3DLight implementation structure - Wraps to D3D7
448 ******************************************************************************/
449 struct IDirect3DLightImpl
451 const IDirect3DLightVtbl *lpVtbl;
454 /* IDirect3DLight fields */
455 IDirectDrawImpl *ddraw;
457 /* If this light is active for one viewport, put the viewport here */
458 IDirect3DViewportImpl *active_viewport;
465 /* Chained list used for adding / removing from viewports */
466 IDirect3DLightImpl *next;
469 /* Helper functions */
470 void light_activate(IDirect3DLightImpl *light) DECLSPEC_HIDDEN;
471 void light_deactivate(IDirect3DLightImpl *light) DECLSPEC_HIDDEN;
472 void d3d_light_init(IDirect3DLightImpl *light, IDirectDrawImpl *ddraw) DECLSPEC_HIDDEN;
474 /******************************************************************************
475 * IDirect3DMaterial implementation structure - Wraps to D3D7
476 ******************************************************************************/
477 struct IDirect3DMaterialImpl
479 const IDirect3DMaterial3Vtbl *lpVtbl;
480 const IDirect3DMaterial2Vtbl *IDirect3DMaterial2_vtbl;
481 const IDirect3DMaterialVtbl *IDirect3DMaterial_vtbl;
484 /* IDirect3DMaterial2 fields */
485 IDirectDrawImpl *ddraw;
486 IDirect3DDeviceImpl *active_device;
492 /* Helper functions */
493 void material_activate(IDirect3DMaterialImpl* This) DECLSPEC_HIDDEN;
494 void d3d_material_init(IDirect3DMaterialImpl *material, IDirectDrawImpl *ddraw) DECLSPEC_HIDDEN;
496 /*****************************************************************************
497 * IDirect3DViewport - Wraps to D3D7
498 *****************************************************************************/
499 struct IDirect3DViewportImpl
501 const IDirect3DViewport3Vtbl *lpVtbl;
504 /* IDirect3DViewport fields */
505 IDirectDrawImpl *ddraw;
507 /* If this viewport is active for one device, put the device here */
508 IDirect3DDeviceImpl *active_device;
521 /* Field used to chain viewports together */
522 IDirect3DViewportImpl *next;
525 IDirect3DLightImpl *lights;
527 /* Background material */
528 IDirect3DMaterialImpl *background;
531 /* Helper functions */
532 void viewport_activate(IDirect3DViewportImpl* This, BOOL ignore_lights) DECLSPEC_HIDDEN;
533 void d3d_viewport_init(IDirect3DViewportImpl *viewport, IDirectDrawImpl *ddraw) DECLSPEC_HIDDEN;
535 /*****************************************************************************
536 * IDirect3DExecuteBuffer - Wraps to D3D7
537 *****************************************************************************/
538 struct IDirect3DExecuteBufferImpl
541 const IDirect3DExecuteBufferVtbl *lpVtbl;
544 /* IDirect3DExecuteBuffer fields */
545 IDirectDrawImpl *ddraw;
546 IDirect3DDeviceImpl *d3ddev;
548 D3DEXECUTEBUFFERDESC desc;
551 /* This buffer will store the transformed vertices */
556 /* This flags is set to TRUE if we allocated ourselves the
562 HRESULT d3d_execute_buffer_init(IDirect3DExecuteBufferImpl *execute_buffer,
563 IDirect3DDeviceImpl *device, D3DEXECUTEBUFFERDESC *desc) DECLSPEC_HIDDEN;
565 /* The execute function */
566 void IDirect3DExecuteBufferImpl_Execute(IDirect3DExecuteBufferImpl *This,
567 IDirect3DDeviceImpl *Device, IDirect3DViewportImpl *ViewportImpl) DECLSPEC_HIDDEN;
569 /*****************************************************************************
570 * IDirect3DVertexBuffer
571 *****************************************************************************/
572 struct IDirect3DVertexBufferImpl
574 /*** IUnknown Methods ***/
575 const IDirect3DVertexBuffer7Vtbl *lpVtbl;
576 const IDirect3DVertexBufferVtbl *IDirect3DVertexBuffer_vtbl;
579 /*** WineD3D and ddraw links ***/
580 IWineD3DBuffer *wineD3DVertexBuffer;
581 struct wined3d_vertex_declaration *wineD3DVertexDeclaration;
582 IDirectDrawImpl *ddraw;
584 /*** Storage for D3D7 specific things ***/
589 HRESULT d3d_vertex_buffer_init(IDirect3DVertexBufferImpl *buffer,
590 IDirectDrawImpl *ddraw, D3DVERTEXBUFFERDESC *desc) DECLSPEC_HIDDEN;
592 static inline IDirect3DVertexBufferImpl *vb_from_vb1(IDirect3DVertexBuffer *iface)
594 return (IDirect3DVertexBufferImpl *)((char*)iface
595 - FIELD_OFFSET(IDirect3DVertexBufferImpl, IDirect3DVertexBuffer_vtbl));
598 /*****************************************************************************
599 * Helper functions from utils.c
600 *****************************************************************************/
602 #define GET_TEXCOUNT_FROM_FVF(d3dvtVertexType) \
603 (((d3dvtVertexType) & D3DFVF_TEXCOUNT_MASK) >> D3DFVF_TEXCOUNT_SHIFT)
605 #define GET_TEXCOORD_SIZE_FROM_FVF(d3dvtVertexType, tex_num) \
606 (((((d3dvtVertexType) >> (16 + (2 * (tex_num)))) + 1) & 0x03) + 1)
608 void PixelFormat_WineD3DtoDD(DDPIXELFORMAT *DDPixelFormat, enum wined3d_format_id WineD3DFormat) DECLSPEC_HIDDEN;
609 enum wined3d_format_id PixelFormat_DD2WineD3D(const DDPIXELFORMAT *DDPixelFormat) DECLSPEC_HIDDEN;
610 void DDRAW_dump_surface_desc(const DDSURFACEDESC2 *lpddsd) DECLSPEC_HIDDEN;
611 void dump_D3DMATRIX(const D3DMATRIX *mat) DECLSPEC_HIDDEN;
612 void DDRAW_dump_DDCAPS(const DDCAPS *lpcaps) DECLSPEC_HIDDEN;
613 DWORD get_flexible_vertex_size(DWORD d3dvtVertexType) DECLSPEC_HIDDEN;
614 void DDRAW_dump_DDSCAPS2(const DDSCAPS2 *in) DECLSPEC_HIDDEN;
615 void DDRAW_dump_cooperativelevel(DWORD cooplevel) DECLSPEC_HIDDEN;
617 /* This only needs to be here as long the processvertices functionality of
618 * IDirect3DExecuteBuffer isn't in WineD3D */
619 void multiply_matrix(LPD3DMATRIX dest, const D3DMATRIX *src1, const D3DMATRIX *src2) DECLSPEC_HIDDEN;
621 /* Helper function in main.c */
622 BOOL LoadWineD3D(void) DECLSPEC_HIDDEN;
624 /* Used for generic dumping */
631 #define FE(x) { x, #x }
637 void (*func)(const void *);
642 #define ME(x,f,e) { x, #x, (void (*)(const void *))(f), offsetof(STRUCT, e) }
644 #define DD_STRUCT_COPY_BYSIZE(to,from) \
646 DWORD __size = (to)->dwSize; \
647 DWORD __copysize = __size; \
648 DWORD __resetsize = __size; \
649 assert(to != from); \
650 if (__resetsize > sizeof(*to)) \
651 __resetsize = sizeof(*to); \
652 memset(to,0,__resetsize); \
653 if ((from)->dwSize < __size) \
654 __copysize = (from)->dwSize; \
655 memcpy(to,from,__copysize); \
656 (to)->dwSize = __size;/*restore size*/ \
662 HRESULT hr_ddraw_from_wined3d(HRESULT hr) DECLSPEC_HIDDEN;