dlls/d3d8/surface.c

   1 /*
   2  * IDirect3DSurface8 implementation
   3  *
   4  * Copyright 2005 Oliver Stieber
   5  *
   6  * This library is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Lesser General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 2.1 of the License, or (at your option) any later version.
  10  *
  11  * This library is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * Lesser General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Lesser General Public
  17  * License along with this library; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
  19  */
  20
  21 #include "config.h"
  22 #include "d3d8_private.h"
  23
  24 WINE_DEFAULT_DEBUG_CHANNEL(d3d8);
  25
  26 static inline struct d3d8_surface *impl_from_IDirect3DSurface8(IDirect3DSurface8 *iface)
  27 {
  28     return CONTAINING_RECORD(iface, struct d3d8_surface, IDirect3DSurface8_iface);
  29 }
  30
  31 static HRESULT WINAPI d3d8_surface_QueryInterface(IDirect3DSurface8 *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_IDirect3DSurface8)
  36             || IsEqualGUID(riid, &IID_IDirect3DResource8)
  37             || IsEqualGUID(riid, &IID_IUnknown))
  38     {
  39         IDirect3DSurface8_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 d3d8_surface_AddRef(IDirect3DSurface8 *iface)
  51 {
  52     struct d3d8_surface *surface = impl_from_IDirect3DSurface8(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 IDirect3DBaseTexture8_AddRef(&surface->texture->IDirect3DBaseTexture8_iface);
  61     }
  62
  63     refcount = InterlockedIncrement(&surface->resource.refcount);
  64     TRACE("%p increasing refcount to %u.\n", iface, refcount);
  65
  66     if (refcount == 1)
  67     {
  68         if (surface->parent_device)
  69             IDirect3DDevice8_AddRef(surface->parent_device);
  70         wined3d_mutex_lock();
  71         if (surface->wined3d_rtv)
  72             wined3d_rendertarget_view_incref(surface->wined3d_rtv);
  73         wined3d_texture_incref(surface->wined3d_texture);
  74         wined3d_mutex_unlock();
  75     }
  76
  77     return refcount;
  78 }
  79
  80 static ULONG WINAPI d3d8_surface_Release(IDirect3DSurface8 *iface)
  81 {
  82     struct d3d8_surface *surface = impl_from_IDirect3DSurface8(iface);
  83     ULONG refcount;
  84
  85     TRACE("iface %p.\n", iface);
  86
  87     if (surface->texture)
  88     {
  89         TRACE("Forwarding to %p.\n", surface->texture);
  90         return IDirect3DBaseTexture8_Release(&surface->texture->IDirect3DBaseTexture8_iface);
  91     }
  92
  93     refcount = InterlockedDecrement(&surface->resource.refcount);
  94     TRACE("%p decreasing refcount to %u.\n", iface, refcount);
  95
  96     if (!refcount)
  97     {
  98         IDirect3DDevice8 *parent_device = surface->parent_device;
  99
 100         wined3d_mutex_lock();
 101         if (surface->wined3d_rtv)
 102             wined3d_rendertarget_view_decref(surface->wined3d_rtv);
 103         wined3d_texture_decref(surface->wined3d_texture);
 104         wined3d_mutex_unlock();
 105
 106         if (parent_device)
 107             IDirect3DDevice8_Release(parent_device);
 108     }
 109
 110     return refcount;
 111 }
 112
 113 static HRESULT WINAPI d3d8_surface_GetDevice(IDirect3DSurface8 *iface, IDirect3DDevice8 **device)
 114 {
 115     struct d3d8_surface *surface = impl_from_IDirect3DSurface8(iface);
 116
 117     TRACE("iface %p, device %p.\n", iface, device);
 118
 119     if (surface->texture)
 120         return IDirect3DBaseTexture8_GetDevice(&surface->texture->IDirect3DBaseTexture8_iface, device);
 121
 122     *device = surface->parent_device;
 123     IDirect3DDevice8_AddRef(*device);
 124
 125     TRACE("Returning device %p.\n", *device);
 126
 127     return D3D_OK;
 128 }
 129
 130 static HRESULT WINAPI d3d8_surface_SetPrivateData(IDirect3DSurface8 *iface, REFGUID guid,
 131         const void *data, DWORD data_size, DWORD flags)
 132 {
 133     struct d3d8_surface *surface = impl_from_IDirect3DSurface8(iface);
 134     TRACE("iface %p, guid %s, data %p, data_size %u, flags %#x.\n",
 135             iface, debugstr_guid(guid), data, data_size, flags);
 136
 137     return d3d8_resource_set_private_data(&surface->resource, guid, data, data_size, flags);
 138 }
 139
 140 static HRESULT WINAPI d3d8_surface_GetPrivateData(IDirect3DSurface8 *iface, REFGUID guid,
 141         void *data, DWORD *data_size)
 142 {
 143     struct d3d8_surface *surface = impl_from_IDirect3DSurface8(iface);
 144     TRACE("iface %p, guid %s, data %p, data_size %p.\n",
 145             iface, debugstr_guid(guid), data, data_size);
 146
 147     return d3d8_resource_get_private_data(&surface->resource, guid, data, data_size);
 148 }
 149
 150 static HRESULT WINAPI d3d8_surface_FreePrivateData(IDirect3DSurface8 *iface, REFGUID guid)
 151 {
 152     struct d3d8_surface *surface = impl_from_IDirect3DSurface8(iface);
 153     TRACE("iface %p, guid %s.\n", iface, debugstr_guid(guid));
 154
 155     return d3d8_resource_free_private_data(&surface->resource, guid);
 156 }
 157
 158 static HRESULT WINAPI d3d8_surface_GetContainer(IDirect3DSurface8 *iface, REFIID riid, void **container)
 159 {
 160     struct d3d8_surface *surface = impl_from_IDirect3DSurface8(iface);
 161     HRESULT hr;
 162
 163     TRACE("iface %p, riid %s, container %p.\n", iface, debugstr_guid(riid), container);
 164
 165     if (!surface->container)
 166         return E_NOINTERFACE;
 167
 168     hr = IUnknown_QueryInterface(surface->container, riid, container);
 169
 170     TRACE("Returning %p.\n", *container);
 171
 172     return hr;
 173 }
 174
 175 static HRESULT WINAPI d3d8_surface_GetDesc(IDirect3DSurface8 *iface, D3DSURFACE_DESC *desc)
 176 {
 177     struct d3d8_surface *surface = impl_from_IDirect3DSurface8(iface);
 178     struct wined3d_sub_resource_desc wined3d_desc;
 179
 180     TRACE("iface %p, desc %p.\n", iface, desc);
 181
 182     wined3d_mutex_lock();
 183     wined3d_texture_get_sub_resource_desc(surface->wined3d_texture, surface->sub_resource_idx, &wined3d_desc);
 184     wined3d_mutex_unlock();
 185
 186     desc->Format = d3dformat_from_wined3dformat(wined3d_desc.format);
 187     desc->Type = D3DRTYPE_SURFACE;
 188     desc->Usage = wined3d_desc.usage & WINED3DUSAGE_MASK;
 189     desc->Pool = wined3d_desc.pool;
 190     desc->Size = wined3d_desc.size;
 191     desc->MultiSampleType = wined3d_desc.multisample_type;
 192     desc->Width = wined3d_desc.width;
 193     desc->Height = wined3d_desc.height;
 194
 195     return D3D_OK;
 196 }
 197
 198 static HRESULT WINAPI d3d8_surface_LockRect(IDirect3DSurface8 *iface,
 199         D3DLOCKED_RECT *locked_rect, const RECT *rect, DWORD flags)
 200 {
 201     struct d3d8_surface *surface = impl_from_IDirect3DSurface8(iface);
 202     struct wined3d_box box;
 203     struct wined3d_map_desc map_desc;
 204     HRESULT hr;
 205     D3DRESOURCETYPE type;
 206
 207     TRACE("iface %p, locked_rect %p, rect %s, flags %#x.\n",
 208             iface, locked_rect, wine_dbgstr_rect(rect), flags);
 209
 210     wined3d_mutex_lock();
 211
 212     if (surface->texture)
 213         type = IDirect3DBaseTexture8_GetType(&surface->texture->IDirect3DBaseTexture8_iface);
 214     else
 215         type = D3DRTYPE_SURFACE;
 216
 217     if (rect)
 218     {
 219         D3DSURFACE_DESC desc;
 220         IDirect3DSurface8_GetDesc(iface, &desc);
 221
 222         if (type != D3DRTYPE_TEXTURE
 223                 && ((rect->left < 0)
 224                 || (rect->top < 0)
 225                 || (rect->left >= rect->right)
 226                 || (rect->top >= rect->bottom)
 227                 || (rect->right > desc.Width)
 228                 || (rect->bottom > desc.Height)))
 229         {
 230             WARN("Trying to lock an invalid rectangle, returning D3DERR_INVALIDCALL\n");
 231             wined3d_mutex_unlock();
 232
 233             locked_rect->Pitch = 0;
 234             locked_rect->pBits = NULL;
 235             return D3DERR_INVALIDCALL;
 236         }
 237         box.left = rect->left;
 238         box.top = rect->top;
 239         box.right = rect->right;
 240         box.bottom = rect->bottom;
 241         box.front = 0;
 242         box.back = 1;
 243     }
 244
 245     hr = wined3d_resource_map(wined3d_texture_get_resource(surface->wined3d_texture), surface->sub_resource_idx,
 246             &map_desc, rect ? &box : NULL, flags);
 247     wined3d_mutex_unlock();
 248
 249     if (SUCCEEDED(hr))
 250     {
 251         locked_rect->Pitch = map_desc.row_pitch;
 252         locked_rect->pBits = map_desc.data;
 253     }
 254     else if (type != D3DRTYPE_TEXTURE)
 255     {
 256         locked_rect->Pitch = 0;
 257         locked_rect->pBits = NULL;
 258     }
 259
 260     return hr;
 261 }
 262
 263 static HRESULT WINAPI d3d8_surface_UnlockRect(IDirect3DSurface8 *iface)
 264 {
 265     struct d3d8_surface *surface = impl_from_IDirect3DSurface8(iface);
 266     HRESULT hr;
 267
 268     TRACE("iface %p.\n", iface);
 269
 270     wined3d_mutex_lock();
 271     hr = wined3d_resource_unmap(wined3d_texture_get_resource(surface->wined3d_texture), surface->sub_resource_idx);
 272     wined3d_mutex_unlock();
 273
 274     if (hr == WINEDDERR_NOTLOCKED)
 275     {
 276         D3DRESOURCETYPE type;
 277         if (surface->texture)
 278             type = IDirect3DBaseTexture8_GetType(&surface->texture->IDirect3DBaseTexture8_iface);
 279         else
 280             type = D3DRTYPE_SURFACE;
 281         hr = type == D3DRTYPE_TEXTURE ? D3D_OK : D3DERR_INVALIDCALL;
 282     }
 283     return hr;
 284 }
 285
 286 static const IDirect3DSurface8Vtbl d3d8_surface_vtbl =
 287 {
 288     /* IUnknown */
 289     d3d8_surface_QueryInterface,
 290     d3d8_surface_AddRef,
 291     d3d8_surface_Release,
 292     /* IDirect3DResource8 */
 293     d3d8_surface_GetDevice,
 294     d3d8_surface_SetPrivateData,
 295     d3d8_surface_GetPrivateData,
 296     d3d8_surface_FreePrivateData,
 297     /* IDirect3DSurface8 */
 298     d3d8_surface_GetContainer,
 299     d3d8_surface_GetDesc,
 300     d3d8_surface_LockRect,
 301     d3d8_surface_UnlockRect,
 302 };
 303
 304 static void STDMETHODCALLTYPE surface_wined3d_object_destroyed(void *parent)
 305 {
 306     struct d3d8_surface *surface = parent;
 307     d3d8_resource_cleanup(&surface->resource);
 308     HeapFree(GetProcessHeap(), 0, surface);
 309 }
 310
 311 static const struct wined3d_parent_ops d3d8_surface_wined3d_parent_ops =
 312 {
 313     surface_wined3d_object_destroyed,
 314 };
 315
 316 void surface_init(struct d3d8_surface *surface, struct wined3d_texture *wined3d_texture, unsigned int sub_resource_idx,
 317         const struct wined3d_parent_ops **parent_ops)
 318 {
 319     IDirect3DBaseTexture8 *texture;
 320
 321     surface->IDirect3DSurface8_iface.lpVtbl = &d3d8_surface_vtbl;
 322     d3d8_resource_init(&surface->resource);
 323     surface->resource.refcount = 0;
 324     list_init(&surface->rtv_entry);
 325     surface->container = wined3d_texture_get_parent(wined3d_texture);
 326     surface->wined3d_texture = wined3d_texture;
 327     surface->sub_resource_idx = sub_resource_idx;
 328
 329     if (surface->container && SUCCEEDED(IUnknown_QueryInterface(surface->container,
 330             &IID_IDirect3DBaseTexture8, (void **)&texture)))
 331     {
 332         surface->texture = unsafe_impl_from_IDirect3DBaseTexture8(texture);
 333         IDirect3DBaseTexture8_Release(texture);
 334     }
 335
 336     *parent_ops = &d3d8_surface_wined3d_parent_ops;
 337 }
 338
 339 static void STDMETHODCALLTYPE view_wined3d_object_destroyed(void *parent)
 340 {
 341     struct d3d8_surface *surface = parent;
 342
 343     /* If the surface reference count drops to zero, we release our reference
 344      * to the view, but don't clear the pointer yet, in case e.g. a
 345      * GetRenderTarget() call brings the surface back before the view is
 346      * actually destroyed. When the view is destroyed, we need to clear the
 347      * pointer, or a subsequent surface AddRef() would reference it again.
 348      *
 349      * This is safe because as long as the view still has a reference to the
 350      * texture, the surface is also still alive, and we're called before the
 351      * view releases that reference. */
 352     surface->wined3d_rtv = NULL;
 353     list_remove(&surface->rtv_entry);
 354 }
 355
 356 static const struct wined3d_parent_ops d3d8_view_wined3d_parent_ops =
 357 {
 358     view_wined3d_object_destroyed,
 359 };
 360
 361 struct d3d8_device *d3d8_surface_get_device(const struct d3d8_surface *surface)
 362 {
 363     IDirect3DDevice8 *device;
 364     device = surface->texture ? surface->texture->parent_device : surface->parent_device;
 365     return impl_from_IDirect3DDevice8(device);
 366 }
 367
 368 struct wined3d_rendertarget_view *d3d8_surface_acquire_rendertarget_view(struct d3d8_surface *surface)
 369 {
 370     HRESULT hr;
 371
 372     /* The surface reference count can be equal to 0 when this function is
 373      * called. In order to properly manage the render target view reference
 374      * count, we temporarily increment the surface reference count. */
 375     d3d8_surface_AddRef(&surface->IDirect3DSurface8_iface);
 376
 377     if (surface->wined3d_rtv)
 378         return surface->wined3d_rtv;
 379
 380     if (FAILED(hr = wined3d_rendertarget_view_create_from_sub_resource(surface->wined3d_texture,
 381             surface->sub_resource_idx, surface, &d3d8_view_wined3d_parent_ops, &surface->wined3d_rtv)))
 382     {
 383         ERR("Failed to create rendertarget view, hr %#x.\n", hr);
 384         d3d8_surface_Release(&surface->IDirect3DSurface8_iface);
 385         return NULL;
 386     }
 387
 388     if (surface->texture)
 389         list_add_head(&surface->texture->rtv_list, &surface->rtv_entry);
 390
 391     return surface->wined3d_rtv;
 392 }
 393
 394 void d3d8_surface_release_rendertarget_view(struct d3d8_surface *surface,
 395         struct wined3d_rendertarget_view *rtv)
 396 {
 397     if (rtv)
 398         d3d8_surface_Release(&surface->IDirect3DSurface8_iface);
 399 }
 400
 401 struct d3d8_surface *unsafe_impl_from_IDirect3DSurface8(IDirect3DSurface8 *iface)
 402 {
 403     if (!iface)
 404         return NULL;
 405     assert(iface->lpVtbl == &d3d8_surface_vtbl);
 406
 407     return impl_from_IDirect3DSurface8(iface);
 408 }