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
;
52 #define DDRAW_INITIALIZED 0x00000001
53 #define DDRAW_D3D_INITIALIZED 0x00000002
54 #define DDRAW_RESTORE_MODE 0x00000004
55 #define DDRAW_NO3D 0x00000008
56 #define DDRAW_SCL_DDRAW1 0x00000010
61 IDirectDraw7 IDirectDraw7_iface
;
62 IDirectDraw4 IDirectDraw4_iface
;
63 IDirectDraw2 IDirectDraw2_iface
;
64 IDirectDraw IDirectDraw_iface
;
65 IDirect3D7 IDirect3D7_iface
;
66 IDirect3D3 IDirect3D3_iface
;
67 IDirect3D2 IDirect3D2_iface
;
68 IDirect3D IDirect3D_iface
;
69 struct wined3d_device_parent device_parent
;
71 /* See comment in IDirectDraw::AddRef */
72 LONG ref7
, ref4
, ref2
, ref3
, ref1
, numIfaces
;
74 struct wined3d
*wined3d
;
75 struct wined3d_device
*wined3d_device
;
78 struct ddraw_surface
*primary
;
80 struct wined3d_surface
*wined3d_frontbuffer
;
81 struct wined3d_swapchain
*wined3d_swapchain
;
82 HWND swapchain_window
;
84 /* DirectDraw things, which are not handled by WineD3D */
85 DWORD cooperative_level
;
89 struct d3d_device
*d3ddevice
;
97 /* For the dll unload cleanup code */
98 struct list ddraw_list_entry
;
99 /* The surface list - can't relay this to WineD3D
102 struct list surface_list
;
105 struct FvfToDecl
*decls
;
106 UINT numConvertedDecls
, declArraySize
;
109 #define DDRAW_WINDOW_CLASS_NAME "DirectDrawDeviceWnd"
111 HRESULT
ddraw_init(struct ddraw
*ddraw
, enum wined3d_device_type device_type
) DECLSPEC_HIDDEN
;
112 void ddraw_destroy_swapchain(struct ddraw
*ddraw
) DECLSPEC_HIDDEN
;
114 static inline void ddraw_set_swapchain_window(struct ddraw
*ddraw
, HWND window
)
116 if (window
== GetDesktopWindow())
118 ddraw
->swapchain_window
= window
;
121 /* Utility functions */
122 void DDRAW_Convert_DDSCAPS_1_To_2(const DDSCAPS
*pIn
, DDSCAPS2
*pOut
) DECLSPEC_HIDDEN
;
123 void DDRAW_Convert_DDDEVICEIDENTIFIER_2_To_1(const DDDEVICEIDENTIFIER2
*pIn
, DDDEVICEIDENTIFIER
*pOut
) DECLSPEC_HIDDEN
;
124 struct wined3d_vertex_declaration
*ddraw_find_decl(struct ddraw
*ddraw
, DWORD fvf
) DECLSPEC_HIDDEN
;
128 /* IUnknown fields */
129 IDirectDrawSurface7 IDirectDrawSurface7_iface
;
130 IDirectDrawSurface4 IDirectDrawSurface4_iface
;
131 IDirectDrawSurface3 IDirectDrawSurface3_iface
;
132 IDirectDrawSurface2 IDirectDrawSurface2_iface
;
133 IDirectDrawSurface IDirectDrawSurface_iface
;
134 IDirectDrawGammaControl IDirectDrawGammaControl_iface
;
135 IDirect3DTexture2 IDirect3DTexture2_iface
;
136 IDirect3DTexture IDirect3DTexture_iface
;
138 LONG ref7
, ref4
, ref3
, ref2
, ref1
, iface_count
, gamma_count
;
139 IUnknown
*ifaceToRelease
;
140 IUnknown
*texture_outer
;
144 /* Connections to other Objects */
146 struct wined3d_surface
*wined3d_surface
;
147 struct wined3d_texture
*wined3d_texture
;
148 struct d3d_device
*device1
;
150 /* This implementation handles attaching surfaces to other surfaces */
151 struct ddraw_surface
*next_attached
;
152 struct ddraw_surface
*first_attached
;
153 IUnknown
*attached_iface
;
155 /* Complex surfaces are organized in a tree, although the tree is degenerated to a list in most cases.
156 * In mipmap and primary surfaces each level has only one attachment, which is the next surface level.
157 * Only the cube texture root has 6 surfaces attached, which then have a normal mipmap chain attached
158 * to them. So hardcode the array to 6, a dynamic array or a list would be an overkill.
160 #define MAX_COMPLEX_ATTACHED 6
161 struct ddraw_surface
*complex_array
[MAX_COMPLEX_ATTACHED
];
162 /* You can't traverse the tree upwards. Only a flag for Surface::Release because its needed there,
163 * but no pointer to prevent temptations to traverse it in the wrong direction.
165 BOOL is_complex_root
;
167 /* Surface description, for GetAttachedSurface */
168 DDSURFACEDESC2 surface_desc
;
171 DWORD uniqueness_value
;
174 /* Clipper objects */
175 struct ddraw_clipper
*clipper
;
177 /* For the ddraw surface list */
178 struct list surface_list_entry
;
183 HRESULT
ddraw_surface_create_texture(struct ddraw_surface
*surface
, DWORD surface_flags
) DECLSPEC_HIDDEN
;
184 HRESULT
ddraw_surface_init(struct ddraw_surface
*surface
, struct ddraw
*ddraw
,
185 DDSURFACEDESC2
*desc
, DWORD flags
, UINT version
) DECLSPEC_HIDDEN
;
186 ULONG
ddraw_surface_release_iface(struct ddraw_surface
*This
) DECLSPEC_HIDDEN
;
188 static inline struct ddraw_surface
*impl_from_IDirect3DTexture(IDirect3DTexture
*iface
)
190 return CONTAINING_RECORD(iface
, struct ddraw_surface
, IDirect3DTexture_iface
);
193 static inline struct ddraw_surface
*impl_from_IDirect3DTexture2(IDirect3DTexture2
*iface
)
195 return CONTAINING_RECORD(iface
, struct ddraw_surface
, IDirect3DTexture2_iface
);
198 static inline struct ddraw_surface
*impl_from_IDirectDrawSurface(IDirectDrawSurface
*iface
)
200 return CONTAINING_RECORD(iface
, struct ddraw_surface
, IDirectDrawSurface_iface
);
203 static inline struct ddraw_surface
*impl_from_IDirectDrawSurface2(IDirectDrawSurface2
*iface
)
205 return CONTAINING_RECORD(iface
, struct ddraw_surface
, IDirectDrawSurface2_iface
);
208 static inline struct ddraw_surface
*impl_from_IDirectDrawSurface3(IDirectDrawSurface3
*iface
)
210 return CONTAINING_RECORD(iface
, struct ddraw_surface
, IDirectDrawSurface3_iface
);
213 static inline struct ddraw_surface
*impl_from_IDirectDrawSurface4(IDirectDrawSurface4
*iface
)
215 return CONTAINING_RECORD(iface
, struct ddraw_surface
, IDirectDrawSurface4_iface
);
218 static inline struct ddraw_surface
*impl_from_IDirectDrawSurface7(IDirectDrawSurface7
*iface
)
220 return CONTAINING_RECORD(iface
, struct ddraw_surface
, IDirectDrawSurface7_iface
);
223 struct ddraw_surface
*unsafe_impl_from_IDirectDrawSurface(IDirectDrawSurface
*iface
) DECLSPEC_HIDDEN
;
224 struct ddraw_surface
*unsafe_impl_from_IDirectDrawSurface4(IDirectDrawSurface4
*iface
) DECLSPEC_HIDDEN
;
225 struct ddraw_surface
*unsafe_impl_from_IDirectDrawSurface7(IDirectDrawSurface7
*iface
) DECLSPEC_HIDDEN
;
227 struct ddraw_surface
*unsafe_impl_from_IDirect3DTexture(IDirect3DTexture
*iface
) DECLSPEC_HIDDEN
;
228 struct ddraw_surface
*unsafe_impl_from_IDirect3DTexture2(IDirect3DTexture2
*iface
) DECLSPEC_HIDDEN
;
230 #define DDRAW_INVALID_HANDLE ~0U
232 enum ddraw_handle_type
235 DDRAW_HANDLE_MATERIAL
,
237 DDRAW_HANDLE_STATEBLOCK
,
238 DDRAW_HANDLE_SURFACE
,
241 struct ddraw_handle_entry
244 enum ddraw_handle_type type
;
247 struct ddraw_handle_table
249 struct ddraw_handle_entry
*entries
;
250 struct ddraw_handle_entry
*free_entries
;
255 BOOL
ddraw_handle_table_init(struct ddraw_handle_table
*t
, UINT initial_size
) DECLSPEC_HIDDEN
;
256 void ddraw_handle_table_destroy(struct ddraw_handle_table
*t
) DECLSPEC_HIDDEN
;
257 DWORD
ddraw_allocate_handle(struct ddraw_handle_table
*t
, void *object
, enum ddraw_handle_type type
) DECLSPEC_HIDDEN
;
258 void *ddraw_free_handle(struct ddraw_handle_table
*t
, DWORD handle
, enum ddraw_handle_type type
) DECLSPEC_HIDDEN
;
259 void *ddraw_get_object(struct ddraw_handle_table
*t
, DWORD handle
, enum ddraw_handle_type type
) DECLSPEC_HIDDEN
;
264 IDirect3DDevice7 IDirect3DDevice7_iface
;
265 IDirect3DDevice3 IDirect3DDevice3_iface
;
266 IDirect3DDevice2 IDirect3DDevice2_iface
;
267 IDirect3DDevice IDirect3DDevice_iface
;
268 IUnknown IUnknown_inner
;
272 IUnknown
*outer_unknown
;
273 struct wined3d_device
*wined3d_device
;
275 struct ddraw_surface
*target
;
277 struct wined3d_buffer
*index_buffer
;
278 UINT index_buffer_size
;
279 UINT index_buffer_pos
;
281 struct wined3d_buffer
*vertex_buffer
;
282 UINT vertex_buffer_size
;
283 UINT vertex_buffer_pos
;
285 /* Viewport management */
286 struct list viewport_list
;
287 struct d3d_viewport
*current_viewport
;
288 D3DVIEWPORT7 active_viewport
;
290 /* Required to keep track which of two available texture blending modes in d3ddevice3 is used */
291 BOOL legacyTextureBlending
;
293 D3DMATRIX legacy_projection
;
294 D3DMATRIX legacy_clipspace
;
299 /* Rendering functions to wrap D3D(1-3) to D3D7 */
300 D3DPRIMITIVETYPE primitive_type
;
304 LPBYTE sysmem_vertex_buffer
;
308 /* Handle management */
309 struct ddraw_handle_table handle_table
;
310 D3DMATRIXHANDLE world
, proj
, view
;
313 HRESULT
d3d_device_create(struct ddraw
*ddraw
, struct ddraw_surface
*target
,
314 UINT version
, struct d3d_device
**device
, IUnknown
*outer_unknown
) DECLSPEC_HIDDEN
;
315 enum wined3d_depth_buffer_type
d3d_device_update_depth_stencil(struct d3d_device
*device
) DECLSPEC_HIDDEN
;
318 extern const GUID IID_D3DDEVICE_WineD3D DECLSPEC_HIDDEN
;
320 /* Helper functions */
321 HRESULT
IDirect3DImpl_GetCaps(const struct wined3d
*wined3d
,
322 D3DDEVICEDESC
*Desc123
, D3DDEVICEDESC7
*Desc7
) DECLSPEC_HIDDEN
;
324 static inline struct d3d_device
*impl_from_IDirect3DDevice(IDirect3DDevice
*iface
)
326 return CONTAINING_RECORD(iface
, struct d3d_device
, IDirect3DDevice_iface
);
329 static inline struct d3d_device
*impl_from_IDirect3DDevice2(IDirect3DDevice2
*iface
)
331 return CONTAINING_RECORD(iface
, struct d3d_device
, IDirect3DDevice2_iface
);
334 static inline struct d3d_device
*impl_from_IDirect3DDevice3(IDirect3DDevice3
*iface
)
336 return CONTAINING_RECORD(iface
, struct d3d_device
, IDirect3DDevice3_iface
);
339 static inline struct d3d_device
*impl_from_IDirect3DDevice7(IDirect3DDevice7
*iface
)
341 return CONTAINING_RECORD(iface
, struct d3d_device
, IDirect3DDevice7_iface
);
344 struct d3d_device
*unsafe_impl_from_IDirect3DDevice(IDirect3DDevice
*iface
) DECLSPEC_HIDDEN
;
345 struct d3d_device
*unsafe_impl_from_IDirect3DDevice2(IDirect3DDevice2
*iface
) DECLSPEC_HIDDEN
;
346 struct d3d_device
*unsafe_impl_from_IDirect3DDevice3(IDirect3DDevice3
*iface
) DECLSPEC_HIDDEN
;
347 struct d3d_device
*unsafe_impl_from_IDirect3DDevice7(IDirect3DDevice7
*iface
) DECLSPEC_HIDDEN
;
351 IDirectDrawClipper IDirectDrawClipper_iface
;
358 HRESULT
ddraw_clipper_init(struct ddraw_clipper
*clipper
) DECLSPEC_HIDDEN
;
359 struct ddraw_clipper
*unsafe_impl_from_IDirectDrawClipper(IDirectDrawClipper
*iface
) DECLSPEC_HIDDEN
;
361 /*****************************************************************************
362 * IDirectDrawPalette implementation structure
363 *****************************************************************************/
366 /* IUnknown fields */
367 IDirectDrawPalette IDirectDrawPalette_iface
;
370 struct wined3d_palette
*wineD3DPalette
;
372 /* IDirectDrawPalette fields */
373 IUnknown
*ifaceToRelease
;
376 static inline struct ddraw_palette
*impl_from_IDirectDrawPalette(IDirectDrawPalette
*iface
)
378 return CONTAINING_RECORD(iface
, struct ddraw_palette
, IDirectDrawPalette_iface
);
381 struct ddraw_palette
*unsafe_impl_from_IDirectDrawPalette(IDirectDrawPalette
*iface
) DECLSPEC_HIDDEN
;
383 HRESULT
ddraw_palette_init(struct ddraw_palette
*palette
,
384 struct ddraw
*ddraw
, DWORD flags
, PALETTEENTRY
*entries
) DECLSPEC_HIDDEN
;
386 /* Helper structures */
387 struct object_creation_info
390 HRESULT (*pfnCreateInstance
)(IUnknown
*pUnkOuter
, REFIID riid
,
394 /******************************************************************************
395 * IDirect3DLight implementation structure - Wraps to D3D7
396 ******************************************************************************/
399 IDirect3DLight IDirect3DLight_iface
;
402 /* IDirect3DLight fields */
405 /* If this light is active for one viewport, put the viewport here */
406 struct d3d_viewport
*active_viewport
;
416 /* Helper functions */
417 void light_activate(struct d3d_light
*light
) DECLSPEC_HIDDEN
;
418 void light_deactivate(struct d3d_light
*light
) DECLSPEC_HIDDEN
;
419 void d3d_light_init(struct d3d_light
*light
, struct ddraw
*ddraw
) DECLSPEC_HIDDEN
;
420 struct d3d_light
*unsafe_impl_from_IDirect3DLight(IDirect3DLight
*iface
) DECLSPEC_HIDDEN
;
422 /******************************************************************************
423 * IDirect3DMaterial implementation structure - Wraps to D3D7
424 ******************************************************************************/
427 IDirect3DMaterial3 IDirect3DMaterial3_iface
;
428 IDirect3DMaterial2 IDirect3DMaterial2_iface
;
429 IDirect3DMaterial IDirect3DMaterial_iface
;
432 /* IDirect3DMaterial2 fields */
434 struct d3d_device
*active_device
;
440 /* Helper functions */
441 void material_activate(struct d3d_material
*material
) DECLSPEC_HIDDEN
;
442 struct d3d_material
*d3d_material_create(struct ddraw
*ddraw
) DECLSPEC_HIDDEN
;
444 /*****************************************************************************
445 * IDirect3DViewport - Wraps to D3D7
446 *****************************************************************************/
449 IDirect3DViewport3 IDirect3DViewport3_iface
;
452 /* IDirect3DViewport fields */
455 /* If this viewport is active for one device, put the device here */
456 struct d3d_device
*active_device
;
470 struct list light_list
;
471 struct d3d_material
*background
;
474 struct d3d_viewport
*unsafe_impl_from_IDirect3DViewport3(IDirect3DViewport3
*iface
) DECLSPEC_HIDDEN
;
475 struct d3d_viewport
*unsafe_impl_from_IDirect3DViewport2(IDirect3DViewport2
*iface
) DECLSPEC_HIDDEN
;
476 struct d3d_viewport
*unsafe_impl_from_IDirect3DViewport(IDirect3DViewport
*iface
) DECLSPEC_HIDDEN
;
478 /* Helper functions */
479 void viewport_activate(struct d3d_viewport
*viewport
, BOOL ignore_lights
) DECLSPEC_HIDDEN
;
480 void d3d_viewport_init(struct d3d_viewport
*viewport
, struct ddraw
*ddraw
) DECLSPEC_HIDDEN
;
482 /*****************************************************************************
483 * IDirect3DExecuteBuffer - Wraps to D3D7
484 *****************************************************************************/
485 struct d3d_execute_buffer
487 IDirect3DExecuteBuffer IDirect3DExecuteBuffer_iface
;
489 /* IDirect3DExecuteBuffer fields */
491 struct d3d_device
*d3ddev
;
493 D3DEXECUTEBUFFERDESC desc
;
496 /* This buffer will store the transformed vertices */
499 unsigned int nb_indices
;
500 unsigned int nb_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 ***/
536 BOOL read_since_last_map
;
539 HRESULT
d3d_vertex_buffer_create(struct d3d_vertex_buffer
**buffer
, struct ddraw
*ddraw
,
540 D3DVERTEXBUFFERDESC
*desc
) DECLSPEC_HIDDEN
;
541 struct d3d_vertex_buffer
*unsafe_impl_from_IDirect3DVertexBuffer(IDirect3DVertexBuffer
*iface
) DECLSPEC_HIDDEN
;
542 struct d3d_vertex_buffer
*unsafe_impl_from_IDirect3DVertexBuffer7(IDirect3DVertexBuffer7
*iface
) DECLSPEC_HIDDEN
;
544 /*****************************************************************************
545 * Helper functions from utils.c
546 *****************************************************************************/
548 #define GET_TEXCOUNT_FROM_FVF(d3dvtVertexType) \
549 (((d3dvtVertexType) & D3DFVF_TEXCOUNT_MASK) >> D3DFVF_TEXCOUNT_SHIFT)
551 #define GET_TEXCOORD_SIZE_FROM_FVF(d3dvtVertexType, tex_num) \
552 (((((d3dvtVertexType) >> (16 + (2 * (tex_num)))) + 1) & 0x03) + 1)
554 void PixelFormat_WineD3DtoDD(DDPIXELFORMAT
*DDPixelFormat
, enum wined3d_format_id WineD3DFormat
) DECLSPEC_HIDDEN
;
555 enum wined3d_format_id
PixelFormat_DD2WineD3D(const DDPIXELFORMAT
*DDPixelFormat
) DECLSPEC_HIDDEN
;
556 void DDRAW_dump_surface_desc(const DDSURFACEDESC2
*lpddsd
) DECLSPEC_HIDDEN
;
557 void dump_D3DMATRIX(const D3DMATRIX
*mat
) DECLSPEC_HIDDEN
;
558 void DDRAW_dump_DDCAPS(const DDCAPS
*lpcaps
) DECLSPEC_HIDDEN
;
559 DWORD
get_flexible_vertex_size(DWORD d3dvtVertexType
) DECLSPEC_HIDDEN
;
560 void DDRAW_dump_DDSCAPS2(const DDSCAPS2
*in
) DECLSPEC_HIDDEN
;
561 void DDRAW_dump_cooperativelevel(DWORD cooplevel
) DECLSPEC_HIDDEN
;
562 void DDSD_to_DDSD2(const DDSURFACEDESC
*in
, DDSURFACEDESC2
*out
) DECLSPEC_HIDDEN
;
563 void DDSD2_to_DDSD(const DDSURFACEDESC2
*in
, DDSURFACEDESC
*out
) DECLSPEC_HIDDEN
;
565 void multiply_matrix(D3DMATRIX
*dst
, const D3DMATRIX
*src1
, const D3DMATRIX
*src2
) DECLSPEC_HIDDEN
;
567 /* Used for generic dumping */
574 #define FE(x) { x, #x }
580 void (*func
)(const void *);
585 #define ME(x,f,e) { x, #x, (void (*)(const void *))(f), offsetof(STRUCT, e) }
587 #define DD_STRUCT_COPY_BYSIZE_(to,from,from_size) \
589 DWORD __size = (to)->dwSize; \
590 DWORD __resetsize = min(__size, sizeof(*to)); \
591 DWORD __copysize = min(__resetsize, from_size); \
592 assert(to != from); \
593 memcpy(to, from, __copysize); \
594 memset((char*)(to) + __copysize, 0, __resetsize - __copysize); \
595 (to)->dwSize = __size; /* restore size */ \
598 #define DD_STRUCT_COPY_BYSIZE(to,from) DD_STRUCT_COPY_BYSIZE_(to,from,(from)->dwSize)
600 #define SIZEOF_END_PADDING(type, last_field) \
601 (sizeof(type) - offsetof(type, last_field) - sizeof(((type *)0)->last_field))
603 static inline void copy_to_surfacedesc2(DDSURFACEDESC2
*to
, DDSURFACEDESC2
*from
)
605 DWORD from_size
= from
->dwSize
;
606 if (from_size
== sizeof(DDSURFACEDESC
))
607 from_size
-= SIZEOF_END_PADDING(DDSURFACEDESC
, ddsCaps
);
608 to
->dwSize
= sizeof(DDSURFACEDESC2
); /* for struct copy */
609 DD_STRUCT_COPY_BYSIZE_(to
, from
, from_size
);
612 HRESULT
hr_ddraw_from_wined3d(HRESULT hr
) DECLSPEC_HIDDEN
;