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 const IWineD3DDeviceParentVtbl
*device_parent_vtbl
;
83 /* See comment in IDirectDraw::AddRef */
84 LONG ref7
, ref4
, ref2
, ref3
, ref1
, numIfaces
;
87 struct wined3d
*wineD3D
;
88 IWineD3DDevice
*wineD3DDevice
;
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 /* Helper structures */
139 typedef struct EnumDisplayModesCBS
142 LPDDENUMMODESCALLBACK2 callback
;
143 } EnumDisplayModesCBS
;
145 typedef struct EnumSurfacesCBS
148 LPDDENUMSURFACESCALLBACK7 callback
;
149 LPDDSURFACEDESC2 pDDSD
;
153 /* Utility functions */
154 void DDRAW_Convert_DDSCAPS_1_To_2(const DDSCAPS
*pIn
, DDSCAPS2
*pOut
) DECLSPEC_HIDDEN
;
155 void DDRAW_Convert_DDDEVICEIDENTIFIER_2_To_1(const DDDEVICEIDENTIFIER2
*pIn
, DDDEVICEIDENTIFIER
*pOut
) DECLSPEC_HIDDEN
;
156 HRESULT WINAPI
ddraw_recreate_surfaces_cb(IDirectDrawSurface7
*surf
,
157 DDSURFACEDESC2
*desc
, void *Context
) DECLSPEC_HIDDEN
;
158 struct wined3d_vertex_declaration
*ddraw_find_decl(IDirectDrawImpl
*This
, DWORD fvf
) DECLSPEC_HIDDEN
;
160 /* The default surface type */
161 extern WINED3DSURFTYPE DefaultSurfaceType DECLSPEC_HIDDEN
;
163 /*****************************************************************************
164 * IDirectDrawSurface implementation structure
165 *****************************************************************************/
167 struct IDirectDrawSurfaceImpl
169 /* IUnknown fields */
170 const IDirectDrawSurface7Vtbl
*lpVtbl
;
171 const IDirectDrawSurface3Vtbl
*IDirectDrawSurface3_vtbl
;
172 const IDirectDrawGammaControlVtbl
*IDirectDrawGammaControl_vtbl
;
173 const IDirect3DTexture2Vtbl
*IDirect3DTexture2_vtbl
;
174 const IDirect3DTextureVtbl
*IDirect3DTexture_vtbl
;
177 IUnknown
*ifaceToRelease
;
181 /* Connections to other Objects */
182 IDirectDrawImpl
*ddraw
;
183 struct wined3d_surface
*wined3d_surface
;
184 struct wined3d_texture
*wined3d_texture
;
185 struct wined3d_swapchain
*wined3d_swapchain
;
187 /* This implementation handles attaching surfaces to other surfaces */
188 IDirectDrawSurfaceImpl
*next_attached
;
189 IDirectDrawSurfaceImpl
*first_attached
;
191 /* Complex surfaces are organized in a tree, although the tree is degenerated to a list in most cases.
192 * In mipmap and primary surfaces each level has only one attachment, which is the next surface level.
193 * Only the cube texture root has 6 surfaces attached, which then have a normal mipmap chain attached
194 * to them. So hardcode the array to 6, a dynamic array or a list would be an overkill.
196 #define MAX_COMPLEX_ATTACHED 6
197 IDirectDrawSurfaceImpl
*complex_array
[MAX_COMPLEX_ATTACHED
];
198 /* You can't traverse the tree upwards. Only a flag for Surface::Release because its needed there,
199 * but no pointer to prevent temptations to traverse it in the wrong direction.
201 BOOL is_complex_root
;
203 /* Surface description, for GetAttachedSurface */
204 DDSURFACEDESC2 surface_desc
;
207 DWORD uniqueness_value
;
209 WINED3DSURFTYPE ImplType
;
211 /* For D3DDevice creation */
214 /* Clipper objects */
215 IDirectDrawClipperImpl
*clipper
;
217 /* For the ddraw surface list */
218 struct list surface_list_entry
;
223 HRESULT
ddraw_surface_create_texture(IDirectDrawSurfaceImpl
*surface
) DECLSPEC_HIDDEN
;
224 void ddraw_surface_destroy(IDirectDrawSurfaceImpl
*surface
) DECLSPEC_HIDDEN
;
225 HRESULT
ddraw_surface_init(IDirectDrawSurfaceImpl
*surface
, IDirectDrawImpl
*ddraw
,
226 DDSURFACEDESC2
*desc
, UINT mip_level
, WINED3DSURFTYPE surface_type
) DECLSPEC_HIDDEN
;
228 static inline IDirectDrawSurfaceImpl
*surface_from_texture1(IDirect3DTexture
*iface
)
230 return (IDirectDrawSurfaceImpl
*)((char*)iface
- FIELD_OFFSET(IDirectDrawSurfaceImpl
, IDirect3DTexture_vtbl
));
233 static inline IDirectDrawSurfaceImpl
*surface_from_texture2(IDirect3DTexture2
*iface
)
235 return (IDirectDrawSurfaceImpl
*)((char*)iface
- FIELD_OFFSET(IDirectDrawSurfaceImpl
, IDirect3DTexture2_vtbl
));
238 static inline IDirectDrawSurfaceImpl
*surface_from_surface3(IDirectDrawSurface3
*iface
)
240 return (IDirectDrawSurfaceImpl
*)((char*)iface
- FIELD_OFFSET(IDirectDrawSurfaceImpl
, IDirectDrawSurface3_vtbl
));
243 /* Get the number of bytes per pixel for a given surface */
244 #define PFGET_BPP(pf) (pf.dwFlags&DDPF_PALETTEINDEXED8?1:((pf.dwRGBBitCount+7)/8))
245 #define GET_BPP(desc) PFGET_BPP(desc.ddpfPixelFormat)
247 #define DDRAW_INVALID_HANDLE ~0U
249 enum ddraw_handle_type
252 DDRAW_HANDLE_MATERIAL
,
254 DDRAW_HANDLE_STATEBLOCK
,
255 DDRAW_HANDLE_SURFACE
,
258 struct ddraw_handle_entry
261 enum ddraw_handle_type type
;
264 struct ddraw_handle_table
266 struct ddraw_handle_entry
*entries
;
267 struct ddraw_handle_entry
*free_entries
;
272 BOOL
ddraw_handle_table_init(struct ddraw_handle_table
*t
, UINT initial_size
) DECLSPEC_HIDDEN
;
273 void ddraw_handle_table_destroy(struct ddraw_handle_table
*t
) DECLSPEC_HIDDEN
;
274 DWORD
ddraw_allocate_handle(struct ddraw_handle_table
*t
, void *object
, enum ddraw_handle_type type
) DECLSPEC_HIDDEN
;
275 void *ddraw_free_handle(struct ddraw_handle_table
*t
, DWORD handle
, enum ddraw_handle_type type
) DECLSPEC_HIDDEN
;
276 void *ddraw_get_object(struct ddraw_handle_table
*t
, DWORD handle
, enum ddraw_handle_type type
) DECLSPEC_HIDDEN
;
278 struct IDirect3DDeviceImpl
281 const IDirect3DDevice7Vtbl
*lpVtbl
;
282 const IDirect3DDevice3Vtbl
*IDirect3DDevice3_vtbl
;
283 const IDirect3DDevice2Vtbl
*IDirect3DDevice2_vtbl
;
284 const IDirect3DDeviceVtbl
*IDirect3DDevice_vtbl
;
287 /* Other object connections */
288 IWineD3DDevice
*wineD3DDevice
;
289 IDirectDrawImpl
*ddraw
;
290 struct wined3d_buffer
*indexbuffer
;
291 IDirectDrawSurfaceImpl
*target
;
293 /* Viewport management */
294 struct list viewport_list
;
295 IDirect3DViewportImpl
*current_viewport
;
296 D3DVIEWPORT7 active_viewport
;
298 /* Required to keep track which of two available texture blending modes in d3ddevice3 is used */
299 BOOL legacyTextureBlending
;
304 /* Rendering functions to wrap D3D(1-3) to D3D7 */
305 D3DPRIMITIVETYPE primitive_type
;
309 LPBYTE vertex_buffer
;
313 /* Handle management */
314 struct ddraw_handle_table handle_table
;
315 D3DMATRIXHANDLE world
, proj
, view
;
318 HRESULT
d3d_device_init(IDirect3DDeviceImpl
*device
, IDirectDrawImpl
*ddraw
,
319 IDirectDrawSurfaceImpl
*target
) DECLSPEC_HIDDEN
;
322 extern const GUID IID_D3DDEVICE_WineD3D DECLSPEC_HIDDEN
;
324 /* Helper functions */
325 HRESULT
IDirect3DImpl_GetCaps(const struct wined3d
*wined3d
,
326 D3DDEVICEDESC
*Desc123
, D3DDEVICEDESC7
*Desc7
) DECLSPEC_HIDDEN
;
327 WINED3DZBUFFERTYPE
IDirect3DDeviceImpl_UpdateDepthStencil(IDirect3DDeviceImpl
*This
) DECLSPEC_HIDDEN
;
329 static inline IDirect3DDeviceImpl
*device_from_device1(IDirect3DDevice
*iface
)
331 return (IDirect3DDeviceImpl
*)((char*)iface
- FIELD_OFFSET(IDirect3DDeviceImpl
, IDirect3DDevice_vtbl
));
334 static inline IDirect3DDeviceImpl
*device_from_device2(IDirect3DDevice2
*iface
)
336 return (IDirect3DDeviceImpl
*)((char*)iface
- FIELD_OFFSET(IDirect3DDeviceImpl
, IDirect3DDevice2_vtbl
));
339 static inline IDirect3DDeviceImpl
*device_from_device3(IDirect3DDevice3
*iface
)
341 return (IDirect3DDeviceImpl
*)((char*)iface
- FIELD_OFFSET(IDirect3DDeviceImpl
, IDirect3DDevice3_vtbl
));
345 struct EnumTextureFormatsCBS
347 LPD3DENUMTEXTUREFORMATSCALLBACK cbv2
;
348 LPD3DENUMPIXELFORMATSCALLBACK cbv7
;
352 /* Structure for EnumZBufferFormats */
353 struct EnumZBufferFormatsData
355 LPD3DENUMPIXELFORMATSCALLBACK Callback
;
359 /*****************************************************************************
360 * IDirectDrawClipper implementation structure
361 *****************************************************************************/
362 struct IDirectDrawClipperImpl
364 /* IUnknown fields */
365 const IDirectDrawClipperVtbl
*lpVtbl
;
368 struct wined3d_clipper
*wineD3DClipper
;
372 HRESULT
ddraw_clipper_init(IDirectDrawClipperImpl
*clipper
) DECLSPEC_HIDDEN
;
374 /*****************************************************************************
375 * IDirectDrawPalette implementation structure
376 *****************************************************************************/
377 struct IDirectDrawPaletteImpl
379 /* IUnknown fields */
380 const IDirectDrawPaletteVtbl
*lpVtbl
;
383 struct wined3d_palette
*wineD3DPalette
;
385 /* IDirectDrawPalette fields */
386 IUnknown
*ifaceToRelease
;
389 HRESULT
ddraw_palette_init(IDirectDrawPaletteImpl
*palette
,
390 IDirectDrawImpl
*ddraw
, DWORD flags
, PALETTEENTRY
*entries
) DECLSPEC_HIDDEN
;
392 /* Helper structures */
393 struct object_creation_info
396 HRESULT (*pfnCreateInstance
)(IUnknown
*pUnkOuter
, REFIID riid
,
400 /******************************************************************************
401 * IDirect3DLight implementation structure - Wraps to D3D7
402 ******************************************************************************/
403 struct IDirect3DLightImpl
405 const IDirect3DLightVtbl
*lpVtbl
;
408 /* IDirect3DLight fields */
409 IDirectDrawImpl
*ddraw
;
411 /* If this light is active for one viewport, put the viewport here */
412 IDirect3DViewportImpl
*active_viewport
;
422 /* Helper functions */
423 void light_activate(IDirect3DLightImpl
*light
) DECLSPEC_HIDDEN
;
424 void light_deactivate(IDirect3DLightImpl
*light
) DECLSPEC_HIDDEN
;
425 void d3d_light_init(IDirect3DLightImpl
*light
, IDirectDrawImpl
*ddraw
) DECLSPEC_HIDDEN
;
427 /******************************************************************************
428 * IDirect3DMaterial implementation structure - Wraps to D3D7
429 ******************************************************************************/
430 struct IDirect3DMaterialImpl
432 const IDirect3DMaterial3Vtbl
*lpVtbl
;
433 const IDirect3DMaterial2Vtbl
*IDirect3DMaterial2_vtbl
;
434 const IDirect3DMaterialVtbl
*IDirect3DMaterial_vtbl
;
437 /* IDirect3DMaterial2 fields */
438 IDirectDrawImpl
*ddraw
;
439 IDirect3DDeviceImpl
*active_device
;
445 /* Helper functions */
446 void material_activate(IDirect3DMaterialImpl
* This
) DECLSPEC_HIDDEN
;
447 void d3d_material_init(IDirect3DMaterialImpl
*material
, IDirectDrawImpl
*ddraw
) DECLSPEC_HIDDEN
;
449 /*****************************************************************************
450 * IDirect3DViewport - Wraps to D3D7
451 *****************************************************************************/
452 struct IDirect3DViewportImpl
454 const IDirect3DViewport3Vtbl
*lpVtbl
;
457 /* IDirect3DViewport fields */
458 IDirectDrawImpl
*ddraw
;
460 /* If this viewport is active for one device, put the device here */
461 IDirect3DDeviceImpl
*active_device
;
475 struct list light_list
;
477 /* Background material */
478 IDirect3DMaterialImpl
*background
;
481 /* Helper functions */
482 void viewport_activate(IDirect3DViewportImpl
* This
, BOOL ignore_lights
) DECLSPEC_HIDDEN
;
483 void d3d_viewport_init(IDirect3DViewportImpl
*viewport
, IDirectDrawImpl
*ddraw
) DECLSPEC_HIDDEN
;
485 /*****************************************************************************
486 * IDirect3DExecuteBuffer - Wraps to D3D7
487 *****************************************************************************/
488 struct IDirect3DExecuteBufferImpl
491 const IDirect3DExecuteBufferVtbl
*lpVtbl
;
494 /* IDirect3DExecuteBuffer fields */
495 IDirectDrawImpl
*ddraw
;
496 IDirect3DDeviceImpl
*d3ddev
;
498 D3DEXECUTEBUFFERDESC desc
;
501 /* This buffer will store the transformed vertices */
506 /* This flags is set to TRUE if we allocated ourselves the
512 HRESULT
d3d_execute_buffer_init(IDirect3DExecuteBufferImpl
*execute_buffer
,
513 IDirect3DDeviceImpl
*device
, D3DEXECUTEBUFFERDESC
*desc
) DECLSPEC_HIDDEN
;
515 /* The execute function */
516 HRESULT
d3d_execute_buffer_execute(IDirect3DExecuteBufferImpl
*execute_buffer
,
517 IDirect3DDeviceImpl
*device
, IDirect3DViewportImpl
*viewport
) DECLSPEC_HIDDEN
;
519 /*****************************************************************************
520 * IDirect3DVertexBuffer
521 *****************************************************************************/
522 struct IDirect3DVertexBufferImpl
524 /*** IUnknown Methods ***/
525 const IDirect3DVertexBuffer7Vtbl
*lpVtbl
;
526 const IDirect3DVertexBufferVtbl
*IDirect3DVertexBuffer_vtbl
;
529 /*** WineD3D and ddraw links ***/
530 struct wined3d_buffer
*wineD3DVertexBuffer
;
531 struct wined3d_vertex_declaration
*wineD3DVertexDeclaration
;
532 IDirectDrawImpl
*ddraw
;
534 /*** Storage for D3D7 specific things ***/
539 HRESULT
d3d_vertex_buffer_init(IDirect3DVertexBufferImpl
*buffer
,
540 IDirectDrawImpl
*ddraw
, D3DVERTEXBUFFERDESC
*desc
) DECLSPEC_HIDDEN
;
542 static inline IDirect3DVertexBufferImpl
*vb_from_vb1(IDirect3DVertexBuffer
*iface
)
544 return (IDirect3DVertexBufferImpl
*)((char*)iface
545 - FIELD_OFFSET(IDirect3DVertexBufferImpl
, IDirect3DVertexBuffer_vtbl
));
548 /*****************************************************************************
549 * Helper functions from utils.c
550 *****************************************************************************/
552 #define GET_TEXCOUNT_FROM_FVF(d3dvtVertexType) \
553 (((d3dvtVertexType) & D3DFVF_TEXCOUNT_MASK) >> D3DFVF_TEXCOUNT_SHIFT)
555 #define GET_TEXCOORD_SIZE_FROM_FVF(d3dvtVertexType, tex_num) \
556 (((((d3dvtVertexType) >> (16 + (2 * (tex_num)))) + 1) & 0x03) + 1)
558 void PixelFormat_WineD3DtoDD(DDPIXELFORMAT
*DDPixelFormat
, enum wined3d_format_id WineD3DFormat
) DECLSPEC_HIDDEN
;
559 enum wined3d_format_id
PixelFormat_DD2WineD3D(const DDPIXELFORMAT
*DDPixelFormat
) DECLSPEC_HIDDEN
;
560 void DDRAW_dump_surface_desc(const DDSURFACEDESC2
*lpddsd
) DECLSPEC_HIDDEN
;
561 void dump_D3DMATRIX(const D3DMATRIX
*mat
) DECLSPEC_HIDDEN
;
562 void DDRAW_dump_DDCAPS(const DDCAPS
*lpcaps
) DECLSPEC_HIDDEN
;
563 DWORD
get_flexible_vertex_size(DWORD d3dvtVertexType
) DECLSPEC_HIDDEN
;
564 void DDRAW_dump_DDSCAPS2(const DDSCAPS2
*in
) DECLSPEC_HIDDEN
;
565 void DDRAW_dump_cooperativelevel(DWORD cooplevel
) DECLSPEC_HIDDEN
;
567 /* This only needs to be here as long the processvertices functionality of
568 * IDirect3DExecuteBuffer isn't in WineD3D */
569 void multiply_matrix(LPD3DMATRIX dest
, const D3DMATRIX
*src1
, const D3DMATRIX
*src2
) DECLSPEC_HIDDEN
;
571 /* Used for generic dumping */
578 #define FE(x) { x, #x }
584 void (*func
)(const void *);
589 #define ME(x,f,e) { x, #x, (void (*)(const void *))(f), offsetof(STRUCT, e) }
591 #define DD_STRUCT_COPY_BYSIZE(to,from) \
593 DWORD __size = (to)->dwSize; \
594 DWORD __copysize = __size; \
595 DWORD __resetsize = __size; \
596 assert(to != from); \
597 if (__resetsize > sizeof(*to)) \
598 __resetsize = sizeof(*to); \
599 memset(to,0,__resetsize); \
600 if ((from)->dwSize < __size) \
601 __copysize = (from)->dwSize; \
602 memcpy(to,from,__copysize); \
603 (to)->dwSize = __size;/*restore size*/ \
609 HRESULT
hr_ddraw_from_wined3d(HRESULT hr
) DECLSPEC_HIDDEN
;