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
;
41 extern DWORD force_refresh_rate DECLSPEC_HIDDEN
;
43 /*****************************************************************************
44 * IDirectDraw implementation structure
45 *****************************************************************************/
49 struct wined3d_vertex_declaration
*decl
;
55 IDirectDraw7 IDirectDraw7_iface
;
56 IDirectDraw4 IDirectDraw4_iface
;
57 IDirectDraw2 IDirectDraw2_iface
;
58 IDirectDraw IDirectDraw_iface
;
59 IDirect3D7 IDirect3D7_iface
;
60 IDirect3D3 IDirect3D3_iface
;
61 IDirect3D2 IDirect3D2_iface
;
62 IDirect3D IDirect3D_iface
;
63 struct wined3d_device_parent device_parent
;
65 /* See comment in IDirectDraw::AddRef */
66 LONG ref7
, ref4
, ref2
, ref3
, ref1
, numIfaces
;
69 struct wined3d
*wined3d
;
70 struct wined3d_device
*wined3d_device
;
73 struct ddraw_surface
*primary
;
75 struct wined3d_surface
*wined3d_frontbuffer
;
76 struct wined3d_swapchain
*wined3d_swapchain
;
77 HWND swapchain_window
;
79 /* DirectDraw things, which are not handled by WineD3D */
80 DWORD cooperative_level
;
82 DWORD orig_width
, orig_height
;
87 struct d3d_device
*d3ddevice
;
95 /* For the dll unload cleanup code */
96 struct list ddraw_list_entry
;
97 /* The surface list - can't relay this to WineD3D
100 struct list surface_list
;
103 struct FvfToDecl
*decls
;
104 UINT numConvertedDecls
, declArraySize
;
107 #define DDRAW_WINDOW_CLASS_NAME "DirectDrawDeviceWnd"
109 HRESULT
ddraw_init(struct ddraw
*ddraw
, enum wined3d_device_type device_type
) DECLSPEC_HIDDEN
;
110 void ddraw_destroy_swapchain(struct ddraw
*ddraw
) DECLSPEC_HIDDEN
;
112 static inline void ddraw_set_swapchain_window(struct ddraw
*ddraw
, HWND window
)
114 if (window
== GetDesktopWindow())
116 ddraw
->swapchain_window
= window
;
119 /* Utility functions */
120 void DDRAW_Convert_DDSCAPS_1_To_2(const DDSCAPS
*pIn
, DDSCAPS2
*pOut
) DECLSPEC_HIDDEN
;
121 void DDRAW_Convert_DDDEVICEIDENTIFIER_2_To_1(const DDDEVICEIDENTIFIER2
*pIn
, DDDEVICEIDENTIFIER
*pOut
) DECLSPEC_HIDDEN
;
122 struct wined3d_vertex_declaration
*ddraw_find_decl(struct ddraw
*ddraw
, DWORD fvf
) DECLSPEC_HIDDEN
;
124 /* The default surface type */
125 extern enum wined3d_surface_type DefaultSurfaceType DECLSPEC_HIDDEN
;
127 /*****************************************************************************
128 * IDirectDrawSurface implementation structure
129 *****************************************************************************/
133 /* IUnknown fields */
134 IDirectDrawSurface7 IDirectDrawSurface7_iface
;
135 IDirectDrawSurface4 IDirectDrawSurface4_iface
;
136 IDirectDrawSurface3 IDirectDrawSurface3_iface
;
137 IDirectDrawSurface2 IDirectDrawSurface2_iface
;
138 IDirectDrawSurface IDirectDrawSurface_iface
;
139 IDirectDrawGammaControl IDirectDrawGammaControl_iface
;
140 IDirect3DTexture2 IDirect3DTexture2_iface
;
141 IDirect3DTexture IDirect3DTexture_iface
;
143 LONG ref7
, ref4
, ref3
, ref2
, ref1
, iface_count
, gamma_count
;
144 IUnknown
*ifaceToRelease
;
145 IUnknown
*texture_outer
;
149 /* Connections to other Objects */
151 struct wined3d_surface
*wined3d_surface
;
152 struct wined3d_texture
*wined3d_texture
;
153 struct d3d_device
*device1
;
155 /* This implementation handles attaching surfaces to other surfaces */
156 struct ddraw_surface
*next_attached
;
157 struct ddraw_surface
*first_attached
;
158 IUnknown
*attached_iface
;
160 /* Complex surfaces are organized in a tree, although the tree is degenerated to a list in most cases.
161 * In mipmap and primary surfaces each level has only one attachment, which is the next surface level.
162 * Only the cube texture root has 6 surfaces attached, which then have a normal mipmap chain attached
163 * to them. So hardcode the array to 6, a dynamic array or a list would be an overkill.
165 #define MAX_COMPLEX_ATTACHED 6
166 struct ddraw_surface
*complex_array
[MAX_COMPLEX_ATTACHED
];
167 /* You can't traverse the tree upwards. Only a flag for Surface::Release because its needed there,
168 * but no pointer to prevent temptations to traverse it in the wrong direction.
170 BOOL is_complex_root
;
172 /* Surface description, for GetAttachedSurface */
173 DDSURFACEDESC2 surface_desc
;
176 DWORD uniqueness_value
;
179 /* Clipper objects */
180 struct ddraw_clipper
*clipper
;
182 /* For the ddraw surface list */
183 struct list surface_list_entry
;
188 HRESULT
ddraw_surface_create_texture(struct ddraw_surface
*surface
) DECLSPEC_HIDDEN
;
189 HRESULT
ddraw_surface_init(struct ddraw_surface
*surface
, struct ddraw
*ddraw
,
190 DDSURFACEDESC2
*desc
, UINT mip_level
, UINT version
) DECLSPEC_HIDDEN
;
191 ULONG
ddraw_surface_release_iface(struct ddraw_surface
*This
) DECLSPEC_HIDDEN
;
193 static inline struct ddraw_surface
*impl_from_IDirect3DTexture(IDirect3DTexture
*iface
)
195 return CONTAINING_RECORD(iface
, struct ddraw_surface
, IDirect3DTexture_iface
);
198 static inline struct ddraw_surface
*impl_from_IDirect3DTexture2(IDirect3DTexture2
*iface
)
200 return CONTAINING_RECORD(iface
, struct ddraw_surface
, IDirect3DTexture2_iface
);
203 static inline struct ddraw_surface
*impl_from_IDirectDrawSurface(IDirectDrawSurface
*iface
)
205 return CONTAINING_RECORD(iface
, struct ddraw_surface
, IDirectDrawSurface_iface
);
208 static inline struct ddraw_surface
*impl_from_IDirectDrawSurface2(IDirectDrawSurface2
*iface
)
210 return CONTAINING_RECORD(iface
, struct ddraw_surface
, IDirectDrawSurface2_iface
);
213 static inline struct ddraw_surface
*impl_from_IDirectDrawSurface3(IDirectDrawSurface3
*iface
)
215 return CONTAINING_RECORD(iface
, struct ddraw_surface
, IDirectDrawSurface3_iface
);
218 static inline struct ddraw_surface
*impl_from_IDirectDrawSurface4(IDirectDrawSurface4
*iface
)
220 return CONTAINING_RECORD(iface
, struct ddraw_surface
, IDirectDrawSurface4_iface
);
223 static inline struct ddraw_surface
*impl_from_IDirectDrawSurface7(IDirectDrawSurface7
*iface
)
225 return CONTAINING_RECORD(iface
, struct ddraw_surface
, IDirectDrawSurface7_iface
);
228 struct ddraw_surface
*unsafe_impl_from_IDirectDrawSurface(IDirectDrawSurface
*iface
) DECLSPEC_HIDDEN
;
229 struct ddraw_surface
*unsafe_impl_from_IDirectDrawSurface4(IDirectDrawSurface4
*iface
) DECLSPEC_HIDDEN
;
230 struct ddraw_surface
*unsafe_impl_from_IDirectDrawSurface7(IDirectDrawSurface7
*iface
) DECLSPEC_HIDDEN
;
232 struct ddraw_surface
*unsafe_impl_from_IDirect3DTexture(IDirect3DTexture
*iface
) DECLSPEC_HIDDEN
;
233 struct ddraw_surface
*unsafe_impl_from_IDirect3DTexture2(IDirect3DTexture2
*iface
) DECLSPEC_HIDDEN
;
235 #define DDRAW_INVALID_HANDLE ~0U
237 enum ddraw_handle_type
240 DDRAW_HANDLE_MATERIAL
,
242 DDRAW_HANDLE_STATEBLOCK
,
243 DDRAW_HANDLE_SURFACE
,
246 struct ddraw_handle_entry
249 enum ddraw_handle_type type
;
252 struct ddraw_handle_table
254 struct ddraw_handle_entry
*entries
;
255 struct ddraw_handle_entry
*free_entries
;
260 BOOL
ddraw_handle_table_init(struct ddraw_handle_table
*t
, UINT initial_size
) DECLSPEC_HIDDEN
;
261 void ddraw_handle_table_destroy(struct ddraw_handle_table
*t
) DECLSPEC_HIDDEN
;
262 DWORD
ddraw_allocate_handle(struct ddraw_handle_table
*t
, void *object
, enum ddraw_handle_type type
) DECLSPEC_HIDDEN
;
263 void *ddraw_free_handle(struct ddraw_handle_table
*t
, DWORD handle
, enum ddraw_handle_type type
) DECLSPEC_HIDDEN
;
264 void *ddraw_get_object(struct ddraw_handle_table
*t
, DWORD handle
, enum ddraw_handle_type type
) DECLSPEC_HIDDEN
;
269 IDirect3DDevice7 IDirect3DDevice7_iface
;
270 IDirect3DDevice3 IDirect3DDevice3_iface
;
271 IDirect3DDevice2 IDirect3DDevice2_iface
;
272 IDirect3DDevice IDirect3DDevice_iface
;
273 IUnknown IUnknown_inner
;
277 IUnknown
*outer_unknown
;
278 struct wined3d_device
*wined3d_device
;
280 struct wined3d_buffer
*indexbuffer
;
281 struct ddraw_surface
*target
;
283 /* Viewport management */
284 struct list viewport_list
;
285 struct d3d_viewport
*current_viewport
;
286 D3DVIEWPORT7 active_viewport
;
288 /* Required to keep track which of two available texture blending modes in d3ddevice3 is used */
289 BOOL legacyTextureBlending
;
291 D3DMATRIX legacy_projection
;
292 D3DMATRIX legacy_clipspace
;
297 /* Rendering functions to wrap D3D(1-3) to D3D7 */
298 D3DPRIMITIVETYPE primitive_type
;
302 LPBYTE vertex_buffer
;
306 /* Handle management */
307 struct ddraw_handle_table handle_table
;
308 D3DMATRIXHANDLE world
, proj
, view
;
311 HRESULT
d3d_device_create(struct ddraw
*ddraw
, struct ddraw_surface
*target
,
312 UINT version
, struct d3d_device
**device
, IUnknown
*outer_unknown
) DECLSPEC_HIDDEN
;
313 enum wined3d_depth_buffer_type
d3d_device_update_depth_stencil(struct d3d_device
*device
) DECLSPEC_HIDDEN
;
316 extern const GUID IID_D3DDEVICE_WineD3D DECLSPEC_HIDDEN
;
318 /* Helper functions */
319 HRESULT
IDirect3DImpl_GetCaps(const struct wined3d
*wined3d
,
320 D3DDEVICEDESC
*Desc123
, D3DDEVICEDESC7
*Desc7
) DECLSPEC_HIDDEN
;
322 static inline struct d3d_device
*impl_from_IDirect3DDevice(IDirect3DDevice
*iface
)
324 return CONTAINING_RECORD(iface
, struct d3d_device
, IDirect3DDevice_iface
);
327 static inline struct d3d_device
*impl_from_IDirect3DDevice2(IDirect3DDevice2
*iface
)
329 return CONTAINING_RECORD(iface
, struct d3d_device
, IDirect3DDevice2_iface
);
332 static inline struct d3d_device
*impl_from_IDirect3DDevice3(IDirect3DDevice3
*iface
)
334 return CONTAINING_RECORD(iface
, struct d3d_device
, IDirect3DDevice3_iface
);
337 static inline struct d3d_device
*impl_from_IDirect3DDevice7(IDirect3DDevice7
*iface
)
339 return CONTAINING_RECORD(iface
, struct d3d_device
, IDirect3DDevice7_iface
);
342 struct d3d_device
*unsafe_impl_from_IDirect3DDevice(IDirect3DDevice
*iface
) DECLSPEC_HIDDEN
;
343 struct d3d_device
*unsafe_impl_from_IDirect3DDevice2(IDirect3DDevice2
*iface
) DECLSPEC_HIDDEN
;
344 struct d3d_device
*unsafe_impl_from_IDirect3DDevice3(IDirect3DDevice3
*iface
) DECLSPEC_HIDDEN
;
345 struct d3d_device
*unsafe_impl_from_IDirect3DDevice7(IDirect3DDevice7
*iface
) DECLSPEC_HIDDEN
;
349 IDirectDrawClipper IDirectDrawClipper_iface
;
356 HRESULT
ddraw_clipper_init(struct ddraw_clipper
*clipper
) DECLSPEC_HIDDEN
;
357 struct ddraw_clipper
*unsafe_impl_from_IDirectDrawClipper(IDirectDrawClipper
*iface
) DECLSPEC_HIDDEN
;
359 /*****************************************************************************
360 * IDirectDrawPalette implementation structure
361 *****************************************************************************/
364 /* IUnknown fields */
365 IDirectDrawPalette IDirectDrawPalette_iface
;
368 struct wined3d_palette
*wineD3DPalette
;
370 /* IDirectDrawPalette fields */
371 IUnknown
*ifaceToRelease
;
374 static inline struct ddraw_palette
*impl_from_IDirectDrawPalette(IDirectDrawPalette
*iface
)
376 return CONTAINING_RECORD(iface
, struct ddraw_palette
, IDirectDrawPalette_iface
);
379 struct ddraw_palette
*unsafe_impl_from_IDirectDrawPalette(IDirectDrawPalette
*iface
) DECLSPEC_HIDDEN
;
381 HRESULT
ddraw_palette_init(struct ddraw_palette
*palette
,
382 struct ddraw
*ddraw
, DWORD flags
, PALETTEENTRY
*entries
) DECLSPEC_HIDDEN
;
384 /* Helper structures */
385 struct object_creation_info
388 HRESULT (*pfnCreateInstance
)(IUnknown
*pUnkOuter
, REFIID riid
,
392 /******************************************************************************
393 * IDirect3DLight implementation structure - Wraps to D3D7
394 ******************************************************************************/
397 IDirect3DLight IDirect3DLight_iface
;
400 /* IDirect3DLight fields */
403 /* If this light is active for one viewport, put the viewport here */
404 struct d3d_viewport
*active_viewport
;
414 /* Helper functions */
415 void light_activate(struct d3d_light
*light
) DECLSPEC_HIDDEN
;
416 void light_deactivate(struct d3d_light
*light
) DECLSPEC_HIDDEN
;
417 void d3d_light_init(struct d3d_light
*light
, struct ddraw
*ddraw
) DECLSPEC_HIDDEN
;
418 struct d3d_light
*unsafe_impl_from_IDirect3DLight(IDirect3DLight
*iface
) DECLSPEC_HIDDEN
;
420 /******************************************************************************
421 * IDirect3DMaterial implementation structure - Wraps to D3D7
422 ******************************************************************************/
425 IDirect3DMaterial3 IDirect3DMaterial3_iface
;
426 IDirect3DMaterial2 IDirect3DMaterial2_iface
;
427 IDirect3DMaterial IDirect3DMaterial_iface
;
430 /* IDirect3DMaterial2 fields */
432 struct d3d_device
*active_device
;
438 /* Helper functions */
439 void material_activate(struct d3d_material
*material
) DECLSPEC_HIDDEN
;
440 struct d3d_material
*d3d_material_create(struct ddraw
*ddraw
) DECLSPEC_HIDDEN
;
442 /*****************************************************************************
443 * IDirect3DViewport - Wraps to D3D7
444 *****************************************************************************/
447 IDirect3DViewport3 IDirect3DViewport3_iface
;
450 /* IDirect3DViewport fields */
453 /* If this viewport is active for one device, put the device here */
454 struct d3d_device
*active_device
;
468 struct list light_list
;
469 struct d3d_material
*background
;
472 struct d3d_viewport
*unsafe_impl_from_IDirect3DViewport3(IDirect3DViewport3
*iface
) DECLSPEC_HIDDEN
;
473 struct d3d_viewport
*unsafe_impl_from_IDirect3DViewport2(IDirect3DViewport2
*iface
) DECLSPEC_HIDDEN
;
474 struct d3d_viewport
*unsafe_impl_from_IDirect3DViewport(IDirect3DViewport
*iface
) DECLSPEC_HIDDEN
;
476 /* Helper functions */
477 void viewport_activate(struct d3d_viewport
*viewport
, BOOL ignore_lights
) DECLSPEC_HIDDEN
;
478 void d3d_viewport_init(struct d3d_viewport
*viewport
, struct ddraw
*ddraw
) DECLSPEC_HIDDEN
;
480 /*****************************************************************************
481 * IDirect3DExecuteBuffer - Wraps to D3D7
482 *****************************************************************************/
483 struct d3d_execute_buffer
485 IDirect3DExecuteBuffer IDirect3DExecuteBuffer_iface
;
487 /* IDirect3DExecuteBuffer fields */
489 struct d3d_device
*d3ddev
;
491 D3DEXECUTEBUFFERDESC desc
;
494 /* This buffer will store the transformed vertices */
499 /* This flags is set to TRUE if we allocated ourselves the
505 HRESULT
d3d_execute_buffer_init(struct d3d_execute_buffer
*execute_buffer
,
506 struct d3d_device
*device
, D3DEXECUTEBUFFERDESC
*desc
) DECLSPEC_HIDDEN
;
507 struct d3d_execute_buffer
*unsafe_impl_from_IDirect3DExecuteBuffer(IDirect3DExecuteBuffer
*iface
) DECLSPEC_HIDDEN
;
509 /* The execute function */
510 HRESULT
d3d_execute_buffer_execute(struct d3d_execute_buffer
*execute_buffer
,
511 struct d3d_device
*device
, struct d3d_viewport
*viewport
) DECLSPEC_HIDDEN
;
513 /*****************************************************************************
514 * IDirect3DVertexBuffer
515 *****************************************************************************/
516 struct d3d_vertex_buffer
518 IDirect3DVertexBuffer7 IDirect3DVertexBuffer7_iface
;
519 IDirect3DVertexBuffer IDirect3DVertexBuffer_iface
;
522 /*** WineD3D and ddraw links ***/
523 struct wined3d_buffer
*wineD3DVertexBuffer
;
524 struct wined3d_vertex_declaration
*wineD3DVertexDeclaration
;
527 /*** Storage for D3D7 specific things ***/
532 HRESULT
d3d_vertex_buffer_create(struct d3d_vertex_buffer
**buffer
, struct ddraw
*ddraw
,
533 D3DVERTEXBUFFERDESC
*desc
) DECLSPEC_HIDDEN
;
534 struct d3d_vertex_buffer
*unsafe_impl_from_IDirect3DVertexBuffer(IDirect3DVertexBuffer
*iface
) DECLSPEC_HIDDEN
;
535 struct d3d_vertex_buffer
*unsafe_impl_from_IDirect3DVertexBuffer7(IDirect3DVertexBuffer7
*iface
) DECLSPEC_HIDDEN
;
537 /*****************************************************************************
538 * Helper functions from utils.c
539 *****************************************************************************/
541 #define GET_TEXCOUNT_FROM_FVF(d3dvtVertexType) \
542 (((d3dvtVertexType) & D3DFVF_TEXCOUNT_MASK) >> D3DFVF_TEXCOUNT_SHIFT)
544 #define GET_TEXCOORD_SIZE_FROM_FVF(d3dvtVertexType, tex_num) \
545 (((((d3dvtVertexType) >> (16 + (2 * (tex_num)))) + 1) & 0x03) + 1)
547 void PixelFormat_WineD3DtoDD(DDPIXELFORMAT
*DDPixelFormat
, enum wined3d_format_id WineD3DFormat
) DECLSPEC_HIDDEN
;
548 enum wined3d_format_id
PixelFormat_DD2WineD3D(const DDPIXELFORMAT
*DDPixelFormat
) DECLSPEC_HIDDEN
;
549 void DDRAW_dump_surface_desc(const DDSURFACEDESC2
*lpddsd
) DECLSPEC_HIDDEN
;
550 void dump_D3DMATRIX(const D3DMATRIX
*mat
) DECLSPEC_HIDDEN
;
551 void DDRAW_dump_DDCAPS(const DDCAPS
*lpcaps
) DECLSPEC_HIDDEN
;
552 DWORD
get_flexible_vertex_size(DWORD d3dvtVertexType
) DECLSPEC_HIDDEN
;
553 void DDRAW_dump_DDSCAPS2(const DDSCAPS2
*in
) DECLSPEC_HIDDEN
;
554 void DDRAW_dump_cooperativelevel(DWORD cooplevel
) DECLSPEC_HIDDEN
;
555 void DDSD_to_DDSD2(const DDSURFACEDESC
*in
, DDSURFACEDESC2
*out
) DECLSPEC_HIDDEN
;
556 void DDSD2_to_DDSD(const DDSURFACEDESC2
*in
, DDSURFACEDESC
*out
) DECLSPEC_HIDDEN
;
558 /* This only needs to be here as long the processvertices functionality of
559 * IDirect3DExecuteBuffer isn't in WineD3D */
560 void multiply_matrix(LPD3DMATRIX dest
, const D3DMATRIX
*src1
, const D3DMATRIX
*src2
) DECLSPEC_HIDDEN
;
562 /* Used for generic dumping */
569 #define FE(x) { x, #x }
575 void (*func
)(const void *);
580 #define ME(x,f,e) { x, #x, (void (*)(const void *))(f), offsetof(STRUCT, e) }
582 #define DD_STRUCT_COPY_BYSIZE_(to,from,from_size) \
584 DWORD __size = (to)->dwSize; \
585 DWORD __resetsize = min(__size, sizeof(*to)); \
586 DWORD __copysize = min(__resetsize, from_size); \
587 assert(to != from); \
588 memcpy(to, from, __copysize); \
589 memset((char*)(to) + __copysize, 0, __resetsize - __copysize); \
590 (to)->dwSize = __size; /* restore size */ \
593 #define DD_STRUCT_COPY_BYSIZE(to,from) DD_STRUCT_COPY_BYSIZE_(to,from,(from)->dwSize)
595 #define SIZEOF_END_PADDING(type, last_field) \
596 (sizeof(type) - offsetof(type, last_field) - sizeof(((type *)0)->last_field))
598 static inline void copy_to_surfacedesc2(DDSURFACEDESC2
*to
, DDSURFACEDESC2
*from
)
600 DWORD from_size
= from
->dwSize
;
601 if (from_size
== sizeof(DDSURFACEDESC
))
602 from_size
-= SIZEOF_END_PADDING(DDSURFACEDESC
, ddsCaps
);
603 to
->dwSize
= sizeof(DDSURFACEDESC2
); /* for struct copy */
604 DD_STRUCT_COPY_BYSIZE_(to
, from
, from_size
);
607 HRESULT
hr_ddraw_from_wined3d(HRESULT hr
) DECLSPEC_HIDDEN
;