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_surface_wined3d_parent_ops DECLSPEC_HIDDEN;
41 extern const struct wined3d_parent_ops ddraw_null_wined3d_parent_ops DECLSPEC_HIDDEN;
43 /* Typdef the interfaces */
44 typedef struct IDirectDrawImpl IDirectDrawImpl;
45 typedef struct IDirectDrawSurfaceImpl IDirectDrawSurfaceImpl;
46 typedef struct IDirectDrawClipperImpl IDirectDrawClipperImpl;
47 typedef struct IDirectDrawPaletteImpl IDirectDrawPaletteImpl;
48 typedef struct IDirect3DDeviceImpl IDirect3DDeviceImpl;
49 typedef struct IDirect3DLightImpl IDirect3DLightImpl;
50 typedef struct IDirect3DViewportImpl IDirect3DViewportImpl;
51 typedef struct IDirect3DMaterialImpl IDirect3DMaterialImpl;
52 typedef struct IDirect3DExecuteBufferImpl IDirect3DExecuteBufferImpl;
53 typedef struct IDirect3DVertexBufferImpl IDirect3DVertexBufferImpl;
55 /* Global critical section */
56 extern CRITICAL_SECTION ddraw_cs DECLSPEC_HIDDEN;
58 extern DWORD force_refresh_rate DECLSPEC_HIDDEN;
60 /*****************************************************************************
61 * IDirectDraw implementation structure
62 *****************************************************************************/
66 struct wined3d_vertex_declaration *decl;
69 struct IDirectDrawImpl
72 IDirectDraw7 IDirectDraw7_iface;
73 IDirectDraw4 IDirectDraw4_iface;
74 IDirectDraw3 IDirectDraw3_iface;
75 IDirectDraw2 IDirectDraw2_iface;
76 IDirectDraw IDirectDraw_iface;
77 IDirect3D7 IDirect3D7_iface;
78 IDirect3D3 IDirect3D3_iface;
79 IDirect3D2 IDirect3D2_iface;
80 IDirect3D IDirect3D_iface;
81 struct wined3d_device_parent device_parent;
83 /* See comment in IDirectDraw::AddRef */
84 LONG ref7, ref4, ref2, ref3, ref1, numIfaces;
87 struct wined3d *wineD3D;
88 struct wined3d_device *wined3d_device;
91 /* Misc ddraw fields */
97 /* DirectDraw things, which are not handled by WineD3D */
98 DWORD cooperative_level;
100 DWORD orig_width, orig_height;
104 IDirectDrawSurfaceImpl *d3d_target;
106 IDirect3DDeviceImpl *d3ddevice;
114 /* The surface type to request */
115 WINED3DSURFTYPE ImplType;
117 /* Helpers for surface creation */
118 IDirectDrawSurfaceImpl *tex_root;
121 /* For the dll unload cleanup code */
122 struct list ddraw_list_entry;
123 /* The surface list - can't relay this to WineD3D
126 struct list surface_list;
130 struct FvfToDecl *decls;
131 UINT numConvertedDecls, declArraySize;
134 #define DDRAW_WINDOW_CLASS_NAME "ddraw_wc"
136 HRESULT ddraw_init(IDirectDrawImpl *ddraw, WINED3DDEVTYPE device_type) DECLSPEC_HIDDEN;
138 /* Utility functions */
139 void DDRAW_Convert_DDSCAPS_1_To_2(const DDSCAPS *pIn, DDSCAPS2 *pOut) DECLSPEC_HIDDEN;
140 void DDRAW_Convert_DDDEVICEIDENTIFIER_2_To_1(const DDDEVICEIDENTIFIER2 *pIn, DDDEVICEIDENTIFIER *pOut) DECLSPEC_HIDDEN;
141 HRESULT WINAPI ddraw_recreate_surfaces_cb(IDirectDrawSurface7 *surf,
142 DDSURFACEDESC2 *desc, void *Context) DECLSPEC_HIDDEN;
143 struct wined3d_vertex_declaration *ddraw_find_decl(IDirectDrawImpl *This, DWORD fvf) DECLSPEC_HIDDEN;
145 /* The default surface type */
146 extern WINED3DSURFTYPE DefaultSurfaceType DECLSPEC_HIDDEN;
148 /*****************************************************************************
149 * IDirectDrawSurface implementation structure
150 *****************************************************************************/
152 struct IDirectDrawSurfaceImpl
154 /* IUnknown fields */
155 IDirectDrawSurface7 IDirectDrawSurface7_iface;
156 IDirectDrawSurface4 IDirectDrawSurface4_iface;
157 IDirectDrawSurface3 IDirectDrawSurface3_iface;
158 IDirectDrawSurface2 IDirectDrawSurface2_iface;
159 IDirectDrawSurface IDirectDrawSurface_iface;
160 IDirectDrawGammaControl IDirectDrawGammaControl_iface;
161 const IDirect3DTexture2Vtbl *IDirect3DTexture2_vtbl;
162 const IDirect3DTextureVtbl *IDirect3DTexture_vtbl;
164 LONG ref7, ref4, ref3, ref2, ref1, iface_count, gamma_count;
165 IUnknown *ifaceToRelease;
169 /* Connections to other Objects */
170 IDirectDrawImpl *ddraw;
171 struct wined3d_surface *wined3d_surface;
172 struct wined3d_texture *wined3d_texture;
173 struct wined3d_swapchain *wined3d_swapchain;
175 /* This implementation handles attaching surfaces to other surfaces */
176 IDirectDrawSurfaceImpl *next_attached;
177 IDirectDrawSurfaceImpl *first_attached;
179 /* Complex surfaces are organized in a tree, although the tree is degenerated to a list in most cases.
180 * In mipmap and primary surfaces each level has only one attachment, which is the next surface level.
181 * Only the cube texture root has 6 surfaces attached, which then have a normal mipmap chain attached
182 * to them. So hardcode the array to 6, a dynamic array or a list would be an overkill.
184 #define MAX_COMPLEX_ATTACHED 6
185 IDirectDrawSurfaceImpl *complex_array[MAX_COMPLEX_ATTACHED];
186 /* You can't traverse the tree upwards. Only a flag for Surface::Release because its needed there,
187 * but no pointer to prevent temptations to traverse it in the wrong direction.
189 BOOL is_complex_root;
191 /* Surface description, for GetAttachedSurface */
192 DDSURFACEDESC2 surface_desc;
195 DWORD uniqueness_value;
197 WINED3DSURFTYPE ImplType;
199 /* For D3DDevice creation */
202 /* Clipper objects */
203 IDirectDrawClipperImpl *clipper;
205 /* For the ddraw surface list */
206 struct list surface_list_entry;
211 HRESULT ddraw_surface_create_texture(IDirectDrawSurfaceImpl *surface) DECLSPEC_HIDDEN;
212 void ddraw_surface_destroy(IDirectDrawSurfaceImpl *surface) DECLSPEC_HIDDEN;
213 HRESULT ddraw_surface_init(IDirectDrawSurfaceImpl *surface, IDirectDrawImpl *ddraw,
214 DDSURFACEDESC2 *desc, UINT mip_level, WINED3DSURFTYPE surface_type, UINT version) DECLSPEC_HIDDEN;
215 ULONG ddraw_surface_release_iface(IDirectDrawSurfaceImpl *This) DECLSPEC_HIDDEN;
217 static inline IDirectDrawSurfaceImpl *surface_from_texture1(IDirect3DTexture *iface)
219 return (IDirectDrawSurfaceImpl *)((char*)iface - FIELD_OFFSET(IDirectDrawSurfaceImpl, IDirect3DTexture_vtbl));
222 static inline IDirectDrawSurfaceImpl *surface_from_texture2(IDirect3DTexture2 *iface)
224 return (IDirectDrawSurfaceImpl *)((char*)iface - FIELD_OFFSET(IDirectDrawSurfaceImpl, IDirect3DTexture2_vtbl));
227 static inline IDirectDrawSurfaceImpl *impl_from_IDirectDrawSurface(IDirectDrawSurface *iface)
229 return CONTAINING_RECORD(iface, IDirectDrawSurfaceImpl, IDirectDrawSurface_iface);
232 static inline IDirectDrawSurfaceImpl *impl_from_IDirectDrawSurface2(IDirectDrawSurface2 *iface)
234 return CONTAINING_RECORD(iface, IDirectDrawSurfaceImpl, IDirectDrawSurface2_iface);
237 static inline IDirectDrawSurfaceImpl *impl_from_IDirectDrawSurface3(IDirectDrawSurface3 *iface)
239 return CONTAINING_RECORD(iface, IDirectDrawSurfaceImpl, IDirectDrawSurface3_iface);
242 static inline IDirectDrawSurfaceImpl *impl_from_IDirectDrawSurface4(IDirectDrawSurface4 *iface)
244 return CONTAINING_RECORD(iface, IDirectDrawSurfaceImpl, IDirectDrawSurface4_iface);
247 static inline IDirectDrawSurfaceImpl *impl_from_IDirectDrawSurface7(IDirectDrawSurface7 *iface)
249 return CONTAINING_RECORD(iface, IDirectDrawSurfaceImpl, IDirectDrawSurface7_iface);
252 IDirectDrawSurfaceImpl *unsafe_impl_from_IDirectDrawSurface(IDirectDrawSurface *iface) DECLSPEC_HIDDEN;
253 IDirectDrawSurfaceImpl *unsafe_impl_from_IDirectDrawSurface4(IDirectDrawSurface4 *iface) DECLSPEC_HIDDEN;
254 IDirectDrawSurfaceImpl *unsafe_impl_from_IDirectDrawSurface7(IDirectDrawSurface7 *iface) DECLSPEC_HIDDEN;
256 /* Get the number of bytes per pixel for a given surface */
257 #define PFGET_BPP(pf) (pf.dwFlags&DDPF_PALETTEINDEXED8?1:((pf.dwRGBBitCount+7)/8))
258 #define GET_BPP(desc) PFGET_BPP(desc.ddpfPixelFormat)
260 #define DDRAW_INVALID_HANDLE ~0U
262 enum ddraw_handle_type
265 DDRAW_HANDLE_MATERIAL,
267 DDRAW_HANDLE_STATEBLOCK,
268 DDRAW_HANDLE_SURFACE,
271 struct ddraw_handle_entry
274 enum ddraw_handle_type type;
277 struct ddraw_handle_table
279 struct ddraw_handle_entry *entries;
280 struct ddraw_handle_entry *free_entries;
285 BOOL ddraw_handle_table_init(struct ddraw_handle_table *t, UINT initial_size) DECLSPEC_HIDDEN;
286 void ddraw_handle_table_destroy(struct ddraw_handle_table *t) DECLSPEC_HIDDEN;
287 DWORD ddraw_allocate_handle(struct ddraw_handle_table *t, void *object, enum ddraw_handle_type type) DECLSPEC_HIDDEN;
288 void *ddraw_free_handle(struct ddraw_handle_table *t, DWORD handle, enum ddraw_handle_type type) DECLSPEC_HIDDEN;
289 void *ddraw_get_object(struct ddraw_handle_table *t, DWORD handle, enum ddraw_handle_type type) DECLSPEC_HIDDEN;
291 struct IDirect3DDeviceImpl
294 const IDirect3DDevice7Vtbl *lpVtbl;
295 const IDirect3DDevice3Vtbl *IDirect3DDevice3_vtbl;
296 const IDirect3DDevice2Vtbl *IDirect3DDevice2_vtbl;
297 const IDirect3DDeviceVtbl *IDirect3DDevice_vtbl;
300 /* Other object connections */
301 struct wined3d_device *wined3d_device;
302 IDirectDrawImpl *ddraw;
303 struct wined3d_buffer *indexbuffer;
304 IDirectDrawSurfaceImpl *target;
306 /* Viewport management */
307 struct list viewport_list;
308 IDirect3DViewportImpl *current_viewport;
309 D3DVIEWPORT7 active_viewport;
311 /* Required to keep track which of two available texture blending modes in d3ddevice3 is used */
312 BOOL legacyTextureBlending;
317 /* Rendering functions to wrap D3D(1-3) to D3D7 */
318 D3DPRIMITIVETYPE primitive_type;
322 LPBYTE vertex_buffer;
326 /* Handle management */
327 struct ddraw_handle_table handle_table;
328 D3DMATRIXHANDLE world, proj, view;
331 HRESULT d3d_device_init(IDirect3DDeviceImpl *device, IDirectDrawImpl *ddraw,
332 IDirectDrawSurfaceImpl *target) DECLSPEC_HIDDEN;
335 extern const GUID IID_D3DDEVICE_WineD3D DECLSPEC_HIDDEN;
337 /* Helper functions */
338 HRESULT IDirect3DImpl_GetCaps(const struct wined3d *wined3d,
339 D3DDEVICEDESC *Desc123, D3DDEVICEDESC7 *Desc7) DECLSPEC_HIDDEN;
340 WINED3DZBUFFERTYPE IDirect3DDeviceImpl_UpdateDepthStencil(IDirect3DDeviceImpl *This) DECLSPEC_HIDDEN;
342 static inline IDirect3DDeviceImpl *device_from_device1(IDirect3DDevice *iface)
344 return (IDirect3DDeviceImpl *)((char*)iface - FIELD_OFFSET(IDirect3DDeviceImpl, IDirect3DDevice_vtbl));
347 static inline IDirect3DDeviceImpl *device_from_device2(IDirect3DDevice2 *iface)
349 return (IDirect3DDeviceImpl *)((char*)iface - FIELD_OFFSET(IDirect3DDeviceImpl, IDirect3DDevice2_vtbl));
352 static inline IDirect3DDeviceImpl *device_from_device3(IDirect3DDevice3 *iface)
354 return (IDirect3DDeviceImpl *)((char*)iface - FIELD_OFFSET(IDirect3DDeviceImpl, IDirect3DDevice3_vtbl));
357 /*****************************************************************************
358 * IDirectDrawClipper implementation structure
359 *****************************************************************************/
360 struct IDirectDrawClipperImpl
362 IDirectDrawClipper IDirectDrawClipper_iface;
365 struct wined3d_clipper *wineD3DClipper;
369 HRESULT ddraw_clipper_init(IDirectDrawClipperImpl *clipper) DECLSPEC_HIDDEN;
370 IDirectDrawClipperImpl *unsafe_impl_from_IDirectDrawClipper(IDirectDrawClipper *iface) 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 IDirect3DLight IDirect3DLight_iface;
406 /* IDirect3DLight fields */
407 IDirectDrawImpl *ddraw;
409 /* If this light is active for one viewport, put the viewport here */
410 IDirect3DViewportImpl *active_viewport;
420 /* Helper functions */
421 void light_activate(IDirect3DLightImpl *light) DECLSPEC_HIDDEN;
422 void light_deactivate(IDirect3DLightImpl *light) DECLSPEC_HIDDEN;
423 void d3d_light_init(IDirect3DLightImpl *light, IDirectDrawImpl *ddraw) DECLSPEC_HIDDEN;
424 IDirect3DLightImpl *unsafe_impl_from_IDirect3DLight(IDirect3DLight *iface) DECLSPEC_HIDDEN;
426 /******************************************************************************
427 * IDirect3DMaterial implementation structure - Wraps to D3D7
428 ******************************************************************************/
429 struct IDirect3DMaterialImpl
431 IDirect3DMaterial3 IDirect3DMaterial3_iface;
432 IDirect3DMaterial2 IDirect3DMaterial2_iface;
433 IDirect3DMaterial IDirect3DMaterial_iface;
436 /* IDirect3DMaterial2 fields */
437 IDirectDrawImpl *ddraw;
438 IDirect3DDeviceImpl *active_device;
444 /* Helper functions */
445 void material_activate(IDirect3DMaterialImpl* This) DECLSPEC_HIDDEN;
446 IDirect3DMaterialImpl *d3d_material_create(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;
474 struct list light_list;
476 /* Background material */
477 IDirect3DMaterialImpl *background;
480 /* Helper functions */
481 void viewport_activate(IDirect3DViewportImpl* This, BOOL ignore_lights) DECLSPEC_HIDDEN;
482 void d3d_viewport_init(IDirect3DViewportImpl *viewport, IDirectDrawImpl *ddraw) DECLSPEC_HIDDEN;
484 /*****************************************************************************
485 * IDirect3DExecuteBuffer - Wraps to D3D7
486 *****************************************************************************/
487 struct IDirect3DExecuteBufferImpl
489 IDirect3DExecuteBuffer IDirect3DExecuteBuffer_iface;
491 /* IDirect3DExecuteBuffer fields */
492 IDirectDrawImpl *ddraw;
493 IDirect3DDeviceImpl *d3ddev;
495 D3DEXECUTEBUFFERDESC desc;
498 /* This buffer will store the transformed vertices */
503 /* This flags is set to TRUE if we allocated ourselves the
509 HRESULT d3d_execute_buffer_init(IDirect3DExecuteBufferImpl *execute_buffer,
510 IDirect3DDeviceImpl *device, D3DEXECUTEBUFFERDESC *desc) DECLSPEC_HIDDEN;
511 IDirect3DExecuteBufferImpl *unsafe_impl_from_IDirect3DExecuteBuffer(IDirect3DExecuteBuffer *iface) DECLSPEC_HIDDEN;
513 /* The execute function */
514 HRESULT d3d_execute_buffer_execute(IDirect3DExecuteBufferImpl *execute_buffer,
515 IDirect3DDeviceImpl *device, IDirect3DViewportImpl *viewport) DECLSPEC_HIDDEN;
517 /*****************************************************************************
518 * IDirect3DVertexBuffer
519 *****************************************************************************/
520 struct IDirect3DVertexBufferImpl
522 IDirect3DVertexBuffer7 IDirect3DVertexBuffer7_iface;
523 IDirect3DVertexBuffer IDirect3DVertexBuffer_iface;
526 /*** WineD3D and ddraw links ***/
527 struct wined3d_buffer *wineD3DVertexBuffer;
528 struct wined3d_vertex_declaration *wineD3DVertexDeclaration;
529 IDirectDrawImpl *ddraw;
531 /*** Storage for D3D7 specific things ***/
536 HRESULT d3d_vertex_buffer_create(IDirect3DVertexBufferImpl **vertex_buf, IDirectDrawImpl *ddraw,
537 D3DVERTEXBUFFERDESC *desc) DECLSPEC_HIDDEN;
538 IDirect3DVertexBufferImpl *unsafe_impl_from_IDirect3DVertexBuffer(IDirect3DVertexBuffer *iface) DECLSPEC_HIDDEN;
539 IDirect3DVertexBufferImpl *unsafe_impl_from_IDirect3DVertexBuffer7(IDirect3DVertexBuffer7 *iface) DECLSPEC_HIDDEN;
541 /*****************************************************************************
542 * Helper functions from utils.c
543 *****************************************************************************/
545 #define GET_TEXCOUNT_FROM_FVF(d3dvtVertexType) \
546 (((d3dvtVertexType) & D3DFVF_TEXCOUNT_MASK) >> D3DFVF_TEXCOUNT_SHIFT)
548 #define GET_TEXCOORD_SIZE_FROM_FVF(d3dvtVertexType, tex_num) \
549 (((((d3dvtVertexType) >> (16 + (2 * (tex_num)))) + 1) & 0x03) + 1)
551 void PixelFormat_WineD3DtoDD(DDPIXELFORMAT *DDPixelFormat, enum wined3d_format_id WineD3DFormat) DECLSPEC_HIDDEN;
552 enum wined3d_format_id PixelFormat_DD2WineD3D(const DDPIXELFORMAT *DDPixelFormat) DECLSPEC_HIDDEN;
553 void DDRAW_dump_surface_desc(const DDSURFACEDESC2 *lpddsd) DECLSPEC_HIDDEN;
554 void dump_D3DMATRIX(const D3DMATRIX *mat) DECLSPEC_HIDDEN;
555 void DDRAW_dump_DDCAPS(const DDCAPS *lpcaps) DECLSPEC_HIDDEN;
556 DWORD get_flexible_vertex_size(DWORD d3dvtVertexType) DECLSPEC_HIDDEN;
557 void DDRAW_dump_DDSCAPS2(const DDSCAPS2 *in) DECLSPEC_HIDDEN;
558 void DDRAW_dump_cooperativelevel(DWORD cooplevel) DECLSPEC_HIDDEN;
560 /* This only needs to be here as long the processvertices functionality of
561 * IDirect3DExecuteBuffer isn't in WineD3D */
562 void multiply_matrix(LPD3DMATRIX dest, const D3DMATRIX *src1, const D3DMATRIX *src2) DECLSPEC_HIDDEN;
564 /* Used for generic dumping */
571 #define FE(x) { x, #x }
577 void (*func)(const void *);
582 #define ME(x,f,e) { x, #x, (void (*)(const void *))(f), offsetof(STRUCT, e) }
584 #define DD_STRUCT_COPY_BYSIZE_(to,from,from_size) \
586 DWORD __size = (to)->dwSize; \
587 DWORD __resetsize = min(__size, sizeof(*to)); \
588 DWORD __copysize = min(__resetsize, from_size); \
589 assert(to != from); \
590 memcpy(to, from, __copysize); \
591 memset((char*)(to) + __copysize, 0, __resetsize - __copysize); \
592 (to)->dwSize = __size; /* restore size */ \
595 #define DD_STRUCT_COPY_BYSIZE(to,from) DD_STRUCT_COPY_BYSIZE_(to,from,(from)->dwSize)
597 #define SIZEOF_END_PADDING(type, last_field) \
598 (sizeof(type) - offsetof(type, last_field) - sizeof(((type *)0)->last_field))
600 static inline void copy_to_surfacedesc2(DDSURFACEDESC2 *to, DDSURFACEDESC2 *from)
602 DWORD from_size = from->dwSize;
603 if (from_size == sizeof(DDSURFACEDESC))
604 from_size -= SIZEOF_END_PADDING(DDSURFACEDESC, ddsCaps);
605 to->dwSize = sizeof(DDSURFACEDESC2); /* for struct copy */
606 DD_STRUCT_COPY_BYSIZE_(to, from, from_size);
609 HRESULT hr_ddraw_from_wined3d(HRESULT hr) DECLSPEC_HIDDEN;