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;
74 struct ddraw_surface *primary;
76 struct wined3d_surface *wined3d_frontbuffer;
77 struct wined3d_swapchain *wined3d_swapchain;
78 HWND swapchain_window;
80 /* DirectDraw things, which are not handled by WineD3D */
81 DWORD cooperative_level;
85 struct d3d_device *d3ddevice;
93 /* For the dll unload cleanup code */
94 struct list ddraw_list_entry;
95 /* The surface list - can't relay this to WineD3D
98 struct list surface_list;
101 struct FvfToDecl *decls;
102 UINT numConvertedDecls, declArraySize;
105 #define DDRAW_WINDOW_CLASS_NAME "DirectDrawDeviceWnd"
107 HRESULT ddraw_init(struct ddraw *ddraw, enum wined3d_device_type device_type) DECLSPEC_HIDDEN;
108 void ddraw_destroy_swapchain(struct ddraw *ddraw) DECLSPEC_HIDDEN;
110 static inline void ddraw_set_swapchain_window(struct ddraw *ddraw, HWND window)
112 if (window == GetDesktopWindow())
114 ddraw->swapchain_window = window;
117 /* Utility functions */
118 void DDRAW_Convert_DDSCAPS_1_To_2(const DDSCAPS *pIn, DDSCAPS2 *pOut) DECLSPEC_HIDDEN;
119 void DDRAW_Convert_DDDEVICEIDENTIFIER_2_To_1(const DDDEVICEIDENTIFIER2 *pIn, DDDEVICEIDENTIFIER *pOut) DECLSPEC_HIDDEN;
120 struct wined3d_vertex_declaration *ddraw_find_decl(struct ddraw *ddraw, DWORD fvf) DECLSPEC_HIDDEN;
122 /* The default surface type */
123 extern enum wined3d_surface_type DefaultSurfaceType DECLSPEC_HIDDEN;
125 /*****************************************************************************
126 * IDirectDrawSurface implementation structure
127 *****************************************************************************/
131 /* IUnknown fields */
132 IDirectDrawSurface7 IDirectDrawSurface7_iface;
133 IDirectDrawSurface4 IDirectDrawSurface4_iface;
134 IDirectDrawSurface3 IDirectDrawSurface3_iface;
135 IDirectDrawSurface2 IDirectDrawSurface2_iface;
136 IDirectDrawSurface IDirectDrawSurface_iface;
137 IDirectDrawGammaControl IDirectDrawGammaControl_iface;
138 IDirect3DTexture2 IDirect3DTexture2_iface;
139 IDirect3DTexture IDirect3DTexture_iface;
141 LONG ref7, ref4, ref3, ref2, ref1, iface_count, gamma_count;
142 IUnknown *ifaceToRelease;
143 IUnknown *texture_outer;
147 /* Connections to other Objects */
149 struct wined3d_surface *wined3d_surface;
150 struct wined3d_texture *wined3d_texture;
151 struct d3d_device *device1;
153 /* This implementation handles attaching surfaces to other surfaces */
154 struct ddraw_surface *next_attached;
155 struct ddraw_surface *first_attached;
156 IUnknown *attached_iface;
158 /* Complex surfaces are organized in a tree, although the tree is degenerated to a list in most cases.
159 * In mipmap and primary surfaces each level has only one attachment, which is the next surface level.
160 * Only the cube texture root has 6 surfaces attached, which then have a normal mipmap chain attached
161 * to them. So hardcode the array to 6, a dynamic array or a list would be an overkill.
163 #define MAX_COMPLEX_ATTACHED 6
164 struct ddraw_surface *complex_array[MAX_COMPLEX_ATTACHED];
165 /* You can't traverse the tree upwards. Only a flag for Surface::Release because its needed there,
166 * but no pointer to prevent temptations to traverse it in the wrong direction.
168 BOOL is_complex_root;
170 /* Surface description, for GetAttachedSurface */
171 DDSURFACEDESC2 surface_desc;
174 DWORD uniqueness_value;
177 /* Clipper objects */
178 struct ddraw_clipper *clipper;
180 /* For the ddraw surface list */
181 struct list surface_list_entry;
186 HRESULT ddraw_surface_create_texture(struct ddraw_surface *surface) DECLSPEC_HIDDEN;
187 HRESULT ddraw_surface_init(struct ddraw_surface *surface, struct ddraw *ddraw,
188 DDSURFACEDESC2 *desc, UINT version) DECLSPEC_HIDDEN;
189 ULONG ddraw_surface_release_iface(struct ddraw_surface *This) DECLSPEC_HIDDEN;
191 static inline struct ddraw_surface *impl_from_IDirect3DTexture(IDirect3DTexture *iface)
193 return CONTAINING_RECORD(iface, struct ddraw_surface, IDirect3DTexture_iface);
196 static inline struct ddraw_surface *impl_from_IDirect3DTexture2(IDirect3DTexture2 *iface)
198 return CONTAINING_RECORD(iface, struct ddraw_surface, IDirect3DTexture2_iface);
201 static inline struct ddraw_surface *impl_from_IDirectDrawSurface(IDirectDrawSurface *iface)
203 return CONTAINING_RECORD(iface, struct ddraw_surface, IDirectDrawSurface_iface);
206 static inline struct ddraw_surface *impl_from_IDirectDrawSurface2(IDirectDrawSurface2 *iface)
208 return CONTAINING_RECORD(iface, struct ddraw_surface, IDirectDrawSurface2_iface);
211 static inline struct ddraw_surface *impl_from_IDirectDrawSurface3(IDirectDrawSurface3 *iface)
213 return CONTAINING_RECORD(iface, struct ddraw_surface, IDirectDrawSurface3_iface);
216 static inline struct ddraw_surface *impl_from_IDirectDrawSurface4(IDirectDrawSurface4 *iface)
218 return CONTAINING_RECORD(iface, struct ddraw_surface, IDirectDrawSurface4_iface);
221 static inline struct ddraw_surface *impl_from_IDirectDrawSurface7(IDirectDrawSurface7 *iface)
223 return CONTAINING_RECORD(iface, struct ddraw_surface, IDirectDrawSurface7_iface);
226 struct ddraw_surface *unsafe_impl_from_IDirectDrawSurface(IDirectDrawSurface *iface) DECLSPEC_HIDDEN;
227 struct ddraw_surface *unsafe_impl_from_IDirectDrawSurface4(IDirectDrawSurface4 *iface) DECLSPEC_HIDDEN;
228 struct ddraw_surface *unsafe_impl_from_IDirectDrawSurface7(IDirectDrawSurface7 *iface) DECLSPEC_HIDDEN;
230 struct ddraw_surface *unsafe_impl_from_IDirect3DTexture(IDirect3DTexture *iface) DECLSPEC_HIDDEN;
231 struct ddraw_surface *unsafe_impl_from_IDirect3DTexture2(IDirect3DTexture2 *iface) DECLSPEC_HIDDEN;
233 #define DDRAW_INVALID_HANDLE ~0U
235 enum ddraw_handle_type
238 DDRAW_HANDLE_MATERIAL,
240 DDRAW_HANDLE_STATEBLOCK,
241 DDRAW_HANDLE_SURFACE,
244 struct ddraw_handle_entry
247 enum ddraw_handle_type type;
250 struct ddraw_handle_table
252 struct ddraw_handle_entry *entries;
253 struct ddraw_handle_entry *free_entries;
258 BOOL ddraw_handle_table_init(struct ddraw_handle_table *t, UINT initial_size) DECLSPEC_HIDDEN;
259 void ddraw_handle_table_destroy(struct ddraw_handle_table *t) DECLSPEC_HIDDEN;
260 DWORD ddraw_allocate_handle(struct ddraw_handle_table *t, void *object, enum ddraw_handle_type type) DECLSPEC_HIDDEN;
261 void *ddraw_free_handle(struct ddraw_handle_table *t, DWORD handle, enum ddraw_handle_type type) DECLSPEC_HIDDEN;
262 void *ddraw_get_object(struct ddraw_handle_table *t, DWORD handle, enum ddraw_handle_type type) DECLSPEC_HIDDEN;
267 IDirect3DDevice7 IDirect3DDevice7_iface;
268 IDirect3DDevice3 IDirect3DDevice3_iface;
269 IDirect3DDevice2 IDirect3DDevice2_iface;
270 IDirect3DDevice IDirect3DDevice_iface;
271 IUnknown IUnknown_inner;
275 IUnknown *outer_unknown;
276 struct wined3d_device *wined3d_device;
278 struct ddraw_surface *target;
280 struct wined3d_buffer *index_buffer;
281 UINT index_buffer_size;
282 UINT index_buffer_pos;
284 struct wined3d_buffer *vertex_buffer;
285 UINT vertex_buffer_size;
286 UINT vertex_buffer_pos;
288 /* Viewport management */
289 struct list viewport_list;
290 struct d3d_viewport *current_viewport;
291 D3DVIEWPORT7 active_viewport;
293 /* Required to keep track which of two available texture blending modes in d3ddevice3 is used */
294 BOOL legacyTextureBlending;
296 D3DMATRIX legacy_projection;
297 D3DMATRIX legacy_clipspace;
302 /* Rendering functions to wrap D3D(1-3) to D3D7 */
303 D3DPRIMITIVETYPE primitive_type;
307 LPBYTE sysmem_vertex_buffer;
311 /* Handle management */
312 struct ddraw_handle_table handle_table;
313 D3DMATRIXHANDLE world, proj, view;
316 HRESULT d3d_device_create(struct ddraw *ddraw, struct ddraw_surface *target,
317 UINT version, struct d3d_device **device, IUnknown *outer_unknown) DECLSPEC_HIDDEN;
318 enum wined3d_depth_buffer_type d3d_device_update_depth_stencil(struct d3d_device *device) DECLSPEC_HIDDEN;
321 extern const GUID IID_D3DDEVICE_WineD3D DECLSPEC_HIDDEN;
323 /* Helper functions */
324 HRESULT IDirect3DImpl_GetCaps(const struct wined3d *wined3d,
325 D3DDEVICEDESC *Desc123, D3DDEVICEDESC7 *Desc7) DECLSPEC_HIDDEN;
327 static inline struct d3d_device *impl_from_IDirect3DDevice(IDirect3DDevice *iface)
329 return CONTAINING_RECORD(iface, struct d3d_device, IDirect3DDevice_iface);
332 static inline struct d3d_device *impl_from_IDirect3DDevice2(IDirect3DDevice2 *iface)
334 return CONTAINING_RECORD(iface, struct d3d_device, IDirect3DDevice2_iface);
337 static inline struct d3d_device *impl_from_IDirect3DDevice3(IDirect3DDevice3 *iface)
339 return CONTAINING_RECORD(iface, struct d3d_device, IDirect3DDevice3_iface);
342 static inline struct d3d_device *impl_from_IDirect3DDevice7(IDirect3DDevice7 *iface)
344 return CONTAINING_RECORD(iface, struct d3d_device, IDirect3DDevice7_iface);
347 struct d3d_device *unsafe_impl_from_IDirect3DDevice(IDirect3DDevice *iface) DECLSPEC_HIDDEN;
348 struct d3d_device *unsafe_impl_from_IDirect3DDevice2(IDirect3DDevice2 *iface) DECLSPEC_HIDDEN;
349 struct d3d_device *unsafe_impl_from_IDirect3DDevice3(IDirect3DDevice3 *iface) DECLSPEC_HIDDEN;
350 struct d3d_device *unsafe_impl_from_IDirect3DDevice7(IDirect3DDevice7 *iface) DECLSPEC_HIDDEN;
354 IDirectDrawClipper IDirectDrawClipper_iface;
361 HRESULT ddraw_clipper_init(struct ddraw_clipper *clipper) DECLSPEC_HIDDEN;
362 struct ddraw_clipper *unsafe_impl_from_IDirectDrawClipper(IDirectDrawClipper *iface) DECLSPEC_HIDDEN;
364 /*****************************************************************************
365 * IDirectDrawPalette implementation structure
366 *****************************************************************************/
369 /* IUnknown fields */
370 IDirectDrawPalette IDirectDrawPalette_iface;
373 struct wined3d_palette *wineD3DPalette;
375 /* IDirectDrawPalette fields */
376 IUnknown *ifaceToRelease;
379 static inline struct ddraw_palette *impl_from_IDirectDrawPalette(IDirectDrawPalette *iface)
381 return CONTAINING_RECORD(iface, struct ddraw_palette, IDirectDrawPalette_iface);
384 struct ddraw_palette *unsafe_impl_from_IDirectDrawPalette(IDirectDrawPalette *iface) DECLSPEC_HIDDEN;
386 HRESULT ddraw_palette_init(struct ddraw_palette *palette,
387 struct ddraw *ddraw, DWORD flags, PALETTEENTRY *entries) DECLSPEC_HIDDEN;
389 /* Helper structures */
390 struct object_creation_info
393 HRESULT (*pfnCreateInstance)(IUnknown *pUnkOuter, REFIID riid,
397 /******************************************************************************
398 * IDirect3DLight implementation structure - Wraps to D3D7
399 ******************************************************************************/
402 IDirect3DLight IDirect3DLight_iface;
405 /* IDirect3DLight fields */
408 /* If this light is active for one viewport, put the viewport here */
409 struct d3d_viewport *active_viewport;
419 /* Helper functions */
420 void light_activate(struct d3d_light *light) DECLSPEC_HIDDEN;
421 void light_deactivate(struct d3d_light *light) DECLSPEC_HIDDEN;
422 void d3d_light_init(struct d3d_light *light, struct ddraw *ddraw) DECLSPEC_HIDDEN;
423 struct d3d_light *unsafe_impl_from_IDirect3DLight(IDirect3DLight *iface) DECLSPEC_HIDDEN;
425 /******************************************************************************
426 * IDirect3DMaterial implementation structure - Wraps to D3D7
427 ******************************************************************************/
430 IDirect3DMaterial3 IDirect3DMaterial3_iface;
431 IDirect3DMaterial2 IDirect3DMaterial2_iface;
432 IDirect3DMaterial IDirect3DMaterial_iface;
435 /* IDirect3DMaterial2 fields */
437 struct d3d_device *active_device;
443 /* Helper functions */
444 void material_activate(struct d3d_material *material) DECLSPEC_HIDDEN;
445 struct d3d_material *d3d_material_create(struct ddraw *ddraw) DECLSPEC_HIDDEN;
447 /*****************************************************************************
448 * IDirect3DViewport - Wraps to D3D7
449 *****************************************************************************/
452 IDirect3DViewport3 IDirect3DViewport3_iface;
455 /* IDirect3DViewport fields */
458 /* If this viewport is active for one device, put the device here */
459 struct d3d_device *active_device;
473 struct list light_list;
474 struct d3d_material *background;
477 struct d3d_viewport *unsafe_impl_from_IDirect3DViewport3(IDirect3DViewport3 *iface) DECLSPEC_HIDDEN;
478 struct d3d_viewport *unsafe_impl_from_IDirect3DViewport2(IDirect3DViewport2 *iface) DECLSPEC_HIDDEN;
479 struct d3d_viewport *unsafe_impl_from_IDirect3DViewport(IDirect3DViewport *iface) DECLSPEC_HIDDEN;
481 /* Helper functions */
482 void viewport_activate(struct d3d_viewport *viewport, BOOL ignore_lights) DECLSPEC_HIDDEN;
483 void d3d_viewport_init(struct d3d_viewport *viewport, struct ddraw *ddraw) DECLSPEC_HIDDEN;
485 /*****************************************************************************
486 * IDirect3DExecuteBuffer - Wraps to D3D7
487 *****************************************************************************/
488 struct d3d_execute_buffer
490 IDirect3DExecuteBuffer IDirect3DExecuteBuffer_iface;
492 /* IDirect3DExecuteBuffer fields */
494 struct d3d_device *d3ddev;
496 D3DEXECUTEBUFFERDESC desc;
499 /* This buffer will store the transformed vertices */
502 unsigned int nb_indices;
503 unsigned int nb_vertices;
505 /* This flags is set to TRUE if we allocated ourselves the
511 HRESULT d3d_execute_buffer_init(struct d3d_execute_buffer *execute_buffer,
512 struct d3d_device *device, D3DEXECUTEBUFFERDESC *desc) DECLSPEC_HIDDEN;
513 struct d3d_execute_buffer *unsafe_impl_from_IDirect3DExecuteBuffer(IDirect3DExecuteBuffer *iface) DECLSPEC_HIDDEN;
515 /* The execute function */
516 HRESULT d3d_execute_buffer_execute(struct d3d_execute_buffer *execute_buffer,
517 struct d3d_device *device, struct d3d_viewport *viewport) DECLSPEC_HIDDEN;
519 /*****************************************************************************
520 * IDirect3DVertexBuffer
521 *****************************************************************************/
522 struct d3d_vertex_buffer
524 IDirect3DVertexBuffer7 IDirect3DVertexBuffer7_iface;
525 IDirect3DVertexBuffer IDirect3DVertexBuffer_iface;
528 /*** WineD3D and ddraw links ***/
529 struct wined3d_buffer *wineD3DVertexBuffer;
530 struct wined3d_vertex_declaration *wineD3DVertexDeclaration;
533 /*** Storage for D3D7 specific things ***/
539 BOOL read_since_last_map;
542 HRESULT d3d_vertex_buffer_create(struct d3d_vertex_buffer **buffer, struct ddraw *ddraw,
543 D3DVERTEXBUFFERDESC *desc) DECLSPEC_HIDDEN;
544 struct d3d_vertex_buffer *unsafe_impl_from_IDirect3DVertexBuffer(IDirect3DVertexBuffer *iface) DECLSPEC_HIDDEN;
545 struct d3d_vertex_buffer *unsafe_impl_from_IDirect3DVertexBuffer7(IDirect3DVertexBuffer7 *iface) DECLSPEC_HIDDEN;
547 /*****************************************************************************
548 * Helper functions from utils.c
549 *****************************************************************************/
551 #define GET_TEXCOUNT_FROM_FVF(d3dvtVertexType) \
552 (((d3dvtVertexType) & D3DFVF_TEXCOUNT_MASK) >> D3DFVF_TEXCOUNT_SHIFT)
554 #define GET_TEXCOORD_SIZE_FROM_FVF(d3dvtVertexType, tex_num) \
555 (((((d3dvtVertexType) >> (16 + (2 * (tex_num)))) + 1) & 0x03) + 1)
557 void PixelFormat_WineD3DtoDD(DDPIXELFORMAT *DDPixelFormat, enum wined3d_format_id WineD3DFormat) DECLSPEC_HIDDEN;
558 enum wined3d_format_id PixelFormat_DD2WineD3D(const DDPIXELFORMAT *DDPixelFormat) DECLSPEC_HIDDEN;
559 void DDRAW_dump_surface_desc(const DDSURFACEDESC2 *lpddsd) DECLSPEC_HIDDEN;
560 void dump_D3DMATRIX(const D3DMATRIX *mat) DECLSPEC_HIDDEN;
561 void DDRAW_dump_DDCAPS(const DDCAPS *lpcaps) DECLSPEC_HIDDEN;
562 DWORD get_flexible_vertex_size(DWORD d3dvtVertexType) DECLSPEC_HIDDEN;
563 void DDRAW_dump_DDSCAPS2(const DDSCAPS2 *in) DECLSPEC_HIDDEN;
564 void DDRAW_dump_cooperativelevel(DWORD cooplevel) DECLSPEC_HIDDEN;
565 void DDSD_to_DDSD2(const DDSURFACEDESC *in, DDSURFACEDESC2 *out) DECLSPEC_HIDDEN;
566 void DDSD2_to_DDSD(const DDSURFACEDESC2 *in, DDSURFACEDESC *out) DECLSPEC_HIDDEN;
568 void multiply_matrix(D3DMATRIX *dst, const D3DMATRIX *src1, const D3DMATRIX *src2) DECLSPEC_HIDDEN;
570 /* Used for generic dumping */
577 #define FE(x) { x, #x }
583 void (*func)(const void *);
588 #define ME(x,f,e) { x, #x, (void (*)(const void *))(f), offsetof(STRUCT, e) }
590 #define DD_STRUCT_COPY_BYSIZE_(to,from,from_size) \
592 DWORD __size = (to)->dwSize; \
593 DWORD __resetsize = min(__size, sizeof(*to)); \
594 DWORD __copysize = min(__resetsize, from_size); \
595 assert(to != from); \
596 memcpy(to, from, __copysize); \
597 memset((char*)(to) + __copysize, 0, __resetsize - __copysize); \
598 (to)->dwSize = __size; /* restore size */ \
601 #define DD_STRUCT_COPY_BYSIZE(to,from) DD_STRUCT_COPY_BYSIZE_(to,from,(from)->dwSize)
603 #define SIZEOF_END_PADDING(type, last_field) \
604 (sizeof(type) - offsetof(type, last_field) - sizeof(((type *)0)->last_field))
606 static inline void copy_to_surfacedesc2(DDSURFACEDESC2 *to, DDSURFACEDESC2 *from)
608 DWORD from_size = from->dwSize;
609 if (from_size == sizeof(DDSURFACEDESC))
610 from_size -= SIZEOF_END_PADDING(DDSURFACEDESC, ddsCaps);
611 to->dwSize = sizeof(DDSURFACEDESC2); /* for struct copy */
612 DD_STRUCT_COPY_BYSIZE_(to, from, from_size);
615 HRESULT hr_ddraw_from_wined3d(HRESULT hr) DECLSPEC_HIDDEN;