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 const IDirectDrawSurface7Vtbl
*lpVtbl
;
156 IDirectDrawSurface3 IDirectDrawSurface3_iface
;
157 const IDirectDrawGammaControlVtbl
*IDirectDrawGammaControl_vtbl
;
158 const IDirect3DTexture2Vtbl
*IDirect3DTexture2_vtbl
;
159 const IDirect3DTextureVtbl
*IDirect3DTexture_vtbl
;
162 IUnknown
*ifaceToRelease
;
166 /* Connections to other Objects */
167 IDirectDrawImpl
*ddraw
;
168 struct wined3d_surface
*wined3d_surface
;
169 struct wined3d_texture
*wined3d_texture
;
170 struct wined3d_swapchain
*wined3d_swapchain
;
172 /* This implementation handles attaching surfaces to other surfaces */
173 IDirectDrawSurfaceImpl
*next_attached
;
174 IDirectDrawSurfaceImpl
*first_attached
;
176 /* Complex surfaces are organized in a tree, although the tree is degenerated to a list in most cases.
177 * In mipmap and primary surfaces each level has only one attachment, which is the next surface level.
178 * Only the cube texture root has 6 surfaces attached, which then have a normal mipmap chain attached
179 * to them. So hardcode the array to 6, a dynamic array or a list would be an overkill.
181 #define MAX_COMPLEX_ATTACHED 6
182 IDirectDrawSurfaceImpl
*complex_array
[MAX_COMPLEX_ATTACHED
];
183 /* You can't traverse the tree upwards. Only a flag for Surface::Release because its needed there,
184 * but no pointer to prevent temptations to traverse it in the wrong direction.
186 BOOL is_complex_root
;
188 /* Surface description, for GetAttachedSurface */
189 DDSURFACEDESC2 surface_desc
;
192 DWORD uniqueness_value
;
194 WINED3DSURFTYPE ImplType
;
196 /* For D3DDevice creation */
199 /* Clipper objects */
200 IDirectDrawClipperImpl
*clipper
;
202 /* For the ddraw surface list */
203 struct list surface_list_entry
;
208 HRESULT
ddraw_surface_create_texture(IDirectDrawSurfaceImpl
*surface
) DECLSPEC_HIDDEN
;
209 void ddraw_surface_destroy(IDirectDrawSurfaceImpl
*surface
) DECLSPEC_HIDDEN
;
210 HRESULT
ddraw_surface_init(IDirectDrawSurfaceImpl
*surface
, IDirectDrawImpl
*ddraw
,
211 DDSURFACEDESC2
*desc
, UINT mip_level
, WINED3DSURFTYPE surface_type
) DECLSPEC_HIDDEN
;
213 static inline IDirectDrawSurfaceImpl
*surface_from_texture1(IDirect3DTexture
*iface
)
215 return (IDirectDrawSurfaceImpl
*)((char*)iface
- FIELD_OFFSET(IDirectDrawSurfaceImpl
, IDirect3DTexture_vtbl
));
218 static inline IDirectDrawSurfaceImpl
*surface_from_texture2(IDirect3DTexture2
*iface
)
220 return (IDirectDrawSurfaceImpl
*)((char*)iface
- FIELD_OFFSET(IDirectDrawSurfaceImpl
, IDirect3DTexture2_vtbl
));
223 static inline IDirectDrawSurfaceImpl
*impl_from_IDirectDrawSurface3(IDirectDrawSurface3
*iface
)
225 return CONTAINING_RECORD(iface
, IDirectDrawSurfaceImpl
, IDirectDrawSurface3_iface
);
228 IDirectDrawSurfaceImpl
*unsafe_impl_from_IDirectDrawSurface3(IDirectDrawSurface3
*iface
) DECLSPEC_HIDDEN
;
230 /* Get the number of bytes per pixel for a given surface */
231 #define PFGET_BPP(pf) (pf.dwFlags&DDPF_PALETTEINDEXED8?1:((pf.dwRGBBitCount+7)/8))
232 #define GET_BPP(desc) PFGET_BPP(desc.ddpfPixelFormat)
234 #define DDRAW_INVALID_HANDLE ~0U
236 enum ddraw_handle_type
239 DDRAW_HANDLE_MATERIAL
,
241 DDRAW_HANDLE_STATEBLOCK
,
242 DDRAW_HANDLE_SURFACE
,
245 struct ddraw_handle_entry
248 enum ddraw_handle_type type
;
251 struct ddraw_handle_table
253 struct ddraw_handle_entry
*entries
;
254 struct ddraw_handle_entry
*free_entries
;
259 BOOL
ddraw_handle_table_init(struct ddraw_handle_table
*t
, UINT initial_size
) DECLSPEC_HIDDEN
;
260 void ddraw_handle_table_destroy(struct ddraw_handle_table
*t
) DECLSPEC_HIDDEN
;
261 DWORD
ddraw_allocate_handle(struct ddraw_handle_table
*t
, void *object
, enum ddraw_handle_type type
) DECLSPEC_HIDDEN
;
262 void *ddraw_free_handle(struct ddraw_handle_table
*t
, DWORD handle
, enum ddraw_handle_type type
) DECLSPEC_HIDDEN
;
263 void *ddraw_get_object(struct ddraw_handle_table
*t
, DWORD handle
, enum ddraw_handle_type type
) DECLSPEC_HIDDEN
;
265 struct IDirect3DDeviceImpl
268 const IDirect3DDevice7Vtbl
*lpVtbl
;
269 const IDirect3DDevice3Vtbl
*IDirect3DDevice3_vtbl
;
270 const IDirect3DDevice2Vtbl
*IDirect3DDevice2_vtbl
;
271 const IDirect3DDeviceVtbl
*IDirect3DDevice_vtbl
;
274 /* Other object connections */
275 struct wined3d_device
*wined3d_device
;
276 IDirectDrawImpl
*ddraw
;
277 struct wined3d_buffer
*indexbuffer
;
278 IDirectDrawSurfaceImpl
*target
;
280 /* Viewport management */
281 struct list viewport_list
;
282 IDirect3DViewportImpl
*current_viewport
;
283 D3DVIEWPORT7 active_viewport
;
285 /* Required to keep track which of two available texture blending modes in d3ddevice3 is used */
286 BOOL legacyTextureBlending
;
291 /* Rendering functions to wrap D3D(1-3) to D3D7 */
292 D3DPRIMITIVETYPE primitive_type
;
296 LPBYTE vertex_buffer
;
300 /* Handle management */
301 struct ddraw_handle_table handle_table
;
302 D3DMATRIXHANDLE world
, proj
, view
;
305 HRESULT
d3d_device_init(IDirect3DDeviceImpl
*device
, IDirectDrawImpl
*ddraw
,
306 IDirectDrawSurfaceImpl
*target
) DECLSPEC_HIDDEN
;
309 extern const GUID IID_D3DDEVICE_WineD3D DECLSPEC_HIDDEN
;
311 /* Helper functions */
312 HRESULT
IDirect3DImpl_GetCaps(const struct wined3d
*wined3d
,
313 D3DDEVICEDESC
*Desc123
, D3DDEVICEDESC7
*Desc7
) DECLSPEC_HIDDEN
;
314 WINED3DZBUFFERTYPE
IDirect3DDeviceImpl_UpdateDepthStencil(IDirect3DDeviceImpl
*This
) DECLSPEC_HIDDEN
;
316 static inline IDirect3DDeviceImpl
*device_from_device1(IDirect3DDevice
*iface
)
318 return (IDirect3DDeviceImpl
*)((char*)iface
- FIELD_OFFSET(IDirect3DDeviceImpl
, IDirect3DDevice_vtbl
));
321 static inline IDirect3DDeviceImpl
*device_from_device2(IDirect3DDevice2
*iface
)
323 return (IDirect3DDeviceImpl
*)((char*)iface
- FIELD_OFFSET(IDirect3DDeviceImpl
, IDirect3DDevice2_vtbl
));
326 static inline IDirect3DDeviceImpl
*device_from_device3(IDirect3DDevice3
*iface
)
328 return (IDirect3DDeviceImpl
*)((char*)iface
- FIELD_OFFSET(IDirect3DDeviceImpl
, IDirect3DDevice3_vtbl
));
331 /*****************************************************************************
332 * IDirectDrawClipper implementation structure
333 *****************************************************************************/
334 struct IDirectDrawClipperImpl
336 /* IUnknown fields */
337 const IDirectDrawClipperVtbl
*lpVtbl
;
340 struct wined3d_clipper
*wineD3DClipper
;
344 HRESULT
ddraw_clipper_init(IDirectDrawClipperImpl
*clipper
) DECLSPEC_HIDDEN
;
346 /*****************************************************************************
347 * IDirectDrawPalette implementation structure
348 *****************************************************************************/
349 struct IDirectDrawPaletteImpl
351 /* IUnknown fields */
352 const IDirectDrawPaletteVtbl
*lpVtbl
;
355 struct wined3d_palette
*wineD3DPalette
;
357 /* IDirectDrawPalette fields */
358 IUnknown
*ifaceToRelease
;
361 HRESULT
ddraw_palette_init(IDirectDrawPaletteImpl
*palette
,
362 IDirectDrawImpl
*ddraw
, DWORD flags
, PALETTEENTRY
*entries
) DECLSPEC_HIDDEN
;
364 /* Helper structures */
365 struct object_creation_info
368 HRESULT (*pfnCreateInstance
)(IUnknown
*pUnkOuter
, REFIID riid
,
372 /******************************************************************************
373 * IDirect3DLight implementation structure - Wraps to D3D7
374 ******************************************************************************/
375 struct IDirect3DLightImpl
377 const IDirect3DLightVtbl
*lpVtbl
;
380 /* IDirect3DLight fields */
381 IDirectDrawImpl
*ddraw
;
383 /* If this light is active for one viewport, put the viewport here */
384 IDirect3DViewportImpl
*active_viewport
;
394 /* Helper functions */
395 void light_activate(IDirect3DLightImpl
*light
) DECLSPEC_HIDDEN
;
396 void light_deactivate(IDirect3DLightImpl
*light
) DECLSPEC_HIDDEN
;
397 void d3d_light_init(IDirect3DLightImpl
*light
, IDirectDrawImpl
*ddraw
) DECLSPEC_HIDDEN
;
399 /******************************************************************************
400 * IDirect3DMaterial implementation structure - Wraps to D3D7
401 ******************************************************************************/
402 struct IDirect3DMaterialImpl
404 const IDirect3DMaterial3Vtbl
*lpVtbl
;
405 const IDirect3DMaterial2Vtbl
*IDirect3DMaterial2_vtbl
;
406 const IDirect3DMaterialVtbl
*IDirect3DMaterial_vtbl
;
409 /* IDirect3DMaterial2 fields */
410 IDirectDrawImpl
*ddraw
;
411 IDirect3DDeviceImpl
*active_device
;
417 /* Helper functions */
418 void material_activate(IDirect3DMaterialImpl
* This
) DECLSPEC_HIDDEN
;
419 void d3d_material_init(IDirect3DMaterialImpl
*material
, IDirectDrawImpl
*ddraw
) DECLSPEC_HIDDEN
;
421 /*****************************************************************************
422 * IDirect3DViewport - Wraps to D3D7
423 *****************************************************************************/
424 struct IDirect3DViewportImpl
426 const IDirect3DViewport3Vtbl
*lpVtbl
;
429 /* IDirect3DViewport fields */
430 IDirectDrawImpl
*ddraw
;
432 /* If this viewport is active for one device, put the device here */
433 IDirect3DDeviceImpl
*active_device
;
447 struct list light_list
;
449 /* Background material */
450 IDirect3DMaterialImpl
*background
;
453 /* Helper functions */
454 void viewport_activate(IDirect3DViewportImpl
* This
, BOOL ignore_lights
) DECLSPEC_HIDDEN
;
455 void d3d_viewport_init(IDirect3DViewportImpl
*viewport
, IDirectDrawImpl
*ddraw
) DECLSPEC_HIDDEN
;
457 /*****************************************************************************
458 * IDirect3DExecuteBuffer - Wraps to D3D7
459 *****************************************************************************/
460 struct IDirect3DExecuteBufferImpl
463 const IDirect3DExecuteBufferVtbl
*lpVtbl
;
466 /* IDirect3DExecuteBuffer fields */
467 IDirectDrawImpl
*ddraw
;
468 IDirect3DDeviceImpl
*d3ddev
;
470 D3DEXECUTEBUFFERDESC desc
;
473 /* This buffer will store the transformed vertices */
478 /* This flags is set to TRUE if we allocated ourselves the
484 HRESULT
d3d_execute_buffer_init(IDirect3DExecuteBufferImpl
*execute_buffer
,
485 IDirect3DDeviceImpl
*device
, D3DEXECUTEBUFFERDESC
*desc
) DECLSPEC_HIDDEN
;
487 /* The execute function */
488 HRESULT
d3d_execute_buffer_execute(IDirect3DExecuteBufferImpl
*execute_buffer
,
489 IDirect3DDeviceImpl
*device
, IDirect3DViewportImpl
*viewport
) DECLSPEC_HIDDEN
;
491 /*****************************************************************************
492 * IDirect3DVertexBuffer
493 *****************************************************************************/
494 struct IDirect3DVertexBufferImpl
496 /*** IUnknown Methods ***/
497 const IDirect3DVertexBuffer7Vtbl
*lpVtbl
;
498 const IDirect3DVertexBufferVtbl
*IDirect3DVertexBuffer_vtbl
;
501 /*** WineD3D and ddraw links ***/
502 struct wined3d_buffer
*wineD3DVertexBuffer
;
503 struct wined3d_vertex_declaration
*wineD3DVertexDeclaration
;
504 IDirectDrawImpl
*ddraw
;
506 /*** Storage for D3D7 specific things ***/
511 HRESULT
d3d_vertex_buffer_init(IDirect3DVertexBufferImpl
*buffer
,
512 IDirectDrawImpl
*ddraw
, D3DVERTEXBUFFERDESC
*desc
) DECLSPEC_HIDDEN
;
514 static inline IDirect3DVertexBufferImpl
*vb_from_vb1(IDirect3DVertexBuffer
*iface
)
516 return (IDirect3DVertexBufferImpl
*)((char*)iface
517 - FIELD_OFFSET(IDirect3DVertexBufferImpl
, IDirect3DVertexBuffer_vtbl
));
520 /*****************************************************************************
521 * Helper functions from utils.c
522 *****************************************************************************/
524 #define GET_TEXCOUNT_FROM_FVF(d3dvtVertexType) \
525 (((d3dvtVertexType) & D3DFVF_TEXCOUNT_MASK) >> D3DFVF_TEXCOUNT_SHIFT)
527 #define GET_TEXCOORD_SIZE_FROM_FVF(d3dvtVertexType, tex_num) \
528 (((((d3dvtVertexType) >> (16 + (2 * (tex_num)))) + 1) & 0x03) + 1)
530 void PixelFormat_WineD3DtoDD(DDPIXELFORMAT
*DDPixelFormat
, enum wined3d_format_id WineD3DFormat
) DECLSPEC_HIDDEN
;
531 enum wined3d_format_id
PixelFormat_DD2WineD3D(const DDPIXELFORMAT
*DDPixelFormat
) DECLSPEC_HIDDEN
;
532 void DDRAW_dump_surface_desc(const DDSURFACEDESC2
*lpddsd
) DECLSPEC_HIDDEN
;
533 void dump_D3DMATRIX(const D3DMATRIX
*mat
) DECLSPEC_HIDDEN
;
534 void DDRAW_dump_DDCAPS(const DDCAPS
*lpcaps
) DECLSPEC_HIDDEN
;
535 DWORD
get_flexible_vertex_size(DWORD d3dvtVertexType
) DECLSPEC_HIDDEN
;
536 void DDRAW_dump_DDSCAPS2(const DDSCAPS2
*in
) DECLSPEC_HIDDEN
;
537 void DDRAW_dump_cooperativelevel(DWORD cooplevel
) DECLSPEC_HIDDEN
;
539 /* This only needs to be here as long the processvertices functionality of
540 * IDirect3DExecuteBuffer isn't in WineD3D */
541 void multiply_matrix(LPD3DMATRIX dest
, const D3DMATRIX
*src1
, const D3DMATRIX
*src2
) DECLSPEC_HIDDEN
;
543 /* Used for generic dumping */
550 #define FE(x) { x, #x }
556 void (*func
)(const void *);
561 #define ME(x,f,e) { x, #x, (void (*)(const void *))(f), offsetof(STRUCT, e) }
563 #define DD_STRUCT_COPY_BYSIZE_(to,from,from_size) \
565 DWORD __size = (to)->dwSize; \
566 DWORD __copysize = min(__size, from_size); \
567 assert(to != from); \
568 memcpy(to, from, __copysize); \
569 memset((char*)(to) + __copysize, 0, __size - __copysize); \
570 (to)->dwSize = __size; /* restore size */ \
573 #define DD_STRUCT_COPY_BYSIZE(to,from) DD_STRUCT_COPY_BYSIZE_(to,from,(from)->dwSize)
575 #define SIZEOF_END_PADDING(type, last_field) \
576 (sizeof(type) - offsetof(type, last_field) - sizeof(((type *)0)->last_field))
578 static inline void copy_to_surfacedesc2(DDSURFACEDESC2
*to
, DDSURFACEDESC2
*from
)
580 DWORD from_size
= from
->dwSize
;
581 if (from_size
== sizeof(DDSURFACEDESC
))
582 from_size
-= SIZEOF_END_PADDING(DDSURFACEDESC
, ddsCaps
);
583 to
->dwSize
= sizeof(DDSURFACEDESC2
); /* for struct copy */
584 DD_STRUCT_COPY_BYSIZE_(to
, from
, from_size
);
587 HRESULT
hr_ddraw_from_wined3d(HRESULT hr
) DECLSPEC_HIDDEN
;