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 const IDirectDrawGammaControlVtbl
*IDirectDrawGammaControl_vtbl
;
159 const IDirect3DTexture2Vtbl
*IDirect3DTexture2_vtbl
;
160 const IDirect3DTextureVtbl
*IDirect3DTexture_vtbl
;
163 IUnknown
*ifaceToRelease
;
167 /* Connections to other Objects */
168 IDirectDrawImpl
*ddraw
;
169 struct wined3d_surface
*wined3d_surface
;
170 struct wined3d_texture
*wined3d_texture
;
171 struct wined3d_swapchain
*wined3d_swapchain
;
173 /* This implementation handles attaching surfaces to other surfaces */
174 IDirectDrawSurfaceImpl
*next_attached
;
175 IDirectDrawSurfaceImpl
*first_attached
;
177 /* Complex surfaces are organized in a tree, although the tree is degenerated to a list in most cases.
178 * In mipmap and primary surfaces each level has only one attachment, which is the next surface level.
179 * Only the cube texture root has 6 surfaces attached, which then have a normal mipmap chain attached
180 * to them. So hardcode the array to 6, a dynamic array or a list would be an overkill.
182 #define MAX_COMPLEX_ATTACHED 6
183 IDirectDrawSurfaceImpl
*complex_array
[MAX_COMPLEX_ATTACHED
];
184 /* You can't traverse the tree upwards. Only a flag for Surface::Release because its needed there,
185 * but no pointer to prevent temptations to traverse it in the wrong direction.
187 BOOL is_complex_root
;
189 /* Surface description, for GetAttachedSurface */
190 DDSURFACEDESC2 surface_desc
;
193 DWORD uniqueness_value
;
195 WINED3DSURFTYPE ImplType
;
197 /* For D3DDevice creation */
200 /* Clipper objects */
201 IDirectDrawClipperImpl
*clipper
;
203 /* For the ddraw surface list */
204 struct list surface_list_entry
;
209 HRESULT
ddraw_surface_create_texture(IDirectDrawSurfaceImpl
*surface
) DECLSPEC_HIDDEN
;
210 void ddraw_surface_destroy(IDirectDrawSurfaceImpl
*surface
) DECLSPEC_HIDDEN
;
211 HRESULT
ddraw_surface_init(IDirectDrawSurfaceImpl
*surface
, IDirectDrawImpl
*ddraw
,
212 DDSURFACEDESC2
*desc
, UINT mip_level
, WINED3DSURFTYPE surface_type
) DECLSPEC_HIDDEN
;
214 static inline IDirectDrawSurfaceImpl
*surface_from_texture1(IDirect3DTexture
*iface
)
216 return (IDirectDrawSurfaceImpl
*)((char*)iface
- FIELD_OFFSET(IDirectDrawSurfaceImpl
, IDirect3DTexture_vtbl
));
219 static inline IDirectDrawSurfaceImpl
*surface_from_texture2(IDirect3DTexture2
*iface
)
221 return (IDirectDrawSurfaceImpl
*)((char*)iface
- FIELD_OFFSET(IDirectDrawSurfaceImpl
, IDirect3DTexture2_vtbl
));
224 static inline IDirectDrawSurfaceImpl
*impl_from_IDirectDrawSurface3(IDirectDrawSurface3
*iface
)
226 return CONTAINING_RECORD(iface
, IDirectDrawSurfaceImpl
, IDirectDrawSurface3_iface
);
229 static inline IDirectDrawSurfaceImpl
*impl_from_IDirectDrawSurface4(IDirectDrawSurface4
*iface
)
231 return CONTAINING_RECORD(iface
, IDirectDrawSurfaceImpl
, IDirectDrawSurface4_iface
);
234 static inline IDirectDrawSurfaceImpl
*impl_from_IDirectDrawSurface7(IDirectDrawSurface7
*iface
)
236 return CONTAINING_RECORD(iface
, IDirectDrawSurfaceImpl
, IDirectDrawSurface7_iface
);
239 IDirectDrawSurfaceImpl
*unsafe_impl_from_IDirectDrawSurface3(IDirectDrawSurface3
*iface
) DECLSPEC_HIDDEN
;
240 IDirectDrawSurfaceImpl
*unsafe_impl_from_IDirectDrawSurface4(IDirectDrawSurface4
*iface
) DECLSPEC_HIDDEN
;
241 IDirectDrawSurfaceImpl
*unsafe_impl_from_IDirectDrawSurface7(IDirectDrawSurface7
*iface
) DECLSPEC_HIDDEN
;
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 struct wined3d_device
*wined3d_device
;
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
));
344 /*****************************************************************************
345 * IDirectDrawClipper implementation structure
346 *****************************************************************************/
347 struct IDirectDrawClipperImpl
349 /* IUnknown fields */
350 const IDirectDrawClipperVtbl
*lpVtbl
;
353 struct wined3d_clipper
*wineD3DClipper
;
357 HRESULT
ddraw_clipper_init(IDirectDrawClipperImpl
*clipper
) DECLSPEC_HIDDEN
;
359 /*****************************************************************************
360 * IDirectDrawPalette implementation structure
361 *****************************************************************************/
362 struct IDirectDrawPaletteImpl
364 /* IUnknown fields */
365 const IDirectDrawPaletteVtbl
*lpVtbl
;
368 struct wined3d_palette
*wineD3DPalette
;
370 /* IDirectDrawPalette fields */
371 IUnknown
*ifaceToRelease
;
374 HRESULT
ddraw_palette_init(IDirectDrawPaletteImpl
*palette
,
375 IDirectDrawImpl
*ddraw
, DWORD flags
, PALETTEENTRY
*entries
) DECLSPEC_HIDDEN
;
377 /* Helper structures */
378 struct object_creation_info
381 HRESULT (*pfnCreateInstance
)(IUnknown
*pUnkOuter
, REFIID riid
,
385 /******************************************************************************
386 * IDirect3DLight implementation structure - Wraps to D3D7
387 ******************************************************************************/
388 struct IDirect3DLightImpl
390 const IDirect3DLightVtbl
*lpVtbl
;
393 /* IDirect3DLight fields */
394 IDirectDrawImpl
*ddraw
;
396 /* If this light is active for one viewport, put the viewport here */
397 IDirect3DViewportImpl
*active_viewport
;
407 /* Helper functions */
408 void light_activate(IDirect3DLightImpl
*light
) DECLSPEC_HIDDEN
;
409 void light_deactivate(IDirect3DLightImpl
*light
) DECLSPEC_HIDDEN
;
410 void d3d_light_init(IDirect3DLightImpl
*light
, IDirectDrawImpl
*ddraw
) DECLSPEC_HIDDEN
;
412 /******************************************************************************
413 * IDirect3DMaterial implementation structure - Wraps to D3D7
414 ******************************************************************************/
415 struct IDirect3DMaterialImpl
417 const IDirect3DMaterial3Vtbl
*lpVtbl
;
418 const IDirect3DMaterial2Vtbl
*IDirect3DMaterial2_vtbl
;
419 const IDirect3DMaterialVtbl
*IDirect3DMaterial_vtbl
;
422 /* IDirect3DMaterial2 fields */
423 IDirectDrawImpl
*ddraw
;
424 IDirect3DDeviceImpl
*active_device
;
430 /* Helper functions */
431 void material_activate(IDirect3DMaterialImpl
* This
) DECLSPEC_HIDDEN
;
432 void d3d_material_init(IDirect3DMaterialImpl
*material
, IDirectDrawImpl
*ddraw
) DECLSPEC_HIDDEN
;
434 /*****************************************************************************
435 * IDirect3DViewport - Wraps to D3D7
436 *****************************************************************************/
437 struct IDirect3DViewportImpl
439 const IDirect3DViewport3Vtbl
*lpVtbl
;
442 /* IDirect3DViewport fields */
443 IDirectDrawImpl
*ddraw
;
445 /* If this viewport is active for one device, put the device here */
446 IDirect3DDeviceImpl
*active_device
;
460 struct list light_list
;
462 /* Background material */
463 IDirect3DMaterialImpl
*background
;
466 /* Helper functions */
467 void viewport_activate(IDirect3DViewportImpl
* This
, BOOL ignore_lights
) DECLSPEC_HIDDEN
;
468 void d3d_viewport_init(IDirect3DViewportImpl
*viewport
, IDirectDrawImpl
*ddraw
) DECLSPEC_HIDDEN
;
470 /*****************************************************************************
471 * IDirect3DExecuteBuffer - Wraps to D3D7
472 *****************************************************************************/
473 struct IDirect3DExecuteBufferImpl
476 const IDirect3DExecuteBufferVtbl
*lpVtbl
;
479 /* IDirect3DExecuteBuffer fields */
480 IDirectDrawImpl
*ddraw
;
481 IDirect3DDeviceImpl
*d3ddev
;
483 D3DEXECUTEBUFFERDESC desc
;
486 /* This buffer will store the transformed vertices */
491 /* This flags is set to TRUE if we allocated ourselves the
497 HRESULT
d3d_execute_buffer_init(IDirect3DExecuteBufferImpl
*execute_buffer
,
498 IDirect3DDeviceImpl
*device
, D3DEXECUTEBUFFERDESC
*desc
) DECLSPEC_HIDDEN
;
500 /* The execute function */
501 HRESULT
d3d_execute_buffer_execute(IDirect3DExecuteBufferImpl
*execute_buffer
,
502 IDirect3DDeviceImpl
*device
, IDirect3DViewportImpl
*viewport
) DECLSPEC_HIDDEN
;
504 /*****************************************************************************
505 * IDirect3DVertexBuffer
506 *****************************************************************************/
507 struct IDirect3DVertexBufferImpl
509 /*** IUnknown Methods ***/
510 const IDirect3DVertexBuffer7Vtbl
*lpVtbl
;
511 const IDirect3DVertexBufferVtbl
*IDirect3DVertexBuffer_vtbl
;
514 /*** WineD3D and ddraw links ***/
515 struct wined3d_buffer
*wineD3DVertexBuffer
;
516 struct wined3d_vertex_declaration
*wineD3DVertexDeclaration
;
517 IDirectDrawImpl
*ddraw
;
519 /*** Storage for D3D7 specific things ***/
524 HRESULT
d3d_vertex_buffer_init(IDirect3DVertexBufferImpl
*buffer
,
525 IDirectDrawImpl
*ddraw
, D3DVERTEXBUFFERDESC
*desc
) DECLSPEC_HIDDEN
;
527 static inline IDirect3DVertexBufferImpl
*vb_from_vb1(IDirect3DVertexBuffer
*iface
)
529 return (IDirect3DVertexBufferImpl
*)((char*)iface
530 - FIELD_OFFSET(IDirect3DVertexBufferImpl
, IDirect3DVertexBuffer_vtbl
));
533 /*****************************************************************************
534 * Helper functions from utils.c
535 *****************************************************************************/
537 #define GET_TEXCOUNT_FROM_FVF(d3dvtVertexType) \
538 (((d3dvtVertexType) & D3DFVF_TEXCOUNT_MASK) >> D3DFVF_TEXCOUNT_SHIFT)
540 #define GET_TEXCOORD_SIZE_FROM_FVF(d3dvtVertexType, tex_num) \
541 (((((d3dvtVertexType) >> (16 + (2 * (tex_num)))) + 1) & 0x03) + 1)
543 void PixelFormat_WineD3DtoDD(DDPIXELFORMAT
*DDPixelFormat
, enum wined3d_format_id WineD3DFormat
) DECLSPEC_HIDDEN
;
544 enum wined3d_format_id
PixelFormat_DD2WineD3D(const DDPIXELFORMAT
*DDPixelFormat
) DECLSPEC_HIDDEN
;
545 void DDRAW_dump_surface_desc(const DDSURFACEDESC2
*lpddsd
) DECLSPEC_HIDDEN
;
546 void dump_D3DMATRIX(const D3DMATRIX
*mat
) DECLSPEC_HIDDEN
;
547 void DDRAW_dump_DDCAPS(const DDCAPS
*lpcaps
) DECLSPEC_HIDDEN
;
548 DWORD
get_flexible_vertex_size(DWORD d3dvtVertexType
) DECLSPEC_HIDDEN
;
549 void DDRAW_dump_DDSCAPS2(const DDSCAPS2
*in
) DECLSPEC_HIDDEN
;
550 void DDRAW_dump_cooperativelevel(DWORD cooplevel
) DECLSPEC_HIDDEN
;
552 /* This only needs to be here as long the processvertices functionality of
553 * IDirect3DExecuteBuffer isn't in WineD3D */
554 void multiply_matrix(LPD3DMATRIX dest
, const D3DMATRIX
*src1
, const D3DMATRIX
*src2
) DECLSPEC_HIDDEN
;
556 /* Used for generic dumping */
563 #define FE(x) { x, #x }
569 void (*func
)(const void *);
574 #define ME(x,f,e) { x, #x, (void (*)(const void *))(f), offsetof(STRUCT, e) }
576 #define DD_STRUCT_COPY_BYSIZE_(to,from,from_size) \
578 DWORD __size = (to)->dwSize; \
579 DWORD __copysize = min(__size, from_size); \
580 assert(to != from); \
581 memcpy(to, from, __copysize); \
582 memset((char*)(to) + __copysize, 0, __size - __copysize); \
583 (to)->dwSize = __size; /* restore size */ \
586 #define DD_STRUCT_COPY_BYSIZE(to,from) DD_STRUCT_COPY_BYSIZE_(to,from,(from)->dwSize)
588 #define SIZEOF_END_PADDING(type, last_field) \
589 (sizeof(type) - offsetof(type, last_field) - sizeof(((type *)0)->last_field))
591 static inline void copy_to_surfacedesc2(DDSURFACEDESC2
*to
, DDSURFACEDESC2
*from
)
593 DWORD from_size
= from
->dwSize
;
594 if (from_size
== sizeof(DDSURFACEDESC
))
595 from_size
-= SIZEOF_END_PADDING(DDSURFACEDESC
, ddsCaps
);
596 to
->dwSize
= sizeof(DDSURFACEDESC2
); /* for struct copy */
597 DD_STRUCT_COPY_BYSIZE_(to
, from
, from_size
);
600 HRESULT
hr_ddraw_from_wined3d(HRESULT hr
) DECLSPEC_HIDDEN
;