1 /* User-based primary surface driver
3 * Copyright 2000-2001 TransGaming Technologies Inc.
5 * This library is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU Lesser General Public
7 * License as published by the Free Software Foundation; either
8 * version 2.1 of the License, or (at your option) any later version.
10 * This library is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * Lesser General Public License for more details.
15 * You should have received a copy of the GNU Lesser General Public
16 * License along with this library; if not, write to the Free Software
17 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
29 #include "wine/debug.h"
30 #include "ddraw_private.h"
32 WINE_DEFAULT_DEBUG_CHANNEL(ddraw);
34 /* if you use OWN_WINDOW, don't use SYNC_UPDATE, or you may get trouble */
35 /* #define SYNC_UPDATE */
37 * FIXME: This does not work any more because the created window has its own
38 * thread queue that cannot be manipulated by application threads.
43 static void User_create_own_window(IDirectDrawSurfaceImpl* This);
44 static void User_destroy_own_window(IDirectDrawSurfaceImpl* This);
47 static DWORD CALLBACK User_update_thread(LPVOID);
49 static void User_copy_to_screen(IDirectDrawSurfaceImpl* This, LPCRECT rc);
51 static HWND get_display_window(IDirectDrawSurfaceImpl* This, LPPOINT pt);
53 static const IDirectDrawSurface7Vtbl User_IDirectDrawSurface7_VTable;
56 User_DirectDrawSurface_Construct(IDirectDrawSurfaceImpl* This,
58 const DDSURFACEDESC2* pDDSD)
60 USER_PRIV_VAR(priv, This);
63 TRACE("(%p,%p,%p)\n",This,pDD,pDDSD);
64 hr = DIB_DirectDrawSurface_Construct(This, pDD, pDDSD);
65 if (FAILED(hr)) return hr;
67 ICOM_INIT_INTERFACE(This, IDirectDrawSurface7,
68 User_IDirectDrawSurface7_VTable);
70 This->final_release = User_DirectDrawSurface_final_release;
71 This->duplicate_surface = User_DirectDrawSurface_duplicate_surface;
73 This->lock_update = User_DirectDrawSurface_lock_update;
74 This->unlock_update = User_DirectDrawSurface_unlock_update;
76 This->flip_data = User_DirectDrawSurface_flip_data;
77 This->flip_update = User_DirectDrawSurface_flip_update;
79 This->get_dc = User_DirectDrawSurface_get_dc;
80 This->release_dc = User_DirectDrawSurface_release_dc;
82 This->set_palette = User_DirectDrawSurface_set_palette;
83 This->update_palette = User_DirectDrawSurface_update_palette;
85 This->get_gamma_ramp = User_DirectDrawSurface_get_gamma_ramp;
86 This->set_gamma_ramp = User_DirectDrawSurface_set_gamma_ramp;
88 This->get_display_window = User_DirectDrawSurface_get_display_window;
90 if (This->surface_desc.ddsCaps.dwCaps & DDSCAPS_PRIMARYSURFACE)
93 DirectDrawSurface_RegisterClass();
96 InitializeCriticalSection(&priv->user.crit);
97 priv->user.refresh_event = CreateEventW(NULL, TRUE, FALSE, NULL);
98 priv->user.update_event = CreateEventW(NULL, FALSE, FALSE, NULL);
99 priv->user.update_thread = CreateThread(NULL, 0, User_update_thread, This, 0, NULL);
101 if (This->ddraw_owner->cooperative_level & DDSCL_FULLSCREEN) {
102 /* wait for window creation (or update thread destruction) */
103 while (WaitForMultipleObjects(1, &priv->user.update_thread, FALSE, 100) == WAIT_TIMEOUT)
104 if (This->more.lpDDRAWReserved) break;
105 if (!This->more.lpDDRAWReserved) {
106 ERR("window creation failed\n");
112 User_create_own_window(This);
115 if (!This->more.lpDDRAWReserved)
116 This->more.lpDDRAWReserved = (LPVOID)pDD->window;
119 return DIB_DirectDrawSurface_alloc_dc(This, &priv->user.cached_dc);
123 User_DirectDrawSurface_Create(IDirectDrawImpl *pDD,
124 const DDSURFACEDESC2 *pDDSD,
125 LPDIRECTDRAWSURFACE7 *ppSurf,
128 IDirectDrawSurfaceImpl* This;
130 assert(pUnkOuter == NULL);
132 This = HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY,
133 sizeof(*This) + sizeof(User_DirectDrawSurfaceImpl));
134 if (This == NULL) return E_OUTOFMEMORY;
136 This->private = (User_DirectDrawSurfaceImpl*)(This+1);
138 hr = User_DirectDrawSurface_Construct(This, pDD, pDDSD);
140 HeapFree(GetProcessHeap(), 0, This);
142 *ppSurf = ICOM_INTERFACE(This, IDirectDrawSurface7);
147 void User_DirectDrawSurface_final_release(IDirectDrawSurfaceImpl* This)
149 USER_PRIV_VAR(priv, This);
151 if (This->surface_desc.ddsCaps.dwCaps & DDSCAPS_PRIMARYSURFACE)
154 HANDLE event = priv->user.update_event;
155 priv->user.update_event = 0;
157 TRACE("waiting for update thread to terminate...\n");
159 /* dispatch any waiting sendmessages */
162 PeekMessageA(&msg, 0, 0, 0, PM_NOREMOVE);
164 /* to avoid deadlocks, allow SendMessages from update thread
165 * through while we wait for it */
166 while (MsgWaitForMultipleObjects(1, &priv->user.update_thread, FALSE,
167 INFINITE, QS_SENDMESSAGE) == WAIT_OBJECT_0+1)
170 PeekMessageA(&msg, 0, 0, 0, PM_NOREMOVE);
173 WaitForSingleObject(priv->user.update_thread,INFINITE);
175 TRACE("update thread terminated\n");
177 CloseHandle(priv->user.update_thread);
178 CloseHandle(priv->user.refresh_event);
179 DeleteCriticalSection(&priv->user.crit);
182 User_destroy_own_window(This);
185 This->more.lpDDRAWReserved = 0;
187 DirectDrawSurface_UnregisterClass();
190 DIB_DirectDrawSurface_free_dc(This, priv->user.cached_dc);
191 DIB_DirectDrawSurface_final_release(This);
194 static int User_DirectDrawSurface_init_wait(IDirectDrawSurfaceImpl* This)
196 USER_PRIV_VAR(priv, This);
198 EnterCriticalSection(&priv->user.crit);
199 priv->user.wait_count++;
200 need_wait = priv->user.in_refresh;
201 LeaveCriticalSection(&priv->user.crit);
205 static void User_DirectDrawSurface_end_wait(IDirectDrawSurfaceImpl* This)
207 USER_PRIV_VAR(priv, This);
208 EnterCriticalSection(&priv->user.crit);
209 if (!--priv->user.wait_count)
210 ResetEvent(priv->user.refresh_event);
211 LeaveCriticalSection(&priv->user.crit);
214 static void User_DirectDrawSurface_wait_update(IDirectDrawSurfaceImpl* This)
216 USER_PRIV_VAR(priv, This);
217 if (priv->user.in_refresh) {
218 if (User_DirectDrawSurface_init_wait(This))
219 WaitForSingleObject(priv->user.refresh_event, 2);
220 User_DirectDrawSurface_end_wait(This);
224 void User_DirectDrawSurface_lock_update(IDirectDrawSurfaceImpl* This,
225 LPCRECT pRect, DWORD dwFlags)
228 if (!(dwFlags & DDLOCK_WRITEONLY))
229 User_copy_from_screen(This, pRect);
231 if (dwFlags & DDLOCK_WAIT) User_DirectDrawSurface_wait_update(This);
234 This->lastlockrect = *pRect;
236 This->lastlockrect.left = This->lastlockrect.right = 0;
240 void User_DirectDrawSurface_unlock_update(IDirectDrawSurfaceImpl* This,
243 if (This->surface_desc.ddsCaps.dwCaps & DDSCAPS_PRIMARYSURFACE)
246 User_copy_to_screen(This, pRect);
248 USER_PRIV_VAR(priv, This);
249 SetEvent(priv->user.update_event);
254 void User_DirectDrawSurface_set_palette(IDirectDrawSurfaceImpl* This,
255 IDirectDrawPaletteImpl* pal)
257 USER_PRIV_VAR(priv, This);
260 FIXME("selecting null palette\n");
261 /* I don't think selecting GDI object 0 will work, we should select
262 * the original palette, returned by the first SelectPalette */
263 SelectPalette(priv->user.cached_dc, 0, FALSE);
267 SelectPalette(priv->user.cached_dc, pal->hpal, FALSE);
269 DIB_DirectDrawSurface_set_palette(This, pal);
272 void User_DirectDrawSurface_update_palette(IDirectDrawSurfaceImpl* This,
273 IDirectDrawPaletteImpl* pal,
274 DWORD dwStart, DWORD dwCount,
275 LPPALETTEENTRY palent)
278 USER_PRIV_VAR(priv, This);
281 DIB_DirectDrawSurface_update_palette(This, pal, dwStart, dwCount, palent);
282 /* FIXME: realize palette on display window */
285 /* with async updates, it's probably cool to force an update */
286 SetEvent(priv->user.update_event);
290 HRESULT User_DirectDrawSurface_duplicate_surface(IDirectDrawSurfaceImpl* This,
291 LPDIRECTDRAWSURFACE7* ppDup)
293 return User_DirectDrawSurface_Create(This->ddraw_owner,
294 &This->surface_desc, ppDup, NULL);
297 BOOL User_DirectDrawSurface_flip_data(IDirectDrawSurfaceImpl* front,
298 IDirectDrawSurfaceImpl* back,
301 USER_PRIV_VAR(front_priv, front);
302 USER_PRIV_VAR(back_priv, back);
306 tmp = front_priv->user.cached_dc;
307 front_priv->user.cached_dc = back_priv->user.cached_dc;
308 back_priv->user.cached_dc = tmp;
311 return DIB_DirectDrawSurface_flip_data(front, back, dwFlags);
314 void User_DirectDrawSurface_flip_update(IDirectDrawSurfaceImpl* This, DWORD dwFlags)
317 This->lastlockrect.left = This->lastlockrect.right = 0;
318 assert(This->surface_desc.ddsCaps.dwCaps & DDSCAPS_PRIMARYSURFACE);
319 User_copy_to_screen(This,NULL);
321 USER_PRIV_VAR(priv, This);
322 assert(This->surface_desc.ddsCaps.dwCaps & DDSCAPS_PRIMARYSURFACE);
323 if (dwFlags & DDFLIP_WAIT) User_DirectDrawSurface_wait_update(This);
324 This->lastlockrect.left = This->lastlockrect.right = 0;
325 SetEvent(priv->user.update_event);
329 HRESULT User_DirectDrawSurface_get_dc(IDirectDrawSurfaceImpl* This, HDC* phDC)
331 USER_PRIV_VAR(priv, This);
333 *phDC = priv->user.cached_dc;
337 HRESULT User_DirectDrawSurface_release_dc(IDirectDrawSurfaceImpl* This,
343 HRESULT User_DirectDrawSurface_get_gamma_ramp(IDirectDrawSurfaceImpl* This,
345 LPDDGAMMARAMP lpGammaRamp)
347 if (This->surface_desc.ddsCaps.dwCaps & DDSCAPS_PRIMARYSURFACE)
353 hDisplayWnd = get_display_window(This, &offset);
354 hDisplayDC = GetDCEx(hDisplayWnd, 0, DCX_CLIPSIBLINGS|DCX_CACHE);
355 hr = GetDeviceGammaRamp(hDisplayDC, lpGammaRamp) ? DD_OK : DDERR_UNSUPPORTED;
356 ReleaseDC(hDisplayWnd, hDisplayDC);
359 return Main_DirectDrawSurface_get_gamma_ramp(This, dwFlags, lpGammaRamp);
362 HRESULT User_DirectDrawSurface_set_gamma_ramp(IDirectDrawSurfaceImpl* This,
364 LPDDGAMMARAMP lpGammaRamp)
366 if (This->surface_desc.ddsCaps.dwCaps & DDSCAPS_PRIMARYSURFACE)
372 hDisplayWnd = get_display_window(This, &offset);
373 hDisplayDC = GetDCEx(hDisplayWnd, 0, DCX_CLIPSIBLINGS|DCX_CACHE);
374 hr = SetDeviceGammaRamp(hDisplayDC, lpGammaRamp) ? DD_OK : DDERR_UNSUPPORTED;
375 ReleaseDC(hDisplayWnd, hDisplayDC);
378 return Main_DirectDrawSurface_set_gamma_ramp(This, dwFlags, lpGammaRamp);
381 /* Returns the window that hosts the display.
382 * *pt is set to the upper left position of the window relative to the
383 * upper left corner of the surface. */
384 static HWND get_display_window(IDirectDrawSurfaceImpl* This, LPPOINT pt)
386 memset(pt, 0, sizeof(*pt));
388 if (This->ddraw_owner->cooperative_level & DDSCL_FULLSCREEN)
391 USER_PRIV_VAR(priv, This);
393 SetWindowPos(priv->user.window, HWND_TOP, 0, 0, 0, 0,
394 SWP_DEFERERASE|SWP_NOACTIVATE|SWP_NOCOPYBITS|SWP_NOMOVE|
395 SWP_NOREDRAW|SWP_NOSENDCHANGING|SWP_NOSIZE);
397 return priv->user.window;
399 return This->ddraw_owner->window;
404 if (This->clipper != NULL)
406 /* looks silly, but since we don't have the clipper locked */
407 HWND hWnd = This->clipper->hWnd;
411 ClientToScreen(hWnd, pt);
416 static BOOL warn = 0;
417 if (!warn++) FIXME("clipper clip lists not supported\n");
419 return GetDesktopWindow();
424 static BOOL warn = 0;
425 if (!warn++) WARN("hosting on root\n");
427 return GetDesktopWindow();
432 HWND User_DirectDrawSurface_get_display_window(IDirectDrawSurfaceImpl* This)
435 return get_display_window(This, &offset);
439 static void User_create_own_window(IDirectDrawSurfaceImpl* This)
441 USER_PRIV_VAR(priv, This);
443 if (This->ddraw_owner->cooperative_level & DDSCL_FULLSCREEN)
445 priv->user.window = CreateWindowExA(WS_EX_TOPMOST |
448 "WINE_DDRAW", "DirectDraw",
451 This->surface_desc.dwWidth,
452 This->surface_desc.dwHeight,
455 This->more.lpDDRAWReserved = (LPVOID)priv->user.window;
456 SetWindowPos(priv->user.window, HWND_TOP, 0, 0, 0, 0,
457 SWP_DEFERERASE|SWP_NOACTIVATE|SWP_NOCOPYBITS|SWP_NOMOVE|
458 SWP_NOREDRAW|SWP_NOSENDCHANGING|SWP_NOSIZE|SWP_SHOWWINDOW);
459 UpdateWindow(priv->user.window);
463 static void User_destroy_own_window(IDirectDrawSurfaceImpl* This)
465 USER_PRIV_VAR(priv, This);
467 if (priv->user.window)
469 SetWindowPos(priv->user.window, 0, 0, 0, 0, 0,
470 SWP_DEFERERASE|SWP_NOACTIVATE|SWP_NOCOPYBITS|SWP_NOMOVE|SWP_NOZORDER|
471 SWP_NOREDRAW|SWP_NOSENDCHANGING|SWP_NOSIZE|SWP_HIDEWINDOW);
472 This->more.lpDDRAWReserved = NULL;
473 DestroyWindow(priv->user.window);
474 priv->user.window = 0;
480 static DWORD CALLBACK User_update_thread(LPVOID arg)
482 IDirectDrawSurfaceImpl *This = (IDirectDrawSurfaceImpl *)arg;
483 USER_PRIV_VAR(priv, This);
484 volatile HANDLE *pActive = (volatile HANDLE *)&priv->user.update_event;
485 HANDLE event = *pActive;
488 User_create_own_window(This);
491 /* the point of this is that many games lock the primary surface
492 * multiple times per frame; this thread will then simply copy as
493 * often as it can without keeping the main thread waiting for
494 * each unlock, thus keeping the frame rate high */
497 DWORD ret = MsgWaitForMultipleObjects(1, &event, FALSE, INFINITE, QS_ALLINPUT);
500 while (PeekMessageA(&msg, 0, 0, 0, PM_REMOVE))
502 switch (msg.message) {
504 DispatchMessageA(&msg);
507 /* since we risk getting keyboard messages posted to us,
508 * repost posted messages to cooperative window */
509 PostMessageA(This->ddraw_owner->window, msg.message, msg.wParam, msg.lParam);
513 DWORD ret = WaitForSingleObject(event, INFINITE);
515 if (ret == WAIT_OBJECT_0)
518 priv->user.in_refresh = TRUE;
519 User_copy_to_screen(This, NULL);
520 EnterCriticalSection(&priv->user.crit);
521 priv->user.in_refresh = FALSE;
522 if (priv->user.wait_count)
523 SetEvent(priv->user.refresh_event);
524 LeaveCriticalSection(&priv->user.crit);
528 else if (ret != WAIT_OBJECT_0+1) break;
531 SetEvent(priv->user.refresh_event);
533 User_destroy_own_window(This);
540 static void User_copy_to_screen(IDirectDrawSurfaceImpl* This, LPCRECT rc)
542 if (This->surface_desc.ddsCaps.dwCaps & DDSCAPS_PRIMARYSURFACE)
550 if (FAILED(This->get_dc(This, &hSurfaceDC)))
553 hDisplayWnd = get_display_window(This, &offset);
554 hDisplayDC = GetDCEx(hDisplayWnd, 0, DCX_CLIPSIBLINGS|DCX_CACHE);
556 /* FIXME: this doesn't work... if users really want to run
557 * X in 8bpp, then we need to call directly into display.drv
558 * (or Wine's equivalent), and force a private colormap
559 * without default entries. */
561 SelectPalette(hDisplayDC, This->palette->hpal, FALSE);
562 RealizePalette(hDisplayDC); /* sends messages => deadlocks */
566 drawrect.right = This->surface_desc.dwWidth;
568 drawrect.bottom = This->surface_desc.dwHeight;
572 HWND hwnd = This->clipper->hWnd;
573 if (hwnd && GetClientRect(hwnd,&xrc)) {
574 OffsetRect(&xrc,offset.x,offset.y);
575 IntersectRect(&drawrect,&drawrect,&xrc);
579 IntersectRect(&drawrect,&drawrect,rc);
581 /* Only use this if the caller did not pass a rectangle, since
582 * due to double locking this could be the wrong one ... */
583 if (This->lastlockrect.left != This->lastlockrect.right)
584 IntersectRect(&drawrect,&drawrect,&This->lastlockrect);
587 drawrect.left-offset.x, drawrect.top-offset.y,
588 drawrect.right-drawrect.left, drawrect.bottom-drawrect.top,
590 drawrect.left, drawrect.top,
593 ReleaseDC(hDisplayWnd, hDisplayDC);
598 static void User_copy_from_screen(IDirectDrawSurfaceImpl* This, LPCRECT rc)
600 if (This->surface_desc.ddsCaps.dwCaps & DDSCAPS_PRIMARYSURFACE)
603 HWND hDisplayWnd = get_display_window(This, &offset);
604 HDC hDisplayDC = GetDC(hDisplayWnd);
608 drawrect.right = This->surface_desc.dwWidth;
610 drawrect.bottom = This->surface_desc.dwHeight;
612 IntersectRect(&drawrect,&drawrect,rc);
615 drawrect.left, drawrect.top,
616 drawrect.right-drawrect.left, drawrect.bottom-drawrect.top,
618 drawrect.left+offset.x, drawrect.top+offset.y,
621 ReleaseDC(hDisplayWnd, hDisplayDC);
626 static const IDirectDrawSurface7Vtbl User_IDirectDrawSurface7_VTable =
628 Main_DirectDrawSurface_QueryInterface,
629 Main_DirectDrawSurface_AddRef,
630 Main_DirectDrawSurface_Release,
631 Main_DirectDrawSurface_AddAttachedSurface,
632 Main_DirectDrawSurface_AddOverlayDirtyRect,
633 DIB_DirectDrawSurface_Blt,
634 Main_DirectDrawSurface_BltBatch,
635 DIB_DirectDrawSurface_BltFast,
636 Main_DirectDrawSurface_DeleteAttachedSurface,
637 Main_DirectDrawSurface_EnumAttachedSurfaces,
638 Main_DirectDrawSurface_EnumOverlayZOrders,
639 Main_DirectDrawSurface_Flip,
640 Main_DirectDrawSurface_GetAttachedSurface,
641 Main_DirectDrawSurface_GetBltStatus,
642 Main_DirectDrawSurface_GetCaps,
643 Main_DirectDrawSurface_GetClipper,
644 Main_DirectDrawSurface_GetColorKey,
645 Main_DirectDrawSurface_GetDC,
646 Main_DirectDrawSurface_GetFlipStatus,
647 Main_DirectDrawSurface_GetOverlayPosition,
648 Main_DirectDrawSurface_GetPalette,
649 Main_DirectDrawSurface_GetPixelFormat,
650 Main_DirectDrawSurface_GetSurfaceDesc,
651 Main_DirectDrawSurface_Initialize,
652 Main_DirectDrawSurface_IsLost,
653 Main_DirectDrawSurface_Lock,
654 Main_DirectDrawSurface_ReleaseDC,
655 DIB_DirectDrawSurface_Restore,
656 Main_DirectDrawSurface_SetClipper,
657 Main_DirectDrawSurface_SetColorKey,
658 Main_DirectDrawSurface_SetOverlayPosition,
659 Main_DirectDrawSurface_SetPalette,
660 Main_DirectDrawSurface_Unlock,
661 Main_DirectDrawSurface_UpdateOverlay,
662 Main_DirectDrawSurface_UpdateOverlayDisplay,
663 Main_DirectDrawSurface_UpdateOverlayZOrder,
664 Main_DirectDrawSurface_GetDDInterface,
665 Main_DirectDrawSurface_PageLock,
666 Main_DirectDrawSurface_PageUnlock,
667 DIB_DirectDrawSurface_SetSurfaceDesc,
668 Main_DirectDrawSurface_SetPrivateData,
669 Main_DirectDrawSurface_GetPrivateData,
670 Main_DirectDrawSurface_FreePrivateData,
671 Main_DirectDrawSurface_GetUniquenessValue,
672 Main_DirectDrawSurface_ChangeUniquenessValue,
673 Main_DirectDrawSurface_SetPriority,
674 Main_DirectDrawSurface_GetPriority,
675 Main_DirectDrawSurface_SetLOD,
676 Main_DirectDrawSurface_GetLOD