dlls/ddraw/clipper.c

   1 /* DirectDrawClipper implementation
   2  *
   3  * Copyright 2000 (c) Marcus Meissner
   4  * Copyright 2000 (c) TransGaming Technologies Inc.
   5  * Copyright 2006 (c) Stefan Dösinger
   6  *
   7  * This library is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU Lesser General Public
   9  * License as published by the Free Software Foundation; either
  10  * version 2.1 of the License, or (at your option) any later version.
  11  *
  12  * This library is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * Lesser General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Lesser General Public
  18  * License along with this library; if not, write to the Free Software
  19  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
  20  */
  21
  22 #include "config.h"
  23 #include "wine/port.h"
  24
  25 #include "ddraw_private.h"
  26
  27 WINE_DEFAULT_DEBUG_CHANNEL(ddraw);
  28
  29 /*****************************************************************************
  30  * IUnknown methods
  31  *****************************************************************************/
  32
  33 /*****************************************************************************
  34  * IDirectDrawClipper::QueryInterface
  35  *
  36  * Can query the IUnknown and IDirectDrawClipper interface from a
  37  * Clipper object. The IUnknown Interface is equal to the IDirectDrawClipper
  38  * interface. Can't create other interfaces.
  39  *
  40  * Arguments:
  41  *  riid: Interface id asked for
  42  *  ppvObj: Returns the pointer to the interface
  43  *
  44  * Return values:
  45  *  DD_OK on success
  46  *  E_NOINTERFACE if the requested interface wasn't found.
  47  *
  48  *****************************************************************************/
  49 static HRESULT WINAPI IDirectDrawClipperImpl_QueryInterface(
  50     LPDIRECTDRAWCLIPPER iface, REFIID riid, LPVOID* ppvObj
  51 ) {
  52
  53     TRACE("iface %p, riid %s, object %p.\n", iface, debugstr_guid(riid), ppvObj);
  54
  55     if (IsEqualGUID(&IID_IDirectDrawClipper, riid)
  56             || IsEqualGUID(&IID_IUnknown, riid))
  57     {
  58         IUnknown_AddRef(iface);
  59         *ppvObj = iface;
  60         return S_OK;
  61     }
  62
  63     return E_NOINTERFACE;
  64 }
  65
  66 /*****************************************************************************
  67  * IDirectDrawClipper::AddRef
  68  *
  69  * Increases the reference count of the interface, returns the new count
  70  *
  71  *****************************************************************************/
  72 static ULONG WINAPI IDirectDrawClipperImpl_AddRef( LPDIRECTDRAWCLIPPER iface )
  73 {
  74     IDirectDrawClipperImpl *This = (IDirectDrawClipperImpl *)iface;
  75     ULONG ref = InterlockedIncrement(&This->ref);
  76
  77     TRACE("%p increasing refcount to %u.\n", This, ref);
  78
  79     return ref;
  80 }
  81
  82 /*****************************************************************************
  83  * IDirectDrawClipper::Release
  84  *
  85  * Decreases the reference count of the interface, returns the new count
  86  * If the refcount is decreased to 0, the interface is destroyed.
  87  *
  88  *****************************************************************************/
  89 static ULONG WINAPI IDirectDrawClipperImpl_Release(IDirectDrawClipper *iface) {
  90     IDirectDrawClipperImpl *This = (IDirectDrawClipperImpl *)iface;
  91     ULONG ref = InterlockedDecrement(&This->ref);
  92
  93     TRACE("%p decreasing refcount to %u.\n", This, ref);
  94
  95     if (ref == 0)
  96     {
  97         EnterCriticalSection(&ddraw_cs);
  98         wined3d_clipper_decref(This->wineD3DClipper);
  99         HeapFree(GetProcessHeap(), 0, This);
 100         LeaveCriticalSection(&ddraw_cs);
 101         return 0;
 102     }
 103     else return ref;
 104 }
 105
 106 /*****************************************************************************
 107  * IDirectDrawClipper::SetHwnd
 108  *
 109  * Assigns a hWnd to the clipper interface.
 110  *
 111  * Arguments:
 112  *  Flags: Unsupported so far
 113  *  hWnd: The hWnd to set
 114  *
 115  * Return values:
 116  *  DD_OK on success
 117  *  DDERR_INVALIDPARAMS if Flags was != 0
 118  *
 119  *****************************************************************************/
 120
 121 static HRESULT WINAPI IDirectDrawClipperImpl_SetHwnd(
 122     LPDIRECTDRAWCLIPPER iface, DWORD dwFlags, HWND hWnd
 123 ) {
 124     IDirectDrawClipperImpl *This = (IDirectDrawClipperImpl *)iface;
 125     HRESULT hr;
 126
 127     TRACE("iface %p, flags %#x, window %p.\n", iface, dwFlags, hWnd);
 128
 129     EnterCriticalSection(&ddraw_cs);
 130     hr = wined3d_clipper_set_window(This->wineD3DClipper, dwFlags, hWnd);
 131     LeaveCriticalSection(&ddraw_cs);
 132     switch(hr)
 133     {
 134         case WINED3DERR_INVALIDCALL:        return DDERR_INVALIDPARAMS;
 135         default:                            return hr;
 136     }
 137 }
 138
 139 /*****************************************************************************
 140  * IDirectDrawClipper::GetClipList
 141  *
 142  * Retrieve a copy of the clip list
 143  *
 144  * Arguments:
 145  *  Rect: Rectangle to be used to clip the clip list or NULL for the
 146  *        entire clip list
 147  *  ClipList: structure for the resulting copy of the clip list.
 148  *            If NULL, fills Size up to the number of bytes necessary to hold
 149  *            the entire clip.
 150  *  Size: Size of resulting clip list; size of the buffer at ClipList
 151  *        or, if ClipList is NULL, receives the required size of the buffer
 152  *        in bytes
 153  *
 154  * RETURNS
 155  *  Either DD_OK or DDERR_*
 156  ************************************************************************/
 157 static HRESULT WINAPI IDirectDrawClipperImpl_GetClipList(
 158     LPDIRECTDRAWCLIPPER iface, LPRECT lpRect, LPRGNDATA lpClipList,
 159     LPDWORD lpdwSize)
 160 {
 161     IDirectDrawClipperImpl *This = (IDirectDrawClipperImpl *)iface;
 162     HRESULT hr;
 163
 164     TRACE("iface %p, rect %s, clip_list %p, clip_list_size %p.\n",
 165             iface, wine_dbgstr_rect(lpRect), lpClipList, lpdwSize);
 166
 167     EnterCriticalSection(&ddraw_cs);
 168     hr = wined3d_clipper_get_clip_list(This->wineD3DClipper, lpRect, lpClipList, lpdwSize);
 169     LeaveCriticalSection(&ddraw_cs);
 170     return hr;
 171 }
 172
 173 /*****************************************************************************
 174  * IDirectDrawClipper::SetClipList
 175  *
 176  * Sets or deletes (if lprgn is NULL) the clip list
 177  *
 178  * This implementation is a stub and returns DD_OK always to make the app
 179  * happy.
 180  *
 181  * PARAMS
 182  *  lprgn   Pointer to a LRGNDATA structure or NULL
 183  *  dwFlags not used, must be 0
 184  * RETURNS
 185  *  Either DD_OK or DDERR_*
 186  *****************************************************************************/
 187 static HRESULT WINAPI IDirectDrawClipperImpl_SetClipList(
 188     LPDIRECTDRAWCLIPPER iface,LPRGNDATA lprgn,DWORD dwFlag
 189 ) {
 190     IDirectDrawClipperImpl *This = (IDirectDrawClipperImpl *)iface;
 191     HRESULT hr;
 192
 193     TRACE("iface %p, clip_list %p, flags %#x.\n", iface, lprgn, dwFlag);
 194
 195     EnterCriticalSection(&ddraw_cs);
 196     hr = wined3d_clipper_set_clip_list(This->wineD3DClipper, lprgn, dwFlag);
 197     LeaveCriticalSection(&ddraw_cs);
 198     return hr;
 199 }
 200
 201 /*****************************************************************************
 202  * IDirectDrawClipper::GetHwnd
 203  *
 204  * Returns the hwnd assigned with SetHwnd
 205  *
 206  * Arguments:
 207  *  hWndPtr: Address to store the HWND at
 208  *
 209  * Return values:
 210  *  Always returns DD_OK;
 211  *****************************************************************************/
 212 static HRESULT WINAPI IDirectDrawClipperImpl_GetHWnd(
 213     LPDIRECTDRAWCLIPPER iface, HWND* hWndPtr
 214 ) {
 215     IDirectDrawClipperImpl *This = (IDirectDrawClipperImpl *)iface;
 216     HRESULT hr;
 217
 218     TRACE("iface %p, window %p.\n", iface, hWndPtr);
 219
 220     EnterCriticalSection(&ddraw_cs);
 221     hr = wined3d_clipper_get_window(This->wineD3DClipper, hWndPtr);
 222     LeaveCriticalSection(&ddraw_cs);
 223     return hr;
 224 }
 225
 226 /*****************************************************************************
 227  * IDirectDrawClipper::Initialize
 228  *
 229  * Initializes the interface. Well, there isn't much to do for this
 230  * implementation, but it stores the DirectDraw Interface.
 231  *
 232  * Arguments:
 233  *  DD: Pointer to a IDirectDraw interface
 234  *  Flags: Unsupported by now
 235  *
 236  * Return values:
 237  *  DD_OK on success
 238  *  DDERR_ALREADYINITIALIZED if this interface isn't initialized already
 239  *****************************************************************************/
 240 static HRESULT WINAPI IDirectDrawClipperImpl_Initialize(
 241      LPDIRECTDRAWCLIPPER iface, LPDIRECTDRAW lpDD, DWORD dwFlags
 242 ) {
 243     IDirectDrawClipperImpl *This = (IDirectDrawClipperImpl *)iface;
 244
 245     TRACE("iface %p, ddraw %p, flags %#x.\n", iface, lpDD, dwFlags);
 246
 247     EnterCriticalSection(&ddraw_cs);
 248     if (This->initialized)
 249     {
 250         LeaveCriticalSection(&ddraw_cs);
 251         return DDERR_ALREADYINITIALIZED;
 252     }
 253
 254     This->initialized = TRUE;
 255
 256     LeaveCriticalSection(&ddraw_cs);
 257     return DD_OK;
 258 }
 259
 260 /*****************************************************************************
 261  * IDirectDrawClipper::IsClipListChanged
 262  *
 263  * This function is a stub
 264  *
 265  * Arguments:
 266  *  Changed:
 267  *
 268  * Return values:
 269  *  DD_OK, because it's a stub
 270  *****************************************************************************/
 271 static HRESULT WINAPI IDirectDrawClipperImpl_IsClipListChanged(
 272     LPDIRECTDRAWCLIPPER iface, BOOL* lpbChanged
 273 ) {
 274     FIXME("iface %p, changed %p stub!\n", iface, lpbChanged);
 275
 276     /* XXX What is safest? */
 277     *lpbChanged = FALSE;
 278
 279     return DD_OK;
 280 }
 281
 282 /*****************************************************************************
 283  * The VTable
 284  *****************************************************************************/
 285 static const struct IDirectDrawClipperVtbl ddraw_clipper_vtbl =
 286 {
 287     IDirectDrawClipperImpl_QueryInterface,
 288     IDirectDrawClipperImpl_AddRef,
 289     IDirectDrawClipperImpl_Release,
 290     IDirectDrawClipperImpl_GetClipList,
 291     IDirectDrawClipperImpl_GetHWnd,
 292     IDirectDrawClipperImpl_Initialize,
 293     IDirectDrawClipperImpl_IsClipListChanged,
 294     IDirectDrawClipperImpl_SetClipList,
 295     IDirectDrawClipperImpl_SetHwnd
 296 };
 297
 298 HRESULT ddraw_clipper_init(IDirectDrawClipperImpl *clipper)
 299 {
 300     clipper->lpVtbl = &ddraw_clipper_vtbl;
 301     clipper->ref = 1;
 302     clipper->wineD3DClipper = wined3d_clipper_create();
 303     if (!clipper->wineD3DClipper)
 304     {
 305         WARN("Failed to create wined3d clipper.\n");
 306         return E_OUTOFMEMORY;
 307     }
 308
 309     return DD_OK;
 310 }