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