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 /* Callbacks for implicit object destruction */
55 extern ULONG WINAPI
D3D7CB_DestroySwapChain(IWineD3DSwapChain
*pSwapChain
) DECLSPEC_HIDDEN
;
57 /* Global critical section */
58 extern CRITICAL_SECTION ddraw_cs DECLSPEC_HIDDEN
;
60 extern DWORD force_refresh_rate DECLSPEC_HIDDEN
;
62 /*****************************************************************************
63 * IDirectDraw implementation structure
64 *****************************************************************************/
68 struct wined3d_vertex_declaration
*decl
;
71 struct IDirectDrawImpl
74 IDirectDraw7 IDirectDraw7_iface
;
75 IDirectDraw4 IDirectDraw4_iface
;
76 IDirectDraw3 IDirectDraw3_iface
;
77 IDirectDraw2 IDirectDraw2_iface
;
78 IDirectDraw IDirectDraw_iface
;
79 IDirect3D7 IDirect3D7_iface
;
80 IDirect3D3 IDirect3D3_iface
;
81 IDirect3D2 IDirect3D2_iface
;
82 IDirect3D IDirect3D_iface
;
83 const IWineD3DDeviceParentVtbl
*device_parent_vtbl
;
85 /* See comment in IDirectDraw::AddRef */
86 LONG ref7
, ref4
, ref2
, ref3
, ref1
, numIfaces
;
89 struct wined3d
*wineD3D
;
90 IWineD3DDevice
*wineD3DDevice
;
93 /* Misc ddraw fields */
99 /* DirectDraw things, which are not handled by WineD3D */
100 DWORD cooperative_level
;
102 DWORD orig_width
, orig_height
;
106 IDirectDrawSurfaceImpl
*d3d_target
;
108 IDirect3DDeviceImpl
*d3ddevice
;
116 /* The surface type to request */
117 WINED3DSURFTYPE ImplType
;
119 /* Helpers for surface creation */
120 IDirectDrawSurfaceImpl
*tex_root
;
123 /* For the dll unload cleanup code */
124 struct list ddraw_list_entry
;
125 /* The surface list - can't relay this to WineD3D
128 struct list surface_list
;
132 struct FvfToDecl
*decls
;
133 UINT numConvertedDecls
, declArraySize
;
136 #define DDRAW_WINDOW_CLASS_NAME "ddraw_wc"
138 HRESULT
ddraw_init(IDirectDrawImpl
*ddraw
, WINED3DDEVTYPE device_type
) DECLSPEC_HIDDEN
;
140 /* Helper structures */
141 typedef struct EnumDisplayModesCBS
144 LPDDENUMMODESCALLBACK2 callback
;
145 } EnumDisplayModesCBS
;
147 typedef struct EnumSurfacesCBS
150 LPDDENUMSURFACESCALLBACK7 callback
;
151 LPDDSURFACEDESC2 pDDSD
;
155 /* Utility functions */
156 void DDRAW_Convert_DDSCAPS_1_To_2(const DDSCAPS
*pIn
, DDSCAPS2
*pOut
) DECLSPEC_HIDDEN
;
157 void DDRAW_Convert_DDDEVICEIDENTIFIER_2_To_1(const DDDEVICEIDENTIFIER2
*pIn
, DDDEVICEIDENTIFIER
*pOut
) DECLSPEC_HIDDEN
;
158 HRESULT WINAPI
ddraw_recreate_surfaces_cb(IDirectDrawSurface7
*surf
,
159 DDSURFACEDESC2
*desc
, void *Context
) DECLSPEC_HIDDEN
;
160 struct wined3d_vertex_declaration
*ddraw_find_decl(IDirectDrawImpl
*This
, DWORD fvf
) DECLSPEC_HIDDEN
;
162 /* The default surface type */
163 extern WINED3DSURFTYPE DefaultSurfaceType DECLSPEC_HIDDEN
;
165 /*****************************************************************************
166 * IDirectDrawSurface implementation structure
167 *****************************************************************************/
169 struct IDirectDrawSurfaceImpl
171 /* IUnknown fields */
172 const IDirectDrawSurface7Vtbl
*lpVtbl
;
173 const IDirectDrawSurface3Vtbl
*IDirectDrawSurface3_vtbl
;
174 const IDirectDrawGammaControlVtbl
*IDirectDrawGammaControl_vtbl
;
175 const IDirect3DTexture2Vtbl
*IDirect3DTexture2_vtbl
;
176 const IDirect3DTextureVtbl
*IDirect3DTexture_vtbl
;
179 IUnknown
*ifaceToRelease
;
183 /* Connections to other Objects */
184 IDirectDrawImpl
*ddraw
;
185 IWineD3DSurface
*WineD3DSurface
;
186 struct wined3d_texture
*wined3d_texture
;
187 IWineD3DSwapChain
*wineD3DSwapChain
;
189 /* This implementation handles attaching surfaces to other surfaces */
190 IDirectDrawSurfaceImpl
*next_attached
;
191 IDirectDrawSurfaceImpl
*first_attached
;
193 /* Complex surfaces are organized in a tree, although the tree is degenerated to a list in most cases.
194 * In mipmap and primary surfaces each level has only one attachment, which is the next surface level.
195 * Only the cube texture root has 6 surfaces attached, which then have a normal mipmap chain attached
196 * to them. So hardcode the array to 6, a dynamic array or a list would be an overkill.
198 #define MAX_COMPLEX_ATTACHED 6
199 IDirectDrawSurfaceImpl
*complex_array
[MAX_COMPLEX_ATTACHED
];
200 /* You can't traverse the tree upwards. Only a flag for Surface::Release because its needed there,
201 * but no pointer to prevent temptations to traverse it in the wrong direction.
203 BOOL is_complex_root
;
205 /* Surface description, for GetAttachedSurface */
206 DDSURFACEDESC2 surface_desc
;
209 DWORD uniqueness_value
;
211 WINED3DSURFTYPE ImplType
;
213 /* For D3DDevice creation */
216 /* Clipper objects */
217 IDirectDrawClipperImpl
*clipper
;
219 /* For the ddraw surface list */
220 struct list surface_list_entry
;
225 void ddraw_surface_destroy(IDirectDrawSurfaceImpl
*surface
) DECLSPEC_HIDDEN
;
226 HRESULT
ddraw_surface_init(IDirectDrawSurfaceImpl
*surface
, IDirectDrawImpl
*ddraw
,
227 DDSURFACEDESC2
*desc
, UINT mip_level
, WINED3DSURFTYPE surface_type
) DECLSPEC_HIDDEN
;
229 static inline IDirectDrawSurfaceImpl
*surface_from_texture1(IDirect3DTexture
*iface
)
231 return (IDirectDrawSurfaceImpl
*)((char*)iface
- FIELD_OFFSET(IDirectDrawSurfaceImpl
, IDirect3DTexture_vtbl
));
234 static inline IDirectDrawSurfaceImpl
*surface_from_texture2(IDirect3DTexture2
*iface
)
236 return (IDirectDrawSurfaceImpl
*)((char*)iface
- FIELD_OFFSET(IDirectDrawSurfaceImpl
, IDirect3DTexture2_vtbl
));
239 static inline IDirectDrawSurfaceImpl
*surface_from_surface3(IDirectDrawSurface3
*iface
)
241 return (IDirectDrawSurfaceImpl
*)((char*)iface
- FIELD_OFFSET(IDirectDrawSurfaceImpl
, IDirectDrawSurface3_vtbl
));
244 /* Get the number of bytes per pixel for a given surface */
245 #define PFGET_BPP(pf) (pf.dwFlags&DDPF_PALETTEINDEXED8?1:((pf.dwRGBBitCount+7)/8))
246 #define GET_BPP(desc) PFGET_BPP(desc.ddpfPixelFormat)
248 #define DDRAW_INVALID_HANDLE ~0U
250 enum ddraw_handle_type
253 DDRAW_HANDLE_MATERIAL
,
255 DDRAW_HANDLE_STATEBLOCK
,
256 DDRAW_HANDLE_SURFACE
,
259 struct ddraw_handle_entry
262 enum ddraw_handle_type type
;
265 struct ddraw_handle_table
267 struct ddraw_handle_entry
*entries
;
268 struct ddraw_handle_entry
*free_entries
;
273 BOOL
ddraw_handle_table_init(struct ddraw_handle_table
*t
, UINT initial_size
) DECLSPEC_HIDDEN
;
274 void ddraw_handle_table_destroy(struct ddraw_handle_table
*t
) DECLSPEC_HIDDEN
;
275 DWORD
ddraw_allocate_handle(struct ddraw_handle_table
*t
, void *object
, enum ddraw_handle_type type
) DECLSPEC_HIDDEN
;
276 void *ddraw_free_handle(struct ddraw_handle_table
*t
, DWORD handle
, enum ddraw_handle_type type
) DECLSPEC_HIDDEN
;
277 void *ddraw_get_object(struct ddraw_handle_table
*t
, DWORD handle
, enum ddraw_handle_type type
) DECLSPEC_HIDDEN
;
279 struct IDirect3DDeviceImpl
282 const IDirect3DDevice7Vtbl
*lpVtbl
;
283 const IDirect3DDevice3Vtbl
*IDirect3DDevice3_vtbl
;
284 const IDirect3DDevice2Vtbl
*IDirect3DDevice2_vtbl
;
285 const IDirect3DDeviceVtbl
*IDirect3DDevice_vtbl
;
288 /* Other object connections */
289 IWineD3DDevice
*wineD3DDevice
;
290 IDirectDrawImpl
*ddraw
;
291 struct wined3d_buffer
*indexbuffer
;
292 IDirectDrawSurfaceImpl
*target
;
294 /* Viewport management */
295 IDirect3DViewportImpl
*viewport_list
;
296 IDirect3DViewportImpl
*current_viewport
;
297 D3DVIEWPORT7 active_viewport
;
299 /* Required to keep track which of two available texture blending modes in d3ddevice3 is used */
300 BOOL legacyTextureBlending
;
305 /* Rendering functions to wrap D3D(1-3) to D3D7 */
306 D3DPRIMITIVETYPE primitive_type
;
310 LPBYTE vertex_buffer
;
314 /* Handle management */
315 struct ddraw_handle_table handle_table
;
316 D3DMATRIXHANDLE world
, proj
, view
;
319 HRESULT
d3d_device_init(IDirect3DDeviceImpl
*device
, IDirectDrawImpl
*ddraw
,
320 IDirectDrawSurfaceImpl
*target
) DECLSPEC_HIDDEN
;
323 extern const GUID IID_D3DDEVICE_WineD3D DECLSPEC_HIDDEN
;
325 /* Helper functions */
326 HRESULT
IDirect3DImpl_GetCaps(const struct wined3d
*wined3d
,
327 D3DDEVICEDESC
*Desc123
, D3DDEVICEDESC7
*Desc7
) DECLSPEC_HIDDEN
;
328 WINED3DZBUFFERTYPE
IDirect3DDeviceImpl_UpdateDepthStencil(IDirect3DDeviceImpl
*This
) DECLSPEC_HIDDEN
;
330 static inline IDirect3DDeviceImpl
*device_from_device1(IDirect3DDevice
*iface
)
332 return (IDirect3DDeviceImpl
*)((char*)iface
- FIELD_OFFSET(IDirect3DDeviceImpl
, IDirect3DDevice_vtbl
));
335 static inline IDirect3DDeviceImpl
*device_from_device2(IDirect3DDevice2
*iface
)
337 return (IDirect3DDeviceImpl
*)((char*)iface
- FIELD_OFFSET(IDirect3DDeviceImpl
, IDirect3DDevice2_vtbl
));
340 static inline IDirect3DDeviceImpl
*device_from_device3(IDirect3DDevice3
*iface
)
342 return (IDirect3DDeviceImpl
*)((char*)iface
- FIELD_OFFSET(IDirect3DDeviceImpl
, IDirect3DDevice3_vtbl
));
346 struct EnumTextureFormatsCBS
348 LPD3DENUMTEXTUREFORMATSCALLBACK cbv2
;
349 LPD3DENUMPIXELFORMATSCALLBACK cbv7
;
353 /* Structure for EnumZBufferFormats */
354 struct EnumZBufferFormatsData
356 LPD3DENUMPIXELFORMATSCALLBACK Callback
;
360 /*****************************************************************************
361 * IDirectDrawClipper implementation structure
362 *****************************************************************************/
363 struct IDirectDrawClipperImpl
365 /* IUnknown fields */
366 const IDirectDrawClipperVtbl
*lpVtbl
;
369 struct wined3d_clipper
*wineD3DClipper
;
373 HRESULT
ddraw_clipper_init(IDirectDrawClipperImpl
*clipper
) DECLSPEC_HIDDEN
;
375 /*****************************************************************************
376 * IDirectDrawPalette implementation structure
377 *****************************************************************************/
378 struct IDirectDrawPaletteImpl
380 /* IUnknown fields */
381 const IDirectDrawPaletteVtbl
*lpVtbl
;
384 struct wined3d_palette
*wineD3DPalette
;
386 /* IDirectDrawPalette fields */
387 IUnknown
*ifaceToRelease
;
390 HRESULT
ddraw_palette_init(IDirectDrawPaletteImpl
*palette
,
391 IDirectDrawImpl
*ddraw
, DWORD flags
, PALETTEENTRY
*entries
) DECLSPEC_HIDDEN
;
393 /* Helper structures */
394 struct object_creation_info
397 HRESULT (*pfnCreateInstance
)(IUnknown
*pUnkOuter
, REFIID riid
,
401 /******************************************************************************
402 * IDirect3DLight implementation structure - Wraps to D3D7
403 ******************************************************************************/
404 struct IDirect3DLightImpl
406 const IDirect3DLightVtbl
*lpVtbl
;
409 /* IDirect3DLight fields */
410 IDirectDrawImpl
*ddraw
;
412 /* If this light is active for one viewport, put the viewport here */
413 IDirect3DViewportImpl
*active_viewport
;
420 /* Chained list used for adding / removing from viewports */
421 IDirect3DLightImpl
*next
;
424 /* Helper functions */
425 void light_activate(IDirect3DLightImpl
*light
) DECLSPEC_HIDDEN
;
426 void light_deactivate(IDirect3DLightImpl
*light
) DECLSPEC_HIDDEN
;
427 void d3d_light_init(IDirect3DLightImpl
*light
, IDirectDrawImpl
*ddraw
) DECLSPEC_HIDDEN
;
429 /******************************************************************************
430 * IDirect3DMaterial implementation structure - Wraps to D3D7
431 ******************************************************************************/
432 struct IDirect3DMaterialImpl
434 const IDirect3DMaterial3Vtbl
*lpVtbl
;
435 const IDirect3DMaterial2Vtbl
*IDirect3DMaterial2_vtbl
;
436 const IDirect3DMaterialVtbl
*IDirect3DMaterial_vtbl
;
439 /* IDirect3DMaterial2 fields */
440 IDirectDrawImpl
*ddraw
;
441 IDirect3DDeviceImpl
*active_device
;
447 /* Helper functions */
448 void material_activate(IDirect3DMaterialImpl
* This
) DECLSPEC_HIDDEN
;
449 void d3d_material_init(IDirect3DMaterialImpl
*material
, IDirectDrawImpl
*ddraw
) DECLSPEC_HIDDEN
;
451 /*****************************************************************************
452 * IDirect3DViewport - Wraps to D3D7
453 *****************************************************************************/
454 struct IDirect3DViewportImpl
456 const IDirect3DViewport3Vtbl
*lpVtbl
;
459 /* IDirect3DViewport fields */
460 IDirectDrawImpl
*ddraw
;
462 /* If this viewport is active for one device, put the device here */
463 IDirect3DDeviceImpl
*active_device
;
476 /* Field used to chain viewports together */
477 IDirect3DViewportImpl
*next
;
480 IDirect3DLightImpl
*lights
;
482 /* Background material */
483 IDirect3DMaterialImpl
*background
;
486 /* Helper functions */
487 void viewport_activate(IDirect3DViewportImpl
* This
, BOOL ignore_lights
) DECLSPEC_HIDDEN
;
488 void d3d_viewport_init(IDirect3DViewportImpl
*viewport
, IDirectDrawImpl
*ddraw
) DECLSPEC_HIDDEN
;
490 /*****************************************************************************
491 * IDirect3DExecuteBuffer - Wraps to D3D7
492 *****************************************************************************/
493 struct IDirect3DExecuteBufferImpl
496 const IDirect3DExecuteBufferVtbl
*lpVtbl
;
499 /* IDirect3DExecuteBuffer fields */
500 IDirectDrawImpl
*ddraw
;
501 IDirect3DDeviceImpl
*d3ddev
;
503 D3DEXECUTEBUFFERDESC desc
;
506 /* This buffer will store the transformed vertices */
511 /* This flags is set to TRUE if we allocated ourselves the
517 HRESULT
d3d_execute_buffer_init(IDirect3DExecuteBufferImpl
*execute_buffer
,
518 IDirect3DDeviceImpl
*device
, D3DEXECUTEBUFFERDESC
*desc
) DECLSPEC_HIDDEN
;
520 /* The execute function */
521 void IDirect3DExecuteBufferImpl_Execute(IDirect3DExecuteBufferImpl
*This
,
522 IDirect3DDeviceImpl
*Device
, IDirect3DViewportImpl
*ViewportImpl
) DECLSPEC_HIDDEN
;
524 /*****************************************************************************
525 * IDirect3DVertexBuffer
526 *****************************************************************************/
527 struct IDirect3DVertexBufferImpl
529 /*** IUnknown Methods ***/
530 const IDirect3DVertexBuffer7Vtbl
*lpVtbl
;
531 const IDirect3DVertexBufferVtbl
*IDirect3DVertexBuffer_vtbl
;
534 /*** WineD3D and ddraw links ***/
535 struct wined3d_buffer
*wineD3DVertexBuffer
;
536 struct wined3d_vertex_declaration
*wineD3DVertexDeclaration
;
537 IDirectDrawImpl
*ddraw
;
539 /*** Storage for D3D7 specific things ***/
544 HRESULT
d3d_vertex_buffer_init(IDirect3DVertexBufferImpl
*buffer
,
545 IDirectDrawImpl
*ddraw
, D3DVERTEXBUFFERDESC
*desc
) DECLSPEC_HIDDEN
;
547 static inline IDirect3DVertexBufferImpl
*vb_from_vb1(IDirect3DVertexBuffer
*iface
)
549 return (IDirect3DVertexBufferImpl
*)((char*)iface
550 - FIELD_OFFSET(IDirect3DVertexBufferImpl
, IDirect3DVertexBuffer_vtbl
));
553 /*****************************************************************************
554 * Helper functions from utils.c
555 *****************************************************************************/
557 #define GET_TEXCOUNT_FROM_FVF(d3dvtVertexType) \
558 (((d3dvtVertexType) & D3DFVF_TEXCOUNT_MASK) >> D3DFVF_TEXCOUNT_SHIFT)
560 #define GET_TEXCOORD_SIZE_FROM_FVF(d3dvtVertexType, tex_num) \
561 (((((d3dvtVertexType) >> (16 + (2 * (tex_num)))) + 1) & 0x03) + 1)
563 void PixelFormat_WineD3DtoDD(DDPIXELFORMAT
*DDPixelFormat
, enum wined3d_format_id WineD3DFormat
) DECLSPEC_HIDDEN
;
564 enum wined3d_format_id
PixelFormat_DD2WineD3D(const DDPIXELFORMAT
*DDPixelFormat
) DECLSPEC_HIDDEN
;
565 void DDRAW_dump_surface_desc(const DDSURFACEDESC2
*lpddsd
) DECLSPEC_HIDDEN
;
566 void dump_D3DMATRIX(const D3DMATRIX
*mat
) DECLSPEC_HIDDEN
;
567 void DDRAW_dump_DDCAPS(const DDCAPS
*lpcaps
) DECLSPEC_HIDDEN
;
568 DWORD
get_flexible_vertex_size(DWORD d3dvtVertexType
) DECLSPEC_HIDDEN
;
569 void DDRAW_dump_DDSCAPS2(const DDSCAPS2
*in
) DECLSPEC_HIDDEN
;
570 void DDRAW_dump_cooperativelevel(DWORD cooplevel
) DECLSPEC_HIDDEN
;
572 /* This only needs to be here as long the processvertices functionality of
573 * IDirect3DExecuteBuffer isn't in WineD3D */
574 void multiply_matrix(LPD3DMATRIX dest
, const D3DMATRIX
*src1
, const D3DMATRIX
*src2
) DECLSPEC_HIDDEN
;
576 /* Used for generic dumping */
583 #define FE(x) { x, #x }
589 void (*func
)(const void *);
594 #define ME(x,f,e) { x, #x, (void (*)(const void *))(f), offsetof(STRUCT, e) }
596 #define DD_STRUCT_COPY_BYSIZE(to,from) \
598 DWORD __size = (to)->dwSize; \
599 DWORD __copysize = __size; \
600 DWORD __resetsize = __size; \
601 assert(to != from); \
602 if (__resetsize > sizeof(*to)) \
603 __resetsize = sizeof(*to); \
604 memset(to,0,__resetsize); \
605 if ((from)->dwSize < __size) \
606 __copysize = (from)->dwSize; \
607 memcpy(to,from,__copysize); \
608 (to)->dwSize = __size;/*restore size*/ \
614 HRESULT
hr_ddraw_from_wined3d(HRESULT hr
) DECLSPEC_HIDDEN
;