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 /* Helpers for surface creation */
96 struct ddraw_surface
*tex_root
;
98 /* For the dll unload cleanup code */
99 struct list ddraw_list_entry
;
100 /* The surface list - can't relay this to WineD3D
103 struct list surface_list
;
106 struct FvfToDecl
*decls
;
107 UINT numConvertedDecls
, declArraySize
;
110 #define DDRAW_WINDOW_CLASS_NAME "DirectDrawDeviceWnd"
112 HRESULT
ddraw_init(struct ddraw
*ddraw
, enum wined3d_device_type device_type
) DECLSPEC_HIDDEN
;
113 void ddraw_destroy_swapchain(struct ddraw
*ddraw
) DECLSPEC_HIDDEN
;
115 static inline void ddraw_set_swapchain_window(struct ddraw
*ddraw
, HWND window
)
117 if (window
== GetDesktopWindow())
119 ddraw
->swapchain_window
= window
;
122 /* Utility functions */
123 void DDRAW_Convert_DDSCAPS_1_To_2(const DDSCAPS
*pIn
, DDSCAPS2
*pOut
) DECLSPEC_HIDDEN
;
124 void DDRAW_Convert_DDDEVICEIDENTIFIER_2_To_1(const DDDEVICEIDENTIFIER2
*pIn
, DDDEVICEIDENTIFIER
*pOut
) DECLSPEC_HIDDEN
;
125 struct wined3d_vertex_declaration
*ddraw_find_decl(struct ddraw
*ddraw
, DWORD fvf
) DECLSPEC_HIDDEN
;
127 /* The default surface type */
128 extern enum wined3d_surface_type DefaultSurfaceType DECLSPEC_HIDDEN
;
130 /*****************************************************************************
131 * IDirectDrawSurface implementation structure
132 *****************************************************************************/
136 /* IUnknown fields */
137 IDirectDrawSurface7 IDirectDrawSurface7_iface
;
138 IDirectDrawSurface4 IDirectDrawSurface4_iface
;
139 IDirectDrawSurface3 IDirectDrawSurface3_iface
;
140 IDirectDrawSurface2 IDirectDrawSurface2_iface
;
141 IDirectDrawSurface IDirectDrawSurface_iface
;
142 IDirectDrawGammaControl IDirectDrawGammaControl_iface
;
143 IDirect3DTexture2 IDirect3DTexture2_iface
;
144 IDirect3DTexture IDirect3DTexture_iface
;
146 LONG ref7
, ref4
, ref3
, ref2
, ref1
, iface_count
, gamma_count
;
147 IUnknown
*ifaceToRelease
;
148 IUnknown
*texture_outer
;
152 /* Connections to other Objects */
154 struct wined3d_surface
*wined3d_surface
;
155 struct wined3d_texture
*wined3d_texture
;
156 struct d3d_device
*device1
;
158 /* This implementation handles attaching surfaces to other surfaces */
159 struct ddraw_surface
*next_attached
;
160 struct ddraw_surface
*first_attached
;
161 IUnknown
*attached_iface
;
163 /* Complex surfaces are organized in a tree, although the tree is degenerated to a list in most cases.
164 * In mipmap and primary surfaces each level has only one attachment, which is the next surface level.
165 * Only the cube texture root has 6 surfaces attached, which then have a normal mipmap chain attached
166 * to them. So hardcode the array to 6, a dynamic array or a list would be an overkill.
168 #define MAX_COMPLEX_ATTACHED 6
169 struct ddraw_surface
*complex_array
[MAX_COMPLEX_ATTACHED
];
170 /* You can't traverse the tree upwards. Only a flag for Surface::Release because its needed there,
171 * but no pointer to prevent temptations to traverse it in the wrong direction.
173 BOOL is_complex_root
;
175 /* Surface description, for GetAttachedSurface */
176 DDSURFACEDESC2 surface_desc
;
179 DWORD uniqueness_value
;
182 /* Clipper objects */
183 struct ddraw_clipper
*clipper
;
185 /* For the ddraw surface list */
186 struct list surface_list_entry
;
191 HRESULT
ddraw_surface_create_texture(struct ddraw_surface
*surface
) DECLSPEC_HIDDEN
;
192 HRESULT
ddraw_surface_init(struct ddraw_surface
*surface
, struct ddraw
*ddraw
,
193 DDSURFACEDESC2
*desc
, UINT mip_level
, UINT version
) DECLSPEC_HIDDEN
;
194 ULONG
ddraw_surface_release_iface(struct ddraw_surface
*This
) DECLSPEC_HIDDEN
;
196 static inline struct ddraw_surface
*impl_from_IDirect3DTexture(IDirect3DTexture
*iface
)
198 return CONTAINING_RECORD(iface
, struct ddraw_surface
, IDirect3DTexture_iface
);
201 static inline struct ddraw_surface
*impl_from_IDirect3DTexture2(IDirect3DTexture2
*iface
)
203 return CONTAINING_RECORD(iface
, struct ddraw_surface
, IDirect3DTexture2_iface
);
206 static inline struct ddraw_surface
*impl_from_IDirectDrawSurface(IDirectDrawSurface
*iface
)
208 return CONTAINING_RECORD(iface
, struct ddraw_surface
, IDirectDrawSurface_iface
);
211 static inline struct ddraw_surface
*impl_from_IDirectDrawSurface2(IDirectDrawSurface2
*iface
)
213 return CONTAINING_RECORD(iface
, struct ddraw_surface
, IDirectDrawSurface2_iface
);
216 static inline struct ddraw_surface
*impl_from_IDirectDrawSurface3(IDirectDrawSurface3
*iface
)
218 return CONTAINING_RECORD(iface
, struct ddraw_surface
, IDirectDrawSurface3_iface
);
221 static inline struct ddraw_surface
*impl_from_IDirectDrawSurface4(IDirectDrawSurface4
*iface
)
223 return CONTAINING_RECORD(iface
, struct ddraw_surface
, IDirectDrawSurface4_iface
);
226 static inline struct ddraw_surface
*impl_from_IDirectDrawSurface7(IDirectDrawSurface7
*iface
)
228 return CONTAINING_RECORD(iface
, struct ddraw_surface
, IDirectDrawSurface7_iface
);
231 struct ddraw_surface
*unsafe_impl_from_IDirectDrawSurface(IDirectDrawSurface
*iface
) DECLSPEC_HIDDEN
;
232 struct ddraw_surface
*unsafe_impl_from_IDirectDrawSurface4(IDirectDrawSurface4
*iface
) DECLSPEC_HIDDEN
;
233 struct ddraw_surface
*unsafe_impl_from_IDirectDrawSurface7(IDirectDrawSurface7
*iface
) DECLSPEC_HIDDEN
;
235 struct ddraw_surface
*unsafe_impl_from_IDirect3DTexture(IDirect3DTexture
*iface
) DECLSPEC_HIDDEN
;
236 struct ddraw_surface
*unsafe_impl_from_IDirect3DTexture2(IDirect3DTexture2
*iface
) DECLSPEC_HIDDEN
;
238 #define DDRAW_INVALID_HANDLE ~0U
240 enum ddraw_handle_type
243 DDRAW_HANDLE_MATERIAL
,
245 DDRAW_HANDLE_STATEBLOCK
,
246 DDRAW_HANDLE_SURFACE
,
249 struct ddraw_handle_entry
252 enum ddraw_handle_type type
;
255 struct ddraw_handle_table
257 struct ddraw_handle_entry
*entries
;
258 struct ddraw_handle_entry
*free_entries
;
263 BOOL
ddraw_handle_table_init(struct ddraw_handle_table
*t
, UINT initial_size
) DECLSPEC_HIDDEN
;
264 void ddraw_handle_table_destroy(struct ddraw_handle_table
*t
) DECLSPEC_HIDDEN
;
265 DWORD
ddraw_allocate_handle(struct ddraw_handle_table
*t
, void *object
, enum ddraw_handle_type type
) DECLSPEC_HIDDEN
;
266 void *ddraw_free_handle(struct ddraw_handle_table
*t
, DWORD handle
, enum ddraw_handle_type type
) DECLSPEC_HIDDEN
;
267 void *ddraw_get_object(struct ddraw_handle_table
*t
, DWORD handle
, enum ddraw_handle_type type
) DECLSPEC_HIDDEN
;
272 IDirect3DDevice7 IDirect3DDevice7_iface
;
273 IDirect3DDevice3 IDirect3DDevice3_iface
;
274 IDirect3DDevice2 IDirect3DDevice2_iface
;
275 IDirect3DDevice IDirect3DDevice_iface
;
276 IUnknown IUnknown_inner
;
280 IUnknown
*outer_unknown
;
281 struct wined3d_device
*wined3d_device
;
283 struct wined3d_buffer
*indexbuffer
;
284 struct ddraw_surface
*target
;
286 /* Viewport management */
287 struct list viewport_list
;
288 struct d3d_viewport
*current_viewport
;
289 D3DVIEWPORT7 active_viewport
;
291 /* Required to keep track which of two available texture blending modes in d3ddevice3 is used */
292 BOOL legacyTextureBlending
;
294 D3DMATRIX legacy_projection
;
295 D3DMATRIX legacy_clipspace
;
300 /* Rendering functions to wrap D3D(1-3) to D3D7 */
301 D3DPRIMITIVETYPE primitive_type
;
305 LPBYTE vertex_buffer
;
309 /* Handle management */
310 struct ddraw_handle_table handle_table
;
311 D3DMATRIXHANDLE world
, proj
, view
;
314 HRESULT
d3d_device_create(struct ddraw
*ddraw
, struct ddraw_surface
*target
,
315 UINT version
, struct d3d_device
**device
, IUnknown
*outer_unknown
) DECLSPEC_HIDDEN
;
316 enum wined3d_depth_buffer_type
d3d_device_update_depth_stencil(struct d3d_device
*device
) DECLSPEC_HIDDEN
;
319 extern const GUID IID_D3DDEVICE_WineD3D DECLSPEC_HIDDEN
;
321 /* Helper functions */
322 HRESULT
IDirect3DImpl_GetCaps(const struct wined3d
*wined3d
,
323 D3DDEVICEDESC
*Desc123
, D3DDEVICEDESC7
*Desc7
) DECLSPEC_HIDDEN
;
325 static inline struct d3d_device
*impl_from_IDirect3DDevice(IDirect3DDevice
*iface
)
327 return CONTAINING_RECORD(iface
, struct d3d_device
, IDirect3DDevice_iface
);
330 static inline struct d3d_device
*impl_from_IDirect3DDevice2(IDirect3DDevice2
*iface
)
332 return CONTAINING_RECORD(iface
, struct d3d_device
, IDirect3DDevice2_iface
);
335 static inline struct d3d_device
*impl_from_IDirect3DDevice3(IDirect3DDevice3
*iface
)
337 return CONTAINING_RECORD(iface
, struct d3d_device
, IDirect3DDevice3_iface
);
340 static inline struct d3d_device
*impl_from_IDirect3DDevice7(IDirect3DDevice7
*iface
)
342 return CONTAINING_RECORD(iface
, struct d3d_device
, IDirect3DDevice7_iface
);
345 struct d3d_device
*unsafe_impl_from_IDirect3DDevice(IDirect3DDevice
*iface
) DECLSPEC_HIDDEN
;
346 struct d3d_device
*unsafe_impl_from_IDirect3DDevice2(IDirect3DDevice2
*iface
) DECLSPEC_HIDDEN
;
347 struct d3d_device
*unsafe_impl_from_IDirect3DDevice3(IDirect3DDevice3
*iface
) DECLSPEC_HIDDEN
;
348 struct d3d_device
*unsafe_impl_from_IDirect3DDevice7(IDirect3DDevice7
*iface
) DECLSPEC_HIDDEN
;
352 IDirectDrawClipper IDirectDrawClipper_iface
;
359 HRESULT
ddraw_clipper_init(struct ddraw_clipper
*clipper
) DECLSPEC_HIDDEN
;
360 struct ddraw_clipper
*unsafe_impl_from_IDirectDrawClipper(IDirectDrawClipper
*iface
) DECLSPEC_HIDDEN
;
362 /*****************************************************************************
363 * IDirectDrawPalette implementation structure
364 *****************************************************************************/
367 /* IUnknown fields */
368 IDirectDrawPalette IDirectDrawPalette_iface
;
371 struct wined3d_palette
*wineD3DPalette
;
373 /* IDirectDrawPalette fields */
374 IUnknown
*ifaceToRelease
;
377 static inline struct ddraw_palette
*impl_from_IDirectDrawPalette(IDirectDrawPalette
*iface
)
379 return CONTAINING_RECORD(iface
, struct ddraw_palette
, IDirectDrawPalette_iface
);
382 struct ddraw_palette
*unsafe_impl_from_IDirectDrawPalette(IDirectDrawPalette
*iface
) DECLSPEC_HIDDEN
;
384 HRESULT
ddraw_palette_init(struct ddraw_palette
*palette
,
385 struct ddraw
*ddraw
, DWORD flags
, PALETTEENTRY
*entries
) DECLSPEC_HIDDEN
;
387 /* Helper structures */
388 struct object_creation_info
391 HRESULT (*pfnCreateInstance
)(IUnknown
*pUnkOuter
, REFIID riid
,
395 /******************************************************************************
396 * IDirect3DLight implementation structure - Wraps to D3D7
397 ******************************************************************************/
400 IDirect3DLight IDirect3DLight_iface
;
403 /* IDirect3DLight fields */
406 /* If this light is active for one viewport, put the viewport here */
407 struct d3d_viewport
*active_viewport
;
417 /* Helper functions */
418 void light_activate(struct d3d_light
*light
) DECLSPEC_HIDDEN
;
419 void light_deactivate(struct d3d_light
*light
) DECLSPEC_HIDDEN
;
420 void d3d_light_init(struct d3d_light
*light
, struct ddraw
*ddraw
) DECLSPEC_HIDDEN
;
421 struct d3d_light
*unsafe_impl_from_IDirect3DLight(IDirect3DLight
*iface
) DECLSPEC_HIDDEN
;
423 /******************************************************************************
424 * IDirect3DMaterial implementation structure - Wraps to D3D7
425 ******************************************************************************/
428 IDirect3DMaterial3 IDirect3DMaterial3_iface
;
429 IDirect3DMaterial2 IDirect3DMaterial2_iface
;
430 IDirect3DMaterial IDirect3DMaterial_iface
;
433 /* IDirect3DMaterial2 fields */
435 struct d3d_device
*active_device
;
441 /* Helper functions */
442 void material_activate(struct d3d_material
*material
) DECLSPEC_HIDDEN
;
443 struct d3d_material
*d3d_material_create(struct ddraw
*ddraw
) DECLSPEC_HIDDEN
;
445 /*****************************************************************************
446 * IDirect3DViewport - Wraps to D3D7
447 *****************************************************************************/
450 IDirect3DViewport3 IDirect3DViewport3_iface
;
453 /* IDirect3DViewport fields */
456 /* If this viewport is active for one device, put the device here */
457 struct d3d_device
*active_device
;
471 struct list light_list
;
472 struct d3d_material
*background
;
475 struct d3d_viewport
*unsafe_impl_from_IDirect3DViewport3(IDirect3DViewport3
*iface
) DECLSPEC_HIDDEN
;
476 struct d3d_viewport
*unsafe_impl_from_IDirect3DViewport2(IDirect3DViewport2
*iface
) DECLSPEC_HIDDEN
;
477 struct d3d_viewport
*unsafe_impl_from_IDirect3DViewport(IDirect3DViewport
*iface
) DECLSPEC_HIDDEN
;
479 /* Helper functions */
480 void viewport_activate(struct d3d_viewport
*viewport
, BOOL ignore_lights
) DECLSPEC_HIDDEN
;
481 void d3d_viewport_init(struct d3d_viewport
*viewport
, struct ddraw
*ddraw
) DECLSPEC_HIDDEN
;
483 /*****************************************************************************
484 * IDirect3DExecuteBuffer - Wraps to D3D7
485 *****************************************************************************/
486 struct d3d_execute_buffer
488 IDirect3DExecuteBuffer IDirect3DExecuteBuffer_iface
;
490 /* IDirect3DExecuteBuffer fields */
492 struct d3d_device
*d3ddev
;
494 D3DEXECUTEBUFFERDESC desc
;
497 /* This buffer will store the transformed vertices */
502 /* This flags is set to TRUE if we allocated ourselves the
508 HRESULT
d3d_execute_buffer_init(struct d3d_execute_buffer
*execute_buffer
,
509 struct d3d_device
*device
, D3DEXECUTEBUFFERDESC
*desc
) DECLSPEC_HIDDEN
;
510 struct d3d_execute_buffer
*unsafe_impl_from_IDirect3DExecuteBuffer(IDirect3DExecuteBuffer
*iface
) DECLSPEC_HIDDEN
;
512 /* The execute function */
513 HRESULT
d3d_execute_buffer_execute(struct d3d_execute_buffer
*execute_buffer
,
514 struct d3d_device
*device
, struct d3d_viewport
*viewport
) DECLSPEC_HIDDEN
;
516 /*****************************************************************************
517 * IDirect3DVertexBuffer
518 *****************************************************************************/
519 struct d3d_vertex_buffer
521 IDirect3DVertexBuffer7 IDirect3DVertexBuffer7_iface
;
522 IDirect3DVertexBuffer IDirect3DVertexBuffer_iface
;
525 /*** WineD3D and ddraw links ***/
526 struct wined3d_buffer
*wineD3DVertexBuffer
;
527 struct wined3d_vertex_declaration
*wineD3DVertexDeclaration
;
530 /*** Storage for D3D7 specific things ***/
535 HRESULT
d3d_vertex_buffer_create(struct d3d_vertex_buffer
**buffer
, struct ddraw
*ddraw
,
536 D3DVERTEXBUFFERDESC
*desc
) DECLSPEC_HIDDEN
;
537 struct d3d_vertex_buffer
*unsafe_impl_from_IDirect3DVertexBuffer(IDirect3DVertexBuffer
*iface
) DECLSPEC_HIDDEN
;
538 struct d3d_vertex_buffer
*unsafe_impl_from_IDirect3DVertexBuffer7(IDirect3DVertexBuffer7
*iface
) DECLSPEC_HIDDEN
;
540 /*****************************************************************************
541 * Helper functions from utils.c
542 *****************************************************************************/
544 #define GET_TEXCOUNT_FROM_FVF(d3dvtVertexType) \
545 (((d3dvtVertexType) & D3DFVF_TEXCOUNT_MASK) >> D3DFVF_TEXCOUNT_SHIFT)
547 #define GET_TEXCOORD_SIZE_FROM_FVF(d3dvtVertexType, tex_num) \
548 (((((d3dvtVertexType) >> (16 + (2 * (tex_num)))) + 1) & 0x03) + 1)
550 void PixelFormat_WineD3DtoDD(DDPIXELFORMAT
*DDPixelFormat
, enum wined3d_format_id WineD3DFormat
) DECLSPEC_HIDDEN
;
551 enum wined3d_format_id
PixelFormat_DD2WineD3D(const DDPIXELFORMAT
*DDPixelFormat
) DECLSPEC_HIDDEN
;
552 void DDRAW_dump_surface_desc(const DDSURFACEDESC2
*lpddsd
) DECLSPEC_HIDDEN
;
553 void dump_D3DMATRIX(const D3DMATRIX
*mat
) DECLSPEC_HIDDEN
;
554 void DDRAW_dump_DDCAPS(const DDCAPS
*lpcaps
) DECLSPEC_HIDDEN
;
555 DWORD
get_flexible_vertex_size(DWORD d3dvtVertexType
) DECLSPEC_HIDDEN
;
556 void DDRAW_dump_DDSCAPS2(const DDSCAPS2
*in
) DECLSPEC_HIDDEN
;
557 void DDRAW_dump_cooperativelevel(DWORD cooplevel
) DECLSPEC_HIDDEN
;
558 void DDSD_to_DDSD2(const DDSURFACEDESC
*in
, DDSURFACEDESC2
*out
) DECLSPEC_HIDDEN
;
559 void DDSD2_to_DDSD(const DDSURFACEDESC2
*in
, DDSURFACEDESC
*out
) DECLSPEC_HIDDEN
;
561 /* This only needs to be here as long the processvertices functionality of
562 * IDirect3DExecuteBuffer isn't in WineD3D */
563 void multiply_matrix(LPD3DMATRIX dest
, const D3DMATRIX
*src1
, const D3DMATRIX
*src2
) DECLSPEC_HIDDEN
;
565 /* Used for generic dumping */
572 #define FE(x) { x, #x }
578 void (*func
)(const void *);
583 #define ME(x,f,e) { x, #x, (void (*)(const void *))(f), offsetof(STRUCT, e) }
585 #define DD_STRUCT_COPY_BYSIZE_(to,from,from_size) \
587 DWORD __size = (to)->dwSize; \
588 DWORD __resetsize = min(__size, sizeof(*to)); \
589 DWORD __copysize = min(__resetsize, from_size); \
590 assert(to != from); \
591 memcpy(to, from, __copysize); \
592 memset((char*)(to) + __copysize, 0, __resetsize - __copysize); \
593 (to)->dwSize = __size; /* restore size */ \
596 #define DD_STRUCT_COPY_BYSIZE(to,from) DD_STRUCT_COPY_BYSIZE_(to,from,(from)->dwSize)
598 #define SIZEOF_END_PADDING(type, last_field) \
599 (sizeof(type) - offsetof(type, last_field) - sizeof(((type *)0)->last_field))
601 static inline void copy_to_surfacedesc2(DDSURFACEDESC2
*to
, DDSURFACEDESC2
*from
)
603 DWORD from_size
= from
->dwSize
;
604 if (from_size
== sizeof(DDSURFACEDESC
))
605 from_size
-= SIZEOF_END_PADDING(DDSURFACEDESC
, ddsCaps
);
606 to
->dwSize
= sizeof(DDSURFACEDESC2
); /* for struct copy */
607 DD_STRUCT_COPY_BYSIZE_(to
, from
, from_size
);
610 HRESULT
hr_ddraw_from_wined3d(HRESULT hr
) DECLSPEC_HIDDEN
;