dlls/d3d9/surface.c

   1 /*
   2  * IDirect3DSurface9 implementation
   3  *
   4  * Copyright 2002-2005 Jason Edmeades
   5  *                     Raphael Junqueira
   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 "d3d9_private.h"
  24
  25 WINE_DEFAULT_DEBUG_CHANNEL(d3d9);
  26
  27 static inline struct d3d9_surface *impl_from_IDirect3DSurface9(IDirect3DSurface9 *iface)
  28 {
  29     return CONTAINING_RECORD(iface, struct d3d9_surface, IDirect3DSurface9_iface);
  30 }
  31
  32 static HRESULT WINAPI d3d9_surface_QueryInterface(IDirect3DSurface9 *iface, REFIID riid, void **out)
  33 {
  34     TRACE("iface %p, riid %s, out %p.\n", iface, debugstr_guid(riid), out);
  35
  36     if (IsEqualGUID(riid, &IID_IDirect3DSurface9)
  37             || IsEqualGUID(riid, &IID_IDirect3DResource9)
  38             || IsEqualGUID(riid, &IID_IUnknown))
  39     {
  40         IDirect3DSurface9_AddRef(iface);
  41         *out = iface;
  42         return S_OK;
  43     }
  44
  45     WARN("%s not implemented, returning E_NOINTERFACE.\n", debugstr_guid(riid));
  46
  47     *out = NULL;
  48     return E_NOINTERFACE;
  49 }
  50
  51 static ULONG WINAPI d3d9_surface_AddRef(IDirect3DSurface9 *iface)
  52 {
  53     struct d3d9_surface *surface = impl_from_IDirect3DSurface9(iface);
  54     ULONG refcount;
  55
  56     TRACE("iface %p.\n", iface);
  57
  58     if (surface->texture)
  59     {
  60         TRACE("Forwarding to %p.\n", surface->texture);
  61         return IDirect3DBaseTexture9_AddRef(&surface->texture->IDirect3DBaseTexture9_iface);
  62     }
  63
  64     refcount = InterlockedIncrement(&surface->resource.refcount);
  65     TRACE("%p increasing refcount to %u.\n", iface, refcount);
  66
  67     if (refcount == 1)
  68     {
  69         if (surface->parent_device)
  70             IDirect3DDevice9Ex_AddRef(surface->parent_device);
  71         wined3d_mutex_lock();
  72         if (surface->wined3d_rtv)
  73             wined3d_rendertarget_view_incref(surface->wined3d_rtv);
  74         wined3d_texture_incref(surface->wined3d_texture);
  75         wined3d_mutex_unlock();
  76     }
  77
  78     return refcount;
  79 }
  80
  81 static ULONG WINAPI d3d9_surface_Release(IDirect3DSurface9 *iface)
  82 {
  83     struct d3d9_surface *surface = impl_from_IDirect3DSurface9(iface);
  84     ULONG refcount;
  85
  86     TRACE("iface %p.\n", iface);
  87
  88     if (surface->texture)
  89     {
  90         TRACE("Forwarding to %p.\n", surface->texture);
  91         return IDirect3DBaseTexture9_Release(&surface->texture->IDirect3DBaseTexture9_iface);
  92     }
  93
  94     if (!surface->resource.refcount)
  95     {
  96         WARN("Surface does not have any references.\n");
  97         return 0;
  98     }
  99
 100     refcount = InterlockedDecrement(&surface->resource.refcount);
 101     TRACE("%p decreasing refcount to %u.\n", iface, refcount);
 102
 103     if (!refcount)
 104     {
 105         IDirect3DDevice9Ex *parent_device = surface->parent_device;
 106
 107         wined3d_mutex_lock();
 108         if (surface->wined3d_rtv)
 109             wined3d_rendertarget_view_decref(surface->wined3d_rtv);
 110         wined3d_texture_decref(surface->wined3d_texture);
 111         wined3d_mutex_unlock();
 112
 113         /* Release the device last, as it may cause the device to be destroyed. */
 114         if (parent_device)
 115             IDirect3DDevice9Ex_Release(parent_device);
 116     }
 117
 118     return refcount;
 119 }
 120
 121 static HRESULT WINAPI d3d9_surface_GetDevice(IDirect3DSurface9 *iface, IDirect3DDevice9 **device)
 122 {
 123     struct d3d9_surface *surface = impl_from_IDirect3DSurface9(iface);
 124
 125     TRACE("iface %p, device %p.\n", iface, device);
 126
 127     if (surface->texture)
 128         return IDirect3DBaseTexture9_GetDevice(&surface->texture->IDirect3DBaseTexture9_iface, device);
 129
 130     *device = (IDirect3DDevice9 *)surface->parent_device;
 131     IDirect3DDevice9_AddRef(*device);
 132
 133     TRACE("Returning device %p.\n", *device);
 134
 135     return D3D_OK;
 136 }
 137
 138 static HRESULT WINAPI d3d9_surface_SetPrivateData(IDirect3DSurface9 *iface, REFGUID guid,
 139         const void *data, DWORD data_size, DWORD flags)
 140 {
 141     struct d3d9_surface *surface = impl_from_IDirect3DSurface9(iface);
 142     TRACE("iface %p, guid %s, data %p, data_size %u, flags %#x.\n",
 143             iface, debugstr_guid(guid), data, data_size, flags);
 144
 145     return d3d9_resource_set_private_data(&surface->resource, guid, data, data_size, flags);
 146 }
 147
 148 static HRESULT WINAPI d3d9_surface_GetPrivateData(IDirect3DSurface9 *iface, REFGUID guid,
 149         void *data, DWORD *data_size)
 150 {
 151     struct d3d9_surface *surface = impl_from_IDirect3DSurface9(iface);
 152     TRACE("iface %p, guid %s, data %p, data_size %p.\n",
 153             iface, debugstr_guid(guid), data, data_size);
 154
 155     return d3d9_resource_get_private_data(&surface->resource, guid, data, data_size);
 156 }
 157
 158 static HRESULT WINAPI d3d9_surface_FreePrivateData(IDirect3DSurface9 *iface, REFGUID guid)
 159 {
 160     struct d3d9_surface *surface = impl_from_IDirect3DSurface9(iface);
 161     TRACE("iface %p, guid %s.\n", iface, debugstr_guid(guid));
 162
 163     return d3d9_resource_free_private_data(&surface->resource, guid);
 164 }
 165
 166 static DWORD WINAPI d3d9_surface_SetPriority(IDirect3DSurface9 *iface, DWORD priority)
 167 {
 168     TRACE("iface %p, priority %u. Ignored on surfaces.\n", iface, priority);
 169     return 0;
 170 }
 171
 172 static DWORD WINAPI d3d9_surface_GetPriority(IDirect3DSurface9 *iface)
 173 {
 174     TRACE("iface %p. Ignored on surfaces.\n", iface);
 175     return 0;
 176 }
 177
 178 static void WINAPI d3d9_surface_PreLoad(IDirect3DSurface9 *iface)
 179 {
 180     struct d3d9_surface *surface = impl_from_IDirect3DSurface9(iface);
 181
 182     TRACE("iface %p.\n", iface);
 183
 184     wined3d_mutex_lock();
 185     wined3d_resource_preload(wined3d_texture_get_resource(surface->wined3d_texture));
 186     wined3d_mutex_unlock();
 187 }
 188
 189 static D3DRESOURCETYPE WINAPI d3d9_surface_GetType(IDirect3DSurface9 *iface)
 190 {
 191     TRACE("iface %p.\n", iface);
 192
 193     return D3DRTYPE_SURFACE;
 194 }
 195
 196 static HRESULT WINAPI d3d9_surface_GetContainer(IDirect3DSurface9 *iface, REFIID riid, void **container)
 197 {
 198     struct d3d9_surface *surface = impl_from_IDirect3DSurface9(iface);
 199     HRESULT hr;
 200
 201     TRACE("iface %p, riid %s, container %p.\n", iface, debugstr_guid(riid), container);
 202
 203     if (!surface->container)
 204         return E_NOINTERFACE;
 205
 206     hr = IUnknown_QueryInterface(surface->container, riid, container);
 207
 208     TRACE("Returning %p.\n", *container);
 209
 210     return hr;
 211 }
 212
 213 static HRESULT WINAPI d3d9_surface_GetDesc(IDirect3DSurface9 *iface, D3DSURFACE_DESC *desc)
 214 {
 215     struct d3d9_surface *surface = impl_from_IDirect3DSurface9(iface);
 216     struct wined3d_sub_resource_desc wined3d_desc;
 217
 218     TRACE("iface %p, desc %p.\n", iface, desc);
 219
 220     wined3d_mutex_lock();
 221     wined3d_texture_get_sub_resource_desc(surface->wined3d_texture, surface->sub_resource_idx, &wined3d_desc);
 222     wined3d_mutex_unlock();
 223
 224     desc->Format = d3dformat_from_wined3dformat(wined3d_desc.format);
 225     desc->Type = D3DRTYPE_SURFACE;
 226     desc->Usage = wined3d_desc.usage & WINED3DUSAGE_MASK;
 227     desc->Pool = wined3d_desc.pool;
 228     desc->MultiSampleType = wined3d_desc.multisample_type;
 229     desc->MultiSampleQuality = wined3d_desc.multisample_quality;
 230     desc->Width = wined3d_desc.width;
 231     desc->Height = wined3d_desc.height;
 232
 233     return D3D_OK;
 234 }
 235
 236 static HRESULT WINAPI d3d9_surface_LockRect(IDirect3DSurface9 *iface,
 237         D3DLOCKED_RECT *locked_rect, const RECT *rect, DWORD flags)
 238 {
 239     struct d3d9_surface *surface = impl_from_IDirect3DSurface9(iface);
 240     struct wined3d_box box;
 241     struct wined3d_map_desc map_desc;
 242     HRESULT hr;
 243
 244     TRACE("iface %p, locked_rect %p, rect %s, flags %#x.\n",
 245             iface, locked_rect, wine_dbgstr_rect(rect), flags);
 246
 247     if (rect)
 248     {
 249         box.left = rect->left;
 250         box.top = rect->top;
 251         box.right = rect->right;
 252         box.bottom = rect->bottom;
 253         box.front = 0;
 254         box.back = 1;
 255     }
 256
 257     wined3d_mutex_lock();
 258     hr = wined3d_resource_map(wined3d_texture_get_resource(surface->wined3d_texture), surface->sub_resource_idx,
 259             &map_desc, rect ? &box : NULL, flags);
 260     wined3d_mutex_unlock();
 261
 262     if (SUCCEEDED(hr))
 263     {
 264         locked_rect->Pitch = map_desc.row_pitch;
 265         locked_rect->pBits = map_desc.data;
 266     }
 267
 268     return hr;
 269 }
 270
 271 static HRESULT WINAPI d3d9_surface_UnlockRect(IDirect3DSurface9 *iface)
 272 {
 273     struct d3d9_surface *surface = impl_from_IDirect3DSurface9(iface);
 274     HRESULT hr;
 275
 276     TRACE("iface %p.\n", iface);
 277
 278     wined3d_mutex_lock();
 279     hr = wined3d_resource_unmap(wined3d_texture_get_resource(surface->wined3d_texture), surface->sub_resource_idx);
 280     wined3d_mutex_unlock();
 281
 282     if (hr == WINEDDERR_NOTLOCKED)
 283     {
 284         D3DRESOURCETYPE type;
 285         if (surface->texture)
 286             type = IDirect3DBaseTexture9_GetType(&surface->texture->IDirect3DBaseTexture9_iface);
 287         else
 288             type = D3DRTYPE_SURFACE;
 289         hr = type == D3DRTYPE_TEXTURE ? D3D_OK : D3DERR_INVALIDCALL;
 290     }
 291     return hr;
 292 }
 293
 294 static HRESULT WINAPI d3d9_surface_GetDC(IDirect3DSurface9 *iface, HDC *dc)
 295 {
 296     struct d3d9_surface *surface = impl_from_IDirect3DSurface9(iface);
 297     HRESULT hr;
 298
 299     TRACE("iface %p, dc %p.\n", iface, dc);
 300
 301     wined3d_mutex_lock();
 302     hr = wined3d_texture_get_dc(surface->wined3d_texture, surface->sub_resource_idx, dc);
 303     wined3d_mutex_unlock();
 304
 305     return hr;
 306 }
 307
 308 static HRESULT WINAPI d3d9_surface_ReleaseDC(IDirect3DSurface9 *iface, HDC dc)
 309 {
 310     struct d3d9_surface *surface = impl_from_IDirect3DSurface9(iface);
 311     HRESULT hr;
 312
 313     TRACE("iface %p, dc %p.\n", iface, dc);
 314
 315     wined3d_mutex_lock();
 316     hr = wined3d_texture_release_dc(surface->wined3d_texture, surface->sub_resource_idx, dc);
 317     wined3d_mutex_unlock();
 318
 319     return hr;
 320 }
 321
 322 static const struct IDirect3DSurface9Vtbl d3d9_surface_vtbl =
 323 {
 324     /* IUnknown */
 325     d3d9_surface_QueryInterface,
 326     d3d9_surface_AddRef,
 327     d3d9_surface_Release,
 328     /* IDirect3DResource9 */
 329     d3d9_surface_GetDevice,
 330     d3d9_surface_SetPrivateData,
 331     d3d9_surface_GetPrivateData,
 332     d3d9_surface_FreePrivateData,
 333     d3d9_surface_SetPriority,
 334     d3d9_surface_GetPriority,
 335     d3d9_surface_PreLoad,
 336     d3d9_surface_GetType,
 337     /* IDirect3DSurface9 */
 338     d3d9_surface_GetContainer,
 339     d3d9_surface_GetDesc,
 340     d3d9_surface_LockRect,
 341     d3d9_surface_UnlockRect,
 342     d3d9_surface_GetDC,
 343     d3d9_surface_ReleaseDC,
 344 };
 345
 346 static void STDMETHODCALLTYPE surface_wined3d_object_destroyed(void *parent)
 347 {
 348     struct d3d9_surface *surface = parent;
 349     d3d9_resource_cleanup(&surface->resource);
 350     HeapFree(GetProcessHeap(), 0, surface);
 351 }
 352
 353 static const struct wined3d_parent_ops d3d9_surface_wined3d_parent_ops =
 354 {
 355     surface_wined3d_object_destroyed,
 356 };
 357
 358 void surface_init(struct d3d9_surface *surface, struct wined3d_texture *wined3d_texture,
 359         unsigned int sub_resource_idx, const struct wined3d_parent_ops **parent_ops)
 360 {
 361     IDirect3DBaseTexture9 *texture;
 362
 363     surface->IDirect3DSurface9_iface.lpVtbl = &d3d9_surface_vtbl;
 364     d3d9_resource_init(&surface->resource);
 365     surface->resource.refcount = 0;
 366     list_init(&surface->rtv_entry);
 367     surface->container = wined3d_texture_get_parent(wined3d_texture);
 368     surface->wined3d_texture = wined3d_texture;
 369     surface->sub_resource_idx = sub_resource_idx;
 370
 371     if (surface->container && SUCCEEDED(IUnknown_QueryInterface(surface->container,
 372             &IID_IDirect3DBaseTexture9, (void **)&texture)))
 373     {
 374         surface->texture = unsafe_impl_from_IDirect3DBaseTexture9(texture);
 375         IDirect3DBaseTexture9_Release(texture);
 376     }
 377
 378     *parent_ops = &d3d9_surface_wined3d_parent_ops;
 379 }
 380
 381 static void STDMETHODCALLTYPE view_wined3d_object_destroyed(void *parent)
 382 {
 383     struct d3d9_surface *surface = parent;
 384
 385     /* If the surface reference count drops to zero, we release our reference
 386      * to the view, but don't clear the pointer yet, in case e.g. a
 387      * GetRenderTarget() call brings the surface back before the view is
 388      * actually destroyed. When the view is destroyed, we need to clear the
 389      * pointer, or a subsequent surface AddRef() would reference it again.
 390      *
 391      * This is safe because as long as the view still has a reference to the
 392      * texture, the surface is also still alive, and we're called before the
 393      * view releases that reference. */
 394     surface->wined3d_rtv = NULL;
 395     list_remove(&surface->rtv_entry);
 396 }
 397
 398 static const struct wined3d_parent_ops d3d9_view_wined3d_parent_ops =
 399 {
 400     view_wined3d_object_destroyed,
 401 };
 402
 403 struct d3d9_device *d3d9_surface_get_device(const struct d3d9_surface *surface)
 404 {
 405     IDirect3DDevice9Ex *device;
 406     device = surface->texture ? surface->texture->parent_device : surface->parent_device;
 407     return impl_from_IDirect3DDevice9Ex(device);
 408 }
 409
 410 struct wined3d_rendertarget_view *d3d9_surface_acquire_rendertarget_view(struct d3d9_surface *surface)
 411 {
 412     HRESULT hr;
 413
 414     /* The surface reference count can be equal to 0 when this function is
 415      * called. In order to properly manage the render target view reference
 416      * count, we temporarily increment the surface reference count. */
 417     d3d9_surface_AddRef(&surface->IDirect3DSurface9_iface);
 418
 419     if (surface->wined3d_rtv)
 420         return surface->wined3d_rtv;
 421
 422     if (FAILED(hr = wined3d_rendertarget_view_create_from_sub_resource(surface->wined3d_texture,
 423             surface->sub_resource_idx, surface, &d3d9_view_wined3d_parent_ops, &surface->wined3d_rtv)))
 424     {
 425         ERR("Failed to create rendertarget view, hr %#x.\n", hr);
 426         d3d9_surface_Release(&surface->IDirect3DSurface9_iface);
 427         return NULL;
 428     }
 429
 430     if (surface->texture)
 431         list_add_head(&surface->texture->rtv_list, &surface->rtv_entry);
 432
 433     return surface->wined3d_rtv;
 434 }
 435
 436 void d3d9_surface_release_rendertarget_view(struct d3d9_surface *surface,
 437         struct wined3d_rendertarget_view *rtv)
 438 {
 439     if (rtv)
 440         d3d9_surface_Release(&surface->IDirect3DSurface9_iface);
 441 }
 442
 443 struct d3d9_surface *unsafe_impl_from_IDirect3DSurface9(IDirect3DSurface9 *iface)
 444 {
 445     if (!iface)
 446         return NULL;
 447     assert(iface->lpVtbl == &d3d9_surface_vtbl);
 448
 449     return impl_from_IDirect3DSurface9(iface);
 450 }