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 IDirectDrawSurfaceImpl *primary;
92 struct wined3d_surface *wined3d_frontbuffer;
94 /* DirectDraw things, which are not handled by WineD3D */
95 DWORD cooperative_level;
97 DWORD orig_width, orig_height;
101 IDirectDrawSurfaceImpl *d3d_target;
103 IDirect3DDeviceImpl *d3ddevice;
111 /* Helpers for surface creation */
112 IDirectDrawSurfaceImpl *tex_root;
114 /* For the dll unload cleanup code */
115 struct list ddraw_list_entry;
116 /* The surface list - can't relay this to WineD3D
119 struct list surface_list;
122 struct FvfToDecl *decls;
123 UINT numConvertedDecls, declArraySize;
126 #define DDRAW_WINDOW_CLASS_NAME "ddraw_wc"
128 HRESULT ddraw_init(IDirectDrawImpl *ddraw, WINED3DDEVTYPE device_type) DECLSPEC_HIDDEN;
130 /* Utility functions */
131 void DDRAW_Convert_DDSCAPS_1_To_2(const DDSCAPS *pIn, DDSCAPS2 *pOut) DECLSPEC_HIDDEN;
132 void DDRAW_Convert_DDDEVICEIDENTIFIER_2_To_1(const DDDEVICEIDENTIFIER2 *pIn, DDDEVICEIDENTIFIER *pOut) DECLSPEC_HIDDEN;
133 struct wined3d_vertex_declaration *ddraw_find_decl(IDirectDrawImpl *This, DWORD fvf) DECLSPEC_HIDDEN;
135 /* The default surface type */
136 extern WINED3DSURFTYPE DefaultSurfaceType DECLSPEC_HIDDEN;
138 /*****************************************************************************
139 * IDirectDrawSurface implementation structure
140 *****************************************************************************/
142 struct IDirectDrawSurfaceImpl
144 /* IUnknown fields */
145 IDirectDrawSurface7 IDirectDrawSurface7_iface;
146 IDirectDrawSurface4 IDirectDrawSurface4_iface;
147 IDirectDrawSurface3 IDirectDrawSurface3_iface;
148 IDirectDrawSurface2 IDirectDrawSurface2_iface;
149 IDirectDrawSurface IDirectDrawSurface_iface;
150 IDirectDrawGammaControl IDirectDrawGammaControl_iface;
151 IDirect3DTexture2 IDirect3DTexture2_iface;
152 IDirect3DTexture IDirect3DTexture_iface;
154 LONG ref7, ref4, ref3, ref2, ref1, iface_count, gamma_count;
155 IUnknown *ifaceToRelease;
159 /* Connections to other Objects */
160 IDirectDrawImpl *ddraw;
161 struct wined3d_surface *wined3d_surface;
162 struct wined3d_texture *wined3d_texture;
163 struct wined3d_swapchain *wined3d_swapchain;
165 /* This implementation handles attaching surfaces to other surfaces */
166 IDirectDrawSurfaceImpl *next_attached;
167 IDirectDrawSurfaceImpl *first_attached;
169 /* Complex surfaces are organized in a tree, although the tree is degenerated to a list in most cases.
170 * In mipmap and primary surfaces each level has only one attachment, which is the next surface level.
171 * Only the cube texture root has 6 surfaces attached, which then have a normal mipmap chain attached
172 * to them. So hardcode the array to 6, a dynamic array or a list would be an overkill.
174 #define MAX_COMPLEX_ATTACHED 6
175 IDirectDrawSurfaceImpl *complex_array[MAX_COMPLEX_ATTACHED];
176 /* You can't traverse the tree upwards. Only a flag for Surface::Release because its needed there,
177 * but no pointer to prevent temptations to traverse it in the wrong direction.
179 BOOL is_complex_root;
181 /* Surface description, for GetAttachedSurface */
182 DDSURFACEDESC2 surface_desc;
185 DWORD uniqueness_value;
188 /* Clipper objects */
189 IDirectDrawClipperImpl *clipper;
191 /* For the ddraw surface list */
192 struct list surface_list_entry;
197 HRESULT ddraw_surface_create_texture(IDirectDrawSurfaceImpl *surface) DECLSPEC_HIDDEN;
198 void ddraw_surface_destroy(IDirectDrawSurfaceImpl *surface) DECLSPEC_HIDDEN;
199 HRESULT ddraw_surface_init(IDirectDrawSurfaceImpl *surface, IDirectDrawImpl *ddraw,
200 DDSURFACEDESC2 *desc, UINT mip_level, UINT version) DECLSPEC_HIDDEN;
201 ULONG ddraw_surface_release_iface(IDirectDrawSurfaceImpl *This) DECLSPEC_HIDDEN;
203 static inline IDirectDrawSurfaceImpl *impl_from_IDirect3DTexture(IDirect3DTexture *iface)
205 return CONTAINING_RECORD(iface, IDirectDrawSurfaceImpl, IDirect3DTexture_iface);
208 static inline IDirectDrawSurfaceImpl *impl_from_IDirect3DTexture2(IDirect3DTexture2 *iface)
210 return CONTAINING_RECORD(iface, IDirectDrawSurfaceImpl, IDirect3DTexture2_iface);
213 static inline IDirectDrawSurfaceImpl *impl_from_IDirectDrawSurface(IDirectDrawSurface *iface)
215 return CONTAINING_RECORD(iface, IDirectDrawSurfaceImpl, IDirectDrawSurface_iface);
218 static inline IDirectDrawSurfaceImpl *impl_from_IDirectDrawSurface2(IDirectDrawSurface2 *iface)
220 return CONTAINING_RECORD(iface, IDirectDrawSurfaceImpl, IDirectDrawSurface2_iface);
223 static inline IDirectDrawSurfaceImpl *impl_from_IDirectDrawSurface3(IDirectDrawSurface3 *iface)
225 return CONTAINING_RECORD(iface, IDirectDrawSurfaceImpl, IDirectDrawSurface3_iface);
228 static inline IDirectDrawSurfaceImpl *impl_from_IDirectDrawSurface4(IDirectDrawSurface4 *iface)
230 return CONTAINING_RECORD(iface, IDirectDrawSurfaceImpl, IDirectDrawSurface4_iface);
233 static inline IDirectDrawSurfaceImpl *impl_from_IDirectDrawSurface7(IDirectDrawSurface7 *iface)
235 return CONTAINING_RECORD(iface, IDirectDrawSurfaceImpl, IDirectDrawSurface7_iface);
238 IDirectDrawSurfaceImpl *unsafe_impl_from_IDirectDrawSurface(IDirectDrawSurface *iface) DECLSPEC_HIDDEN;
239 IDirectDrawSurfaceImpl *unsafe_impl_from_IDirectDrawSurface4(IDirectDrawSurface4 *iface) DECLSPEC_HIDDEN;
240 IDirectDrawSurfaceImpl *unsafe_impl_from_IDirectDrawSurface7(IDirectDrawSurface7 *iface) DECLSPEC_HIDDEN;
242 IDirectDrawSurfaceImpl *unsafe_impl_from_IDirect3DTexture(IDirect3DTexture *iface) DECLSPEC_HIDDEN;
243 IDirectDrawSurfaceImpl *unsafe_impl_from_IDirect3DTexture2(IDirect3DTexture2 *iface) DECLSPEC_HIDDEN;
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 struct wined3d_device *wined3d_device;
287 IDirectDrawImpl *ddraw;
288 struct wined3d_buffer *indexbuffer;
289 IDirectDrawSurfaceImpl *target;
291 /* Viewport management */
292 struct list 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));
342 /*****************************************************************************
343 * IDirectDrawClipper implementation structure
344 *****************************************************************************/
345 struct IDirectDrawClipperImpl
347 IDirectDrawClipper IDirectDrawClipper_iface;
350 struct wined3d_clipper *wineD3DClipper;
354 HRESULT ddraw_clipper_init(IDirectDrawClipperImpl *clipper) DECLSPEC_HIDDEN;
355 IDirectDrawClipperImpl *unsafe_impl_from_IDirectDrawClipper(IDirectDrawClipper *iface) DECLSPEC_HIDDEN;
357 /*****************************************************************************
358 * IDirectDrawPalette implementation structure
359 *****************************************************************************/
360 struct IDirectDrawPaletteImpl
362 /* IUnknown fields */
363 const IDirectDrawPaletteVtbl *lpVtbl;
366 struct wined3d_palette *wineD3DPalette;
368 /* IDirectDrawPalette fields */
369 IUnknown *ifaceToRelease;
372 HRESULT ddraw_palette_init(IDirectDrawPaletteImpl *palette,
373 IDirectDrawImpl *ddraw, DWORD flags, PALETTEENTRY *entries) DECLSPEC_HIDDEN;
375 /* Helper structures */
376 struct object_creation_info
379 HRESULT (*pfnCreateInstance)(IUnknown *pUnkOuter, REFIID riid,
383 /******************************************************************************
384 * IDirect3DLight implementation structure - Wraps to D3D7
385 ******************************************************************************/
386 struct IDirect3DLightImpl
388 IDirect3DLight IDirect3DLight_iface;
391 /* IDirect3DLight fields */
392 IDirectDrawImpl *ddraw;
394 /* If this light is active for one viewport, put the viewport here */
395 IDirect3DViewportImpl *active_viewport;
405 /* Helper functions */
406 void light_activate(IDirect3DLightImpl *light) DECLSPEC_HIDDEN;
407 void light_deactivate(IDirect3DLightImpl *light) DECLSPEC_HIDDEN;
408 void d3d_light_init(IDirect3DLightImpl *light, IDirectDrawImpl *ddraw) DECLSPEC_HIDDEN;
409 IDirect3DLightImpl *unsafe_impl_from_IDirect3DLight(IDirect3DLight *iface) DECLSPEC_HIDDEN;
411 /******************************************************************************
412 * IDirect3DMaterial implementation structure - Wraps to D3D7
413 ******************************************************************************/
414 struct IDirect3DMaterialImpl
416 IDirect3DMaterial3 IDirect3DMaterial3_iface;
417 IDirect3DMaterial2 IDirect3DMaterial2_iface;
418 IDirect3DMaterial IDirect3DMaterial_iface;
421 /* IDirect3DMaterial2 fields */
422 IDirectDrawImpl *ddraw;
423 IDirect3DDeviceImpl *active_device;
429 /* Helper functions */
430 void material_activate(IDirect3DMaterialImpl* This) DECLSPEC_HIDDEN;
431 IDirect3DMaterialImpl *d3d_material_create(IDirectDrawImpl *ddraw) DECLSPEC_HIDDEN;
433 /*****************************************************************************
434 * IDirect3DViewport - Wraps to D3D7
435 *****************************************************************************/
436 struct IDirect3DViewportImpl
438 const IDirect3DViewport3Vtbl *lpVtbl;
441 /* IDirect3DViewport fields */
442 IDirectDrawImpl *ddraw;
444 /* If this viewport is active for one device, put the device here */
445 IDirect3DDeviceImpl *active_device;
459 struct list light_list;
461 /* Background material */
462 IDirect3DMaterialImpl *background;
465 /* Helper functions */
466 void viewport_activate(IDirect3DViewportImpl* This, BOOL ignore_lights) DECLSPEC_HIDDEN;
467 void d3d_viewport_init(IDirect3DViewportImpl *viewport, IDirectDrawImpl *ddraw) DECLSPEC_HIDDEN;
469 /*****************************************************************************
470 * IDirect3DExecuteBuffer - Wraps to D3D7
471 *****************************************************************************/
472 struct IDirect3DExecuteBufferImpl
474 IDirect3DExecuteBuffer IDirect3DExecuteBuffer_iface;
476 /* IDirect3DExecuteBuffer fields */
477 IDirectDrawImpl *ddraw;
478 IDirect3DDeviceImpl *d3ddev;
480 D3DEXECUTEBUFFERDESC desc;
483 /* This buffer will store the transformed vertices */
488 /* This flags is set to TRUE if we allocated ourselves the
494 HRESULT d3d_execute_buffer_init(IDirect3DExecuteBufferImpl *execute_buffer,
495 IDirect3DDeviceImpl *device, D3DEXECUTEBUFFERDESC *desc) DECLSPEC_HIDDEN;
496 IDirect3DExecuteBufferImpl *unsafe_impl_from_IDirect3DExecuteBuffer(IDirect3DExecuteBuffer *iface) DECLSPEC_HIDDEN;
498 /* The execute function */
499 HRESULT d3d_execute_buffer_execute(IDirect3DExecuteBufferImpl *execute_buffer,
500 IDirect3DDeviceImpl *device, IDirect3DViewportImpl *viewport) DECLSPEC_HIDDEN;
502 /*****************************************************************************
503 * IDirect3DVertexBuffer
504 *****************************************************************************/
505 struct IDirect3DVertexBufferImpl
507 IDirect3DVertexBuffer7 IDirect3DVertexBuffer7_iface;
508 IDirect3DVertexBuffer IDirect3DVertexBuffer_iface;
511 /*** WineD3D and ddraw links ***/
512 struct wined3d_buffer *wineD3DVertexBuffer;
513 struct wined3d_vertex_declaration *wineD3DVertexDeclaration;
514 IDirectDrawImpl *ddraw;
516 /*** Storage for D3D7 specific things ***/
521 HRESULT d3d_vertex_buffer_create(IDirect3DVertexBufferImpl **vertex_buf, IDirectDrawImpl *ddraw,
522 D3DVERTEXBUFFERDESC *desc) DECLSPEC_HIDDEN;
523 IDirect3DVertexBufferImpl *unsafe_impl_from_IDirect3DVertexBuffer(IDirect3DVertexBuffer *iface) DECLSPEC_HIDDEN;
524 IDirect3DVertexBufferImpl *unsafe_impl_from_IDirect3DVertexBuffer7(IDirect3DVertexBuffer7 *iface) DECLSPEC_HIDDEN;
526 /*****************************************************************************
527 * Helper functions from utils.c
528 *****************************************************************************/
530 #define GET_TEXCOUNT_FROM_FVF(d3dvtVertexType) \
531 (((d3dvtVertexType) & D3DFVF_TEXCOUNT_MASK) >> D3DFVF_TEXCOUNT_SHIFT)
533 #define GET_TEXCOORD_SIZE_FROM_FVF(d3dvtVertexType, tex_num) \
534 (((((d3dvtVertexType) >> (16 + (2 * (tex_num)))) + 1) & 0x03) + 1)
536 void PixelFormat_WineD3DtoDD(DDPIXELFORMAT *DDPixelFormat, enum wined3d_format_id WineD3DFormat) DECLSPEC_HIDDEN;
537 enum wined3d_format_id PixelFormat_DD2WineD3D(const DDPIXELFORMAT *DDPixelFormat) DECLSPEC_HIDDEN;
538 void DDRAW_dump_surface_desc(const DDSURFACEDESC2 *lpddsd) DECLSPEC_HIDDEN;
539 void dump_D3DMATRIX(const D3DMATRIX *mat) DECLSPEC_HIDDEN;
540 void DDRAW_dump_DDCAPS(const DDCAPS *lpcaps) DECLSPEC_HIDDEN;
541 DWORD get_flexible_vertex_size(DWORD d3dvtVertexType) DECLSPEC_HIDDEN;
542 void DDRAW_dump_DDSCAPS2(const DDSCAPS2 *in) DECLSPEC_HIDDEN;
543 void DDRAW_dump_cooperativelevel(DWORD cooplevel) DECLSPEC_HIDDEN;
544 void DDSD_to_DDSD2(const DDSURFACEDESC *in, DDSURFACEDESC2 *out) DECLSPEC_HIDDEN;
545 void DDSD2_to_DDSD(const DDSURFACEDESC2 *in, DDSURFACEDESC *out) DECLSPEC_HIDDEN;
547 /* This only needs to be here as long the processvertices functionality of
548 * IDirect3DExecuteBuffer isn't in WineD3D */
549 void multiply_matrix(LPD3DMATRIX dest, const D3DMATRIX *src1, const D3DMATRIX *src2) DECLSPEC_HIDDEN;
551 /* Used for generic dumping */
558 #define FE(x) { x, #x }
564 void (*func)(const void *);
569 #define ME(x,f,e) { x, #x, (void (*)(const void *))(f), offsetof(STRUCT, e) }
571 #define DD_STRUCT_COPY_BYSIZE_(to,from,from_size) \
573 DWORD __size = (to)->dwSize; \
574 DWORD __resetsize = min(__size, sizeof(*to)); \
575 DWORD __copysize = min(__resetsize, from_size); \
576 assert(to != from); \
577 memcpy(to, from, __copysize); \
578 memset((char*)(to) + __copysize, 0, __resetsize - __copysize); \
579 (to)->dwSize = __size; /* restore size */ \
582 #define DD_STRUCT_COPY_BYSIZE(to,from) DD_STRUCT_COPY_BYSIZE_(to,from,(from)->dwSize)
584 #define SIZEOF_END_PADDING(type, last_field) \
585 (sizeof(type) - offsetof(type, last_field) - sizeof(((type *)0)->last_field))
587 static inline void copy_to_surfacedesc2(DDSURFACEDESC2 *to, DDSURFACEDESC2 *from)
589 DWORD from_size = from->dwSize;
590 if (from_size == sizeof(DDSURFACEDESC))
591 from_size -= SIZEOF_END_PADDING(DDSURFACEDESC, ddsCaps);
592 to->dwSize = sizeof(DDSURFACEDESC2); /* for struct copy */
593 DD_STRUCT_COPY_BYSIZE_(to, from, from_size);
596 HRESULT hr_ddraw_from_wined3d(HRESULT hr) DECLSPEC_HIDDEN;