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 /* Typdef the interfaces */
43 typedef struct IDirectDrawImpl IDirectDrawImpl;
44 typedef struct IDirectDrawSurfaceImpl IDirectDrawSurfaceImpl;
45 typedef struct IDirectDrawClipperImpl IDirectDrawClipperImpl;
46 typedef struct IDirectDrawPaletteImpl IDirectDrawPaletteImpl;
47 typedef struct IDirect3DDeviceImpl IDirect3DDeviceImpl;
48 typedef struct IDirect3DLightImpl IDirect3DLightImpl;
49 typedef struct IDirect3DViewportImpl IDirect3DViewportImpl;
50 typedef struct IDirect3DMaterialImpl IDirect3DMaterialImpl;
51 typedef struct IDirect3DExecuteBufferImpl IDirect3DExecuteBufferImpl;
52 typedef struct IDirect3DVertexBufferImpl IDirect3DVertexBufferImpl;
54 /* Global critical section */
55 extern CRITICAL_SECTION ddraw_cs DECLSPEC_HIDDEN;
57 extern DWORD force_refresh_rate DECLSPEC_HIDDEN;
59 /*****************************************************************************
60 * IDirectDraw implementation structure
61 *****************************************************************************/
65 struct wined3d_vertex_declaration *decl;
68 struct IDirectDrawImpl
71 IDirectDraw7 IDirectDraw7_iface;
72 IDirectDraw4 IDirectDraw4_iface;
73 IDirectDraw3 IDirectDraw3_iface;
74 IDirectDraw2 IDirectDraw2_iface;
75 IDirectDraw IDirectDraw_iface;
76 IDirect3D7 IDirect3D7_iface;
77 IDirect3D3 IDirect3D3_iface;
78 IDirect3D2 IDirect3D2_iface;
79 IDirect3D IDirect3D_iface;
80 const IWineD3DDeviceParentVtbl *device_parent_vtbl;
82 /* See comment in IDirectDraw::AddRef */
83 LONG ref7, ref4, ref2, ref3, ref1, numIfaces;
86 struct wined3d *wineD3D;
87 IWineD3DDevice *wineD3DDevice;
90 /* Misc ddraw fields */
96 /* DirectDraw things, which are not handled by WineD3D */
97 DWORD cooperative_level;
99 DWORD orig_width, orig_height;
103 IDirectDrawSurfaceImpl *d3d_target;
105 IDirect3DDeviceImpl *d3ddevice;
113 /* The surface type to request */
114 WINED3DSURFTYPE ImplType;
116 /* Helpers for surface creation */
117 IDirectDrawSurfaceImpl *tex_root;
120 /* For the dll unload cleanup code */
121 struct list ddraw_list_entry;
122 /* The surface list - can't relay this to WineD3D
125 struct list surface_list;
129 struct FvfToDecl *decls;
130 UINT numConvertedDecls, declArraySize;
133 #define DDRAW_WINDOW_CLASS_NAME "ddraw_wc"
135 HRESULT ddraw_init(IDirectDrawImpl *ddraw, WINED3DDEVTYPE device_type) DECLSPEC_HIDDEN;
137 /* Helper structures */
138 typedef struct EnumDisplayModesCBS
141 LPDDENUMMODESCALLBACK2 callback;
142 } EnumDisplayModesCBS;
144 typedef struct EnumSurfacesCBS
147 LPDDENUMSURFACESCALLBACK7 callback;
148 LPDDSURFACEDESC2 pDDSD;
152 /* Utility functions */
153 void DDRAW_Convert_DDSCAPS_1_To_2(const DDSCAPS *pIn, DDSCAPS2 *pOut) DECLSPEC_HIDDEN;
154 void DDRAW_Convert_DDDEVICEIDENTIFIER_2_To_1(const DDDEVICEIDENTIFIER2 *pIn, DDDEVICEIDENTIFIER *pOut) DECLSPEC_HIDDEN;
155 HRESULT WINAPI ddraw_recreate_surfaces_cb(IDirectDrawSurface7 *surf,
156 DDSURFACEDESC2 *desc, void *Context) DECLSPEC_HIDDEN;
157 struct wined3d_vertex_declaration *ddraw_find_decl(IDirectDrawImpl *This, DWORD fvf) DECLSPEC_HIDDEN;
159 /* The default surface type */
160 extern WINED3DSURFTYPE DefaultSurfaceType DECLSPEC_HIDDEN;
162 /*****************************************************************************
163 * IDirectDrawSurface implementation structure
164 *****************************************************************************/
166 struct IDirectDrawSurfaceImpl
168 /* IUnknown fields */
169 const IDirectDrawSurface7Vtbl *lpVtbl;
170 const IDirectDrawSurface3Vtbl *IDirectDrawSurface3_vtbl;
171 const IDirectDrawGammaControlVtbl *IDirectDrawGammaControl_vtbl;
172 const IDirect3DTexture2Vtbl *IDirect3DTexture2_vtbl;
173 const IDirect3DTextureVtbl *IDirect3DTexture_vtbl;
176 IUnknown *ifaceToRelease;
180 /* Connections to other Objects */
181 IDirectDrawImpl *ddraw;
182 IWineD3DSurface *WineD3DSurface;
183 struct wined3d_texture *wined3d_texture;
184 IWineD3DSwapChain *wineD3DSwapChain;
186 /* This implementation handles attaching surfaces to other surfaces */
187 IDirectDrawSurfaceImpl *next_attached;
188 IDirectDrawSurfaceImpl *first_attached;
190 /* Complex surfaces are organized in a tree, although the tree is degenerated to a list in most cases.
191 * In mipmap and primary surfaces each level has only one attachment, which is the next surface level.
192 * Only the cube texture root has 6 surfaces attached, which then have a normal mipmap chain attached
193 * to them. So hardcode the array to 6, a dynamic array or a list would be an overkill.
195 #define MAX_COMPLEX_ATTACHED 6
196 IDirectDrawSurfaceImpl *complex_array[MAX_COMPLEX_ATTACHED];
197 /* You can't traverse the tree upwards. Only a flag for Surface::Release because its needed there,
198 * but no pointer to prevent temptations to traverse it in the wrong direction.
200 BOOL is_complex_root;
202 /* Surface description, for GetAttachedSurface */
203 DDSURFACEDESC2 surface_desc;
206 DWORD uniqueness_value;
208 WINED3DSURFTYPE ImplType;
210 /* For D3DDevice creation */
213 /* Clipper objects */
214 IDirectDrawClipperImpl *clipper;
216 /* For the ddraw surface list */
217 struct list surface_list_entry;
222 void ddraw_surface_destroy(IDirectDrawSurfaceImpl *surface) DECLSPEC_HIDDEN;
223 HRESULT ddraw_surface_init(IDirectDrawSurfaceImpl *surface, IDirectDrawImpl *ddraw,
224 DDSURFACEDESC2 *desc, UINT mip_level, WINED3DSURFTYPE surface_type) DECLSPEC_HIDDEN;
226 static inline IDirectDrawSurfaceImpl *surface_from_texture1(IDirect3DTexture *iface)
228 return (IDirectDrawSurfaceImpl *)((char*)iface - FIELD_OFFSET(IDirectDrawSurfaceImpl, IDirect3DTexture_vtbl));
231 static inline IDirectDrawSurfaceImpl *surface_from_texture2(IDirect3DTexture2 *iface)
233 return (IDirectDrawSurfaceImpl *)((char*)iface - FIELD_OFFSET(IDirectDrawSurfaceImpl, IDirect3DTexture2_vtbl));
236 static inline IDirectDrawSurfaceImpl *surface_from_surface3(IDirectDrawSurface3 *iface)
238 return (IDirectDrawSurfaceImpl *)((char*)iface - FIELD_OFFSET(IDirectDrawSurfaceImpl, IDirectDrawSurface3_vtbl));
241 /* Get the number of bytes per pixel for a given surface */
242 #define PFGET_BPP(pf) (pf.dwFlags&DDPF_PALETTEINDEXED8?1:((pf.dwRGBBitCount+7)/8))
243 #define GET_BPP(desc) PFGET_BPP(desc.ddpfPixelFormat)
245 #define DDRAW_INVALID_HANDLE ~0U
247 enum ddraw_handle_type
250 DDRAW_HANDLE_MATERIAL,
252 DDRAW_HANDLE_STATEBLOCK,
253 DDRAW_HANDLE_SURFACE,
256 struct ddraw_handle_entry
259 enum ddraw_handle_type type;
262 struct ddraw_handle_table
264 struct ddraw_handle_entry *entries;
265 struct ddraw_handle_entry *free_entries;
270 BOOL ddraw_handle_table_init(struct ddraw_handle_table *t, UINT initial_size) DECLSPEC_HIDDEN;
271 void ddraw_handle_table_destroy(struct ddraw_handle_table *t) DECLSPEC_HIDDEN;
272 DWORD ddraw_allocate_handle(struct ddraw_handle_table *t, void *object, enum ddraw_handle_type type) DECLSPEC_HIDDEN;
273 void *ddraw_free_handle(struct ddraw_handle_table *t, DWORD handle, enum ddraw_handle_type type) DECLSPEC_HIDDEN;
274 void *ddraw_get_object(struct ddraw_handle_table *t, DWORD handle, enum ddraw_handle_type type) DECLSPEC_HIDDEN;
276 struct IDirect3DDeviceImpl
279 const IDirect3DDevice7Vtbl *lpVtbl;
280 const IDirect3DDevice3Vtbl *IDirect3DDevice3_vtbl;
281 const IDirect3DDevice2Vtbl *IDirect3DDevice2_vtbl;
282 const IDirect3DDeviceVtbl *IDirect3DDevice_vtbl;
285 /* Other object connections */
286 IWineD3DDevice *wineD3DDevice;
287 IDirectDrawImpl *ddraw;
288 struct wined3d_buffer *indexbuffer;
289 IDirectDrawSurfaceImpl *target;
291 /* Viewport management */
292 IDirect3DViewportImpl *viewport_list;
293 IDirect3DViewportImpl *current_viewport;
294 D3DVIEWPORT7 active_viewport;
296 /* Required to keep track which of two available texture blending modes in d3ddevice3 is used */
297 BOOL legacyTextureBlending;
302 /* Rendering functions to wrap D3D(1-3) to D3D7 */
303 D3DPRIMITIVETYPE primitive_type;
307 LPBYTE vertex_buffer;
311 /* Handle management */
312 struct ddraw_handle_table handle_table;
313 D3DMATRIXHANDLE world, proj, view;
316 HRESULT d3d_device_init(IDirect3DDeviceImpl *device, IDirectDrawImpl *ddraw,
317 IDirectDrawSurfaceImpl *target) DECLSPEC_HIDDEN;
320 extern const GUID IID_D3DDEVICE_WineD3D DECLSPEC_HIDDEN;
322 /* Helper functions */
323 HRESULT IDirect3DImpl_GetCaps(const struct wined3d *wined3d,
324 D3DDEVICEDESC *Desc123, D3DDEVICEDESC7 *Desc7) DECLSPEC_HIDDEN;
325 WINED3DZBUFFERTYPE IDirect3DDeviceImpl_UpdateDepthStencil(IDirect3DDeviceImpl *This) DECLSPEC_HIDDEN;
327 static inline IDirect3DDeviceImpl *device_from_device1(IDirect3DDevice *iface)
329 return (IDirect3DDeviceImpl *)((char*)iface - FIELD_OFFSET(IDirect3DDeviceImpl, IDirect3DDevice_vtbl));
332 static inline IDirect3DDeviceImpl *device_from_device2(IDirect3DDevice2 *iface)
334 return (IDirect3DDeviceImpl *)((char*)iface - FIELD_OFFSET(IDirect3DDeviceImpl, IDirect3DDevice2_vtbl));
337 static inline IDirect3DDeviceImpl *device_from_device3(IDirect3DDevice3 *iface)
339 return (IDirect3DDeviceImpl *)((char*)iface - FIELD_OFFSET(IDirect3DDeviceImpl, IDirect3DDevice3_vtbl));
343 struct EnumTextureFormatsCBS
345 LPD3DENUMTEXTUREFORMATSCALLBACK cbv2;
346 LPD3DENUMPIXELFORMATSCALLBACK cbv7;
350 /* Structure for EnumZBufferFormats */
351 struct EnumZBufferFormatsData
353 LPD3DENUMPIXELFORMATSCALLBACK Callback;
357 /*****************************************************************************
358 * IDirectDrawClipper implementation structure
359 *****************************************************************************/
360 struct IDirectDrawClipperImpl
362 /* IUnknown fields */
363 const IDirectDrawClipperVtbl *lpVtbl;
366 struct wined3d_clipper *wineD3DClipper;
370 HRESULT ddraw_clipper_init(IDirectDrawClipperImpl *clipper) DECLSPEC_HIDDEN;
372 /*****************************************************************************
373 * IDirectDrawPalette implementation structure
374 *****************************************************************************/
375 struct IDirectDrawPaletteImpl
377 /* IUnknown fields */
378 const IDirectDrawPaletteVtbl *lpVtbl;
381 struct wined3d_palette *wineD3DPalette;
383 /* IDirectDrawPalette fields */
384 IUnknown *ifaceToRelease;
387 HRESULT ddraw_palette_init(IDirectDrawPaletteImpl *palette,
388 IDirectDrawImpl *ddraw, DWORD flags, PALETTEENTRY *entries) DECLSPEC_HIDDEN;
390 /* Helper structures */
391 struct object_creation_info
394 HRESULT (*pfnCreateInstance)(IUnknown *pUnkOuter, REFIID riid,
398 /******************************************************************************
399 * IDirect3DLight implementation structure - Wraps to D3D7
400 ******************************************************************************/
401 struct IDirect3DLightImpl
403 const IDirect3DLightVtbl *lpVtbl;
406 /* IDirect3DLight fields */
407 IDirectDrawImpl *ddraw;
409 /* If this light is active for one viewport, put the viewport here */
410 IDirect3DViewportImpl *active_viewport;
417 /* Chained list used for adding / removing from viewports */
418 IDirect3DLightImpl *next;
421 /* Helper functions */
422 void light_activate(IDirect3DLightImpl *light) DECLSPEC_HIDDEN;
423 void light_deactivate(IDirect3DLightImpl *light) DECLSPEC_HIDDEN;
424 void d3d_light_init(IDirect3DLightImpl *light, IDirectDrawImpl *ddraw) DECLSPEC_HIDDEN;
426 /******************************************************************************
427 * IDirect3DMaterial implementation structure - Wraps to D3D7
428 ******************************************************************************/
429 struct IDirect3DMaterialImpl
431 const IDirect3DMaterial3Vtbl *lpVtbl;
432 const IDirect3DMaterial2Vtbl *IDirect3DMaterial2_vtbl;
433 const IDirect3DMaterialVtbl *IDirect3DMaterial_vtbl;
436 /* IDirect3DMaterial2 fields */
437 IDirectDrawImpl *ddraw;
438 IDirect3DDeviceImpl *active_device;
444 /* Helper functions */
445 void material_activate(IDirect3DMaterialImpl* This) DECLSPEC_HIDDEN;
446 void d3d_material_init(IDirect3DMaterialImpl *material, IDirectDrawImpl *ddraw) DECLSPEC_HIDDEN;
448 /*****************************************************************************
449 * IDirect3DViewport - Wraps to D3D7
450 *****************************************************************************/
451 struct IDirect3DViewportImpl
453 const IDirect3DViewport3Vtbl *lpVtbl;
456 /* IDirect3DViewport fields */
457 IDirectDrawImpl *ddraw;
459 /* If this viewport is active for one device, put the device here */
460 IDirect3DDeviceImpl *active_device;
473 /* Field used to chain viewports together */
474 IDirect3DViewportImpl *next;
477 IDirect3DLightImpl *lights;
479 /* Background material */
480 IDirect3DMaterialImpl *background;
483 /* Helper functions */
484 void viewport_activate(IDirect3DViewportImpl* This, BOOL ignore_lights) DECLSPEC_HIDDEN;
485 void d3d_viewport_init(IDirect3DViewportImpl *viewport, IDirectDrawImpl *ddraw) DECLSPEC_HIDDEN;
487 /*****************************************************************************
488 * IDirect3DExecuteBuffer - Wraps to D3D7
489 *****************************************************************************/
490 struct IDirect3DExecuteBufferImpl
493 const IDirect3DExecuteBufferVtbl *lpVtbl;
496 /* IDirect3DExecuteBuffer fields */
497 IDirectDrawImpl *ddraw;
498 IDirect3DDeviceImpl *d3ddev;
500 D3DEXECUTEBUFFERDESC desc;
503 /* This buffer will store the transformed vertices */
508 /* This flags is set to TRUE if we allocated ourselves the
514 HRESULT d3d_execute_buffer_init(IDirect3DExecuteBufferImpl *execute_buffer,
515 IDirect3DDeviceImpl *device, D3DEXECUTEBUFFERDESC *desc) DECLSPEC_HIDDEN;
517 /* The execute function */
518 void IDirect3DExecuteBufferImpl_Execute(IDirect3DExecuteBufferImpl *This,
519 IDirect3DDeviceImpl *Device, IDirect3DViewportImpl *ViewportImpl) DECLSPEC_HIDDEN;
521 /*****************************************************************************
522 * IDirect3DVertexBuffer
523 *****************************************************************************/
524 struct IDirect3DVertexBufferImpl
526 /*** IUnknown Methods ***/
527 const IDirect3DVertexBuffer7Vtbl *lpVtbl;
528 const IDirect3DVertexBufferVtbl *IDirect3DVertexBuffer_vtbl;
531 /*** WineD3D and ddraw links ***/
532 struct wined3d_buffer *wineD3DVertexBuffer;
533 struct wined3d_vertex_declaration *wineD3DVertexDeclaration;
534 IDirectDrawImpl *ddraw;
536 /*** Storage for D3D7 specific things ***/
541 HRESULT d3d_vertex_buffer_init(IDirect3DVertexBufferImpl *buffer,
542 IDirectDrawImpl *ddraw, D3DVERTEXBUFFERDESC *desc) DECLSPEC_HIDDEN;
544 static inline IDirect3DVertexBufferImpl *vb_from_vb1(IDirect3DVertexBuffer *iface)
546 return (IDirect3DVertexBufferImpl *)((char*)iface
547 - FIELD_OFFSET(IDirect3DVertexBufferImpl, IDirect3DVertexBuffer_vtbl));
550 /*****************************************************************************
551 * Helper functions from utils.c
552 *****************************************************************************/
554 #define GET_TEXCOUNT_FROM_FVF(d3dvtVertexType) \
555 (((d3dvtVertexType) & D3DFVF_TEXCOUNT_MASK) >> D3DFVF_TEXCOUNT_SHIFT)
557 #define GET_TEXCOORD_SIZE_FROM_FVF(d3dvtVertexType, tex_num) \
558 (((((d3dvtVertexType) >> (16 + (2 * (tex_num)))) + 1) & 0x03) + 1)
560 void PixelFormat_WineD3DtoDD(DDPIXELFORMAT *DDPixelFormat, enum wined3d_format_id WineD3DFormat) DECLSPEC_HIDDEN;
561 enum wined3d_format_id PixelFormat_DD2WineD3D(const DDPIXELFORMAT *DDPixelFormat) DECLSPEC_HIDDEN;
562 void DDRAW_dump_surface_desc(const DDSURFACEDESC2 *lpddsd) DECLSPEC_HIDDEN;
563 void dump_D3DMATRIX(const D3DMATRIX *mat) DECLSPEC_HIDDEN;
564 void DDRAW_dump_DDCAPS(const DDCAPS *lpcaps) DECLSPEC_HIDDEN;
565 DWORD get_flexible_vertex_size(DWORD d3dvtVertexType) DECLSPEC_HIDDEN;
566 void DDRAW_dump_DDSCAPS2(const DDSCAPS2 *in) DECLSPEC_HIDDEN;
567 void DDRAW_dump_cooperativelevel(DWORD cooplevel) DECLSPEC_HIDDEN;
569 /* This only needs to be here as long the processvertices functionality of
570 * IDirect3DExecuteBuffer isn't in WineD3D */
571 void multiply_matrix(LPD3DMATRIX dest, const D3DMATRIX *src1, const D3DMATRIX *src2) DECLSPEC_HIDDEN;
573 /* Used for generic dumping */
580 #define FE(x) { x, #x }
586 void (*func)(const void *);
591 #define ME(x,f,e) { x, #x, (void (*)(const void *))(f), offsetof(STRUCT, e) }
593 #define DD_STRUCT_COPY_BYSIZE(to,from) \
595 DWORD __size = (to)->dwSize; \
596 DWORD __copysize = __size; \
597 DWORD __resetsize = __size; \
598 assert(to != from); \
599 if (__resetsize > sizeof(*to)) \
600 __resetsize = sizeof(*to); \
601 memset(to,0,__resetsize); \
602 if ((from)->dwSize < __size) \
603 __copysize = (from)->dwSize; \
604 memcpy(to,from,__copysize); \
605 (to)->dwSize = __size;/*restore size*/ \
611 HRESULT hr_ddraw_from_wined3d(HRESULT hr) DECLSPEC_HIDDEN;