dlls/ddraw/viewport.c

   1 /* Direct3D Viewport
   2  * Copyright (c) 1998 Lionel ULMER
   3  * Copyright (c) 2006-2007 Stefan DÖSINGER
   4  *
   5  * This file contains the implementation of Direct3DViewport2.
   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  * Helper functions
  31  *****************************************************************************/
  32
  33 static void update_clip_space(struct d3d_device *device,
  34         struct wined3d_vec3 *scale, struct wined3d_vec3 *offset)
  35 {
  36     D3DMATRIX clip_space =
  37     {
  38         scale->x,  0.0f,      0.0f,      0.0f,
  39         0.0f,      scale->y,  0.0f,      0.0f,
  40         0.0f,      0.0f,      scale->z,  0.0f,
  41         offset->x, offset->y, offset->z, 1.0f,
  42     };
  43     D3DMATRIX projection;
  44
  45     multiply_matrix(&projection, &clip_space, &device->legacy_projection);
  46     wined3d_device_set_transform(device->wined3d_device,
  47             WINED3D_TS_PROJECTION, (struct wined3d_matrix *)&projection);
  48     device->legacy_clipspace = clip_space;
  49 }
  50
  51 /*****************************************************************************
  52  * viewport_activate
  53  *
  54  * activates the viewport using IDirect3DDevice7::SetViewport
  55  *
  56  *****************************************************************************/
  57 void viewport_activate(struct d3d_viewport *This, BOOL ignore_lights)
  58 {
  59     struct wined3d_vec3 scale, offset;
  60     D3DVIEWPORT7 vp;
  61
  62     if (!ignore_lights)
  63     {
  64         struct d3d_light *light;
  65
  66         /* Activate all the lights associated with this context */
  67         LIST_FOR_EACH_ENTRY(light, &This->light_list, struct d3d_light, entry)
  68         {
  69             light_activate(light);
  70         }
  71     }
  72
  73     /* And copy the values in the structure used by the device */
  74     if (This->use_vp2)
  75     {
  76         vp.dwX = This->viewports.vp2.dwX;
  77         vp.dwY = This->viewports.vp2.dwY;
  78         vp.dwHeight = This->viewports.vp2.dwHeight;
  79         vp.dwWidth = This->viewports.vp2.dwWidth;
  80         vp.dvMinZ = 0.0f;
  81         vp.dvMaxZ = 1.0f;
  82
  83         scale.x = 2.0f / This->viewports.vp2.dvClipWidth;
  84         scale.y = 2.0f / This->viewports.vp2.dvClipHeight;
  85         scale.z = 1.0f / (This->viewports.vp2.dvMaxZ - This->viewports.vp2.dvMinZ);
  86         offset.x = -2.0f * This->viewports.vp2.dvClipX / This->viewports.vp2.dvClipWidth - 1.0f;
  87         offset.y = -2.0f * This->viewports.vp2.dvClipY / This->viewports.vp2.dvClipHeight + 1.0f;
  88         offset.z = -This->viewports.vp2.dvMinZ / (This->viewports.vp2.dvMaxZ - This->viewports.vp2.dvMinZ);
  89     }
  90     else
  91     {
  92         vp.dwX = This->viewports.vp1.dwX;
  93         vp.dwY = This->viewports.vp1.dwY;
  94         vp.dwHeight = This->viewports.vp1.dwHeight;
  95         vp.dwWidth = This->viewports.vp1.dwWidth;
  96         vp.dvMinZ = 0.0f;
  97         vp.dvMaxZ = 1.0f;
  98
  99         scale.x = 2.0f * This->viewports.vp1.dvScaleX / This->viewports.vp1.dwWidth;
 100         scale.y = 2.0f * This->viewports.vp1.dvScaleY / This->viewports.vp1.dwHeight;
 101         scale.z = 1.0f;
 102         offset.x = 0.0f;
 103         offset.y = 0.0f;
 104         offset.z = 0.0f;
 105     }
 106
 107     update_clip_space(This->active_device, &scale, &offset);
 108     IDirect3DDevice7_SetViewport(&This->active_device->IDirect3DDevice7_iface, &vp);
 109 }
 110
 111 /*****************************************************************************
 112  * _dump_D3DVIEWPORT, _dump_D3DVIEWPORT2
 113  *
 114  * Writes viewport information to TRACE
 115  *
 116  *****************************************************************************/
 117 static void _dump_D3DVIEWPORT(const D3DVIEWPORT *lpvp)
 118 {
 119     TRACE("    - dwSize = %d   dwX = %d   dwY = %d\n",
 120             lpvp->dwSize, lpvp->dwX, lpvp->dwY);
 121     TRACE("    - dwWidth = %d   dwHeight = %d\n",
 122             lpvp->dwWidth, lpvp->dwHeight);
 123     TRACE("    - dvScaleX = %f   dvScaleY = %f\n",
 124             lpvp->dvScaleX, lpvp->dvScaleY);
 125     TRACE("    - dvMaxX = %f   dvMaxY = %f\n",
 126             lpvp->dvMaxX, lpvp->dvMaxY);
 127     TRACE("    - dvMinZ = %f   dvMaxZ = %f\n",
 128             lpvp->dvMinZ, lpvp->dvMaxZ);
 129 }
 130
 131 static void _dump_D3DVIEWPORT2(const D3DVIEWPORT2 *lpvp)
 132 {
 133     TRACE("    - dwSize = %d   dwX = %d   dwY = %d\n",
 134             lpvp->dwSize, lpvp->dwX, lpvp->dwY);
 135     TRACE("    - dwWidth = %d   dwHeight = %d\n",
 136             lpvp->dwWidth, lpvp->dwHeight);
 137     TRACE("    - dvClipX = %f   dvClipY = %f\n",
 138             lpvp->dvClipX, lpvp->dvClipY);
 139     TRACE("    - dvClipWidth = %f   dvClipHeight = %f\n",
 140             lpvp->dvClipWidth, lpvp->dvClipHeight);
 141     TRACE("    - dvMinZ = %f   dvMaxZ = %f\n",
 142             lpvp->dvMinZ, lpvp->dvMaxZ);
 143 }
 144
 145 static inline struct d3d_viewport *impl_from_IDirect3DViewport3(IDirect3DViewport3 *iface)
 146 {
 147     return CONTAINING_RECORD(iface, struct d3d_viewport, IDirect3DViewport3_iface);
 148 }
 149
 150 /*****************************************************************************
 151  * IUnknown Methods.
 152  *****************************************************************************/
 153
 154 /*****************************************************************************
 155  * IDirect3DViewport3::QueryInterface
 156  *
 157  * A normal QueryInterface. Can query all interface versions and the
 158  * IUnknown interface. The VTables of the different versions
 159  * are equal
 160  *
 161  * Params:
 162  *  refiid: Interface id queried for
 163  *  obj: Address to write the interface pointer to
 164  *
 165  * Returns:
 166  *  S_OK on success.
 167  *  E_NOINTERFACE if the requested interface wasn't found
 168  *
 169  *****************************************************************************/
 170 static HRESULT WINAPI d3d_viewport_QueryInterface(IDirect3DViewport3 *iface, REFIID riid, void **object)
 171 {
 172     TRACE("iface %p, riid %s, object %p.\n", iface, debugstr_guid(riid), object);
 173
 174     if (IsEqualGUID(&IID_IDirect3DViewport3, riid)
 175             || IsEqualGUID(&IID_IDirect3DViewport2, riid)
 176             || IsEqualGUID(&IID_IDirect3DViewport, riid)
 177             || IsEqualGUID(&IID_IUnknown, riid))
 178     {
 179         IDirect3DViewport3_AddRef(iface);
 180         *object = iface;
 181         return S_OK;
 182     }
 183
 184     WARN("%s not implemented, returning E_NOINTERFACE.\n", debugstr_guid(riid));
 185
 186     *object = NULL;
 187     return E_NOINTERFACE;
 188 }
 189
 190 /*****************************************************************************
 191  * IDirect3DViewport3::AddRef
 192  *
 193  * Increases the refcount.
 194  *
 195  * Returns:
 196  *  The new refcount
 197  *
 198  *****************************************************************************/
 199 static ULONG WINAPI d3d_viewport_AddRef(IDirect3DViewport3 *iface)
 200 {
 201     struct d3d_viewport *viewport = impl_from_IDirect3DViewport3(iface);
 202     ULONG ref = InterlockedIncrement(&viewport->ref);
 203
 204     TRACE("%p increasing refcount to %u.\n", viewport, ref);
 205
 206     return ref;
 207 }
 208
 209 /*****************************************************************************
 210  * IDirect3DViewport3::Release
 211  *
 212  * Reduces the refcount. If it falls to 0, the interface is released
 213  *
 214  * Returns:
 215  *  The new refcount
 216  *
 217  *****************************************************************************/
 218 static ULONG WINAPI d3d_viewport_Release(IDirect3DViewport3 *iface)
 219 {
 220     struct d3d_viewport *viewport = impl_from_IDirect3DViewport3(iface);
 221     ULONG ref = InterlockedDecrement(&viewport->ref);
 222
 223     TRACE("%p decreasing refcount to %u.\n", viewport, ref);
 224
 225     if (!ref)
 226         HeapFree(GetProcessHeap(), 0, viewport);
 227
 228     return ref;
 229 }
 230
 231 /*****************************************************************************
 232  * IDirect3DViewport Methods.
 233  *****************************************************************************/
 234
 235 /*****************************************************************************
 236  * IDirect3DViewport3::Initialize
 237  *
 238  * No-op initialization.
 239  *
 240  * Params:
 241  *  Direct3D: The direct3D device this viewport is assigned to
 242  *
 243  * Returns:
 244  *  DDERR_ALREADYINITIALIZED
 245  *
 246  *****************************************************************************/
 247 static HRESULT WINAPI d3d_viewport_Initialize(IDirect3DViewport3 *iface, IDirect3D *d3d)
 248 {
 249     TRACE("iface %p, d3d %p.\n", iface, d3d);
 250
 251     return DDERR_ALREADYINITIALIZED;
 252 }
 253
 254 /*****************************************************************************
 255  * IDirect3DViewport3::GetViewport
 256  *
 257  * Returns the viewport data assigned to this viewport interface
 258  *
 259  * Params:
 260  *  Data: Address to store the data
 261  *
 262  * Returns:
 263  *  D3D_OK on success
 264  *  DDERR_INVALIDPARAMS if Data is NULL
 265  *
 266  *****************************************************************************/
 267 static HRESULT WINAPI d3d_viewport_GetViewport(IDirect3DViewport3 *iface, D3DVIEWPORT *lpData)
 268 {
 269     struct d3d_viewport *This = impl_from_IDirect3DViewport3(iface);
 270     DWORD dwSize;
 271
 272     TRACE("iface %p, data %p.\n", iface, lpData);
 273
 274     wined3d_mutex_lock();
 275
 276     dwSize = lpData->dwSize;
 277     memset(lpData, 0, dwSize);
 278     if (!This->use_vp2)
 279         memcpy(lpData, &(This->viewports.vp1), dwSize);
 280     else {
 281         D3DVIEWPORT vp1;
 282         vp1.dwSize = sizeof(vp1);
 283         vp1.dwX = This->viewports.vp2.dwX;
 284         vp1.dwY = This->viewports.vp2.dwY;
 285         vp1.dwWidth = This->viewports.vp2.dwWidth;
 286         vp1.dwHeight = This->viewports.vp2.dwHeight;
 287         vp1.dvMaxX = 0.0;
 288         vp1.dvMaxY = 0.0;
 289         vp1.dvScaleX = 0.0;
 290         vp1.dvScaleY = 0.0;
 291         vp1.dvMinZ = This->viewports.vp2.dvMinZ;
 292         vp1.dvMaxZ = This->viewports.vp2.dvMaxZ;
 293         memcpy(lpData, &vp1, dwSize);
 294     }
 295
 296     if (TRACE_ON(ddraw))
 297     {
 298         TRACE("  returning D3DVIEWPORT :\n");
 299         _dump_D3DVIEWPORT(lpData);
 300     }
 301
 302     wined3d_mutex_unlock();
 303
 304     return DD_OK;
 305 }
 306
 307 /*****************************************************************************
 308  * IDirect3DViewport3::SetViewport
 309  *
 310  * Sets the viewport information for this interface
 311  *
 312  * Params:
 313  *  lpData: Viewport to set
 314  *
 315  * Returns:
 316  *  D3D_OK on success
 317  *  DDERR_INVALIDPARAMS if Data is NULL
 318  *
 319  *****************************************************************************/
 320 static HRESULT WINAPI d3d_viewport_SetViewport(IDirect3DViewport3 *iface, D3DVIEWPORT *lpData)
 321 {
 322     struct d3d_viewport *This = impl_from_IDirect3DViewport3(iface);
 323     IDirect3DViewport3 *current_viewport;
 324
 325     TRACE("iface %p, data %p.\n", iface, lpData);
 326
 327     if (TRACE_ON(ddraw))
 328     {
 329         TRACE("  getting D3DVIEWPORT :\n");
 330         _dump_D3DVIEWPORT(lpData);
 331     }
 332
 333     wined3d_mutex_lock();
 334
 335     This->use_vp2 = 0;
 336     memset(&(This->viewports.vp1), 0, sizeof(This->viewports.vp1));
 337     memcpy(&(This->viewports.vp1), lpData, lpData->dwSize);
 338
 339     /* Tests on two games show that these values are never used properly so override
 340        them with proper ones :-)
 341     */
 342     This->viewports.vp1.dvMinZ = 0.0;
 343     This->viewports.vp1.dvMaxZ = 1.0;
 344
 345     if (This->active_device) {
 346         IDirect3DDevice3 *d3d_device3 = &This->active_device->IDirect3DDevice3_iface;
 347         IDirect3DDevice3_GetCurrentViewport(d3d_device3, &current_viewport);
 348         if (current_viewport)
 349         {
 350             if (current_viewport == iface) viewport_activate(This, FALSE);
 351             IDirect3DViewport3_Release(current_viewport);
 352         }
 353     }
 354
 355     wined3d_mutex_unlock();
 356
 357     return DD_OK;
 358 }
 359
 360 /*****************************************************************************
 361  * IDirect3DViewport3::TransformVertices
 362  *
 363  * Transforms vertices by the transformation matrix.
 364  *
 365  * This function is pretty similar to IDirect3DVertexBuffer7::ProcessVertices,
 366  * so it's tempting to forward it to there. However, there are some
 367  * tiny differences. First, the lpOffscreen flag that is reported back,
 368  * then there is the homogeneous vertex that is generated. Also there's a lack
 369  * of FVFs, but still a custom stride. Last, the d3d1 - d3d3 viewport has some
 370  * settings (scale) that d3d7 and wined3d do not have. All in all wrapping to
 371  * ProcessVertices doesn't pay of in terms of wrapper code needed and code
 372  * reused.
 373  *
 374  * Params:
 375  *  dwVertexCount: The number of vertices to be transformed
 376  *  lpData: Pointer to the vertex data
 377  *  dwFlags: D3DTRANSFORM_CLIPPED or D3DTRANSFORM_UNCLIPPED
 378  *  lpOffScreen: Set to the clipping plane clipping the vertex, if only one
 379  *               vertex is transformed and clipping is on. 0 otherwise
 380  *
 381  * Returns:
 382  *  D3D_OK on success
 383  *  D3DERR_VIEWPORTHASNODEVICE if the viewport is not assigned to a device
 384  *  DDERR_INVALIDPARAMS if no clipping flag is specified
 385  *
 386  *****************************************************************************/
 387 static HRESULT WINAPI d3d_viewport_TransformVertices(IDirect3DViewport3 *iface,
 388         DWORD dwVertexCount, D3DTRANSFORMDATA *lpData, DWORD dwFlags, DWORD *lpOffScreen)
 389 {
 390     struct d3d_viewport *viewport = impl_from_IDirect3DViewport3(iface);
 391     D3DVIEWPORT vp = viewport->viewports.vp1;
 392     D3DMATRIX view_mat, world_mat, mat;
 393     float *in;
 394     float *out;
 395     float x, y, z, w;
 396     unsigned int i;
 397     D3DHVERTEX *outH;
 398
 399     TRACE("iface %p, vertex_count %u, vertex_data %p, flags %#x, clip_plane %p.\n",
 400             iface, dwVertexCount, lpData, dwFlags, lpOffScreen);
 401
 402     /* Tests on windows show that Windows crashes when this occurs,
 403      * so don't return the (intuitive) return value
 404     if (!viewport->active_device)
 405     {
 406         WARN("No device active, returning D3DERR_VIEWPORTHASNODEVICE\n");
 407         return D3DERR_VIEWPORTHASNODEVICE;
 408     }
 409      */
 410
 411     if(!(dwFlags & (D3DTRANSFORM_UNCLIPPED | D3DTRANSFORM_CLIPPED)))
 412     {
 413         WARN("No clipping flag passed, returning DDERR_INVALIDPARAMS\n");
 414         return DDERR_INVALIDPARAMS;
 415     }
 416
 417
 418     wined3d_mutex_lock();
 419     wined3d_device_get_transform(viewport->active_device->wined3d_device,
 420             D3DTRANSFORMSTATE_VIEW, (struct wined3d_matrix *)&view_mat);
 421     wined3d_device_get_transform(viewport->active_device->wined3d_device,
 422             WINED3D_TS_WORLD_MATRIX(0), (struct wined3d_matrix *)&world_mat);
 423     multiply_matrix(&mat, &view_mat, &world_mat);
 424     multiply_matrix(&mat, &viewport->active_device->legacy_projection, &mat);
 425
 426     in = lpData->lpIn;
 427     out = lpData->lpOut;
 428     outH = lpData->lpHOut;
 429     for(i = 0; i < dwVertexCount; i++)
 430     {
 431         x = (in[0] * mat._11) + (in[1] * mat._21) + (in[2] * mat._31) + (1.0 * mat._41);
 432         y = (in[0] * mat._12) + (in[1] * mat._22) + (in[2] * mat._32) + (1.0 * mat._42);
 433         z = (in[0] * mat._13) + (in[1] * mat._23) + (in[2] * mat._33) + (1.0 * mat._43);
 434         w = (in[0] * mat._14) + (in[1] * mat._24) + (in[2] * mat._34) + (1.0 * mat._44);
 435
 436         if(dwFlags & D3DTRANSFORM_CLIPPED)
 437         {
 438             /* If clipping is enabled, Windows assumes that outH is
 439              * a valid pointer
 440              */
 441             outH[i].u1.hx = x; outH[i].u2.hy = y; outH[i].u3.hz = z;
 442
 443             outH[i].dwFlags = 0;
 444             if(x * vp.dvScaleX > ((float) vp.dwWidth * 0.5))
 445                 outH[i].dwFlags |= D3DCLIP_RIGHT;
 446             if(x * vp.dvScaleX <= -((float) vp.dwWidth) * 0.5)
 447                 outH[i].dwFlags |= D3DCLIP_LEFT;
 448             if(y * vp.dvScaleY > ((float) vp.dwHeight * 0.5))
 449                 outH[i].dwFlags |= D3DCLIP_TOP;
 450             if(y * vp.dvScaleY <= -((float) vp.dwHeight) * 0.5)
 451                 outH[i].dwFlags |= D3DCLIP_BOTTOM;
 452             if(z < 0.0)
 453                 outH[i].dwFlags |= D3DCLIP_FRONT;
 454             if(z > 1.0)
 455                 outH[i].dwFlags |= D3DCLIP_BACK;
 456
 457             if(outH[i].dwFlags)
 458             {
 459                 /* Looks like native just drops the vertex, leaves whatever data
 460                  * it has in the output buffer and goes on with the next vertex.
 461                  * The exact scheme hasn't been figured out yet, but windows
 462                  * definitely writes something there.
 463                  */
 464                 out[0] = x;
 465                 out[1] = y;
 466                 out[2] = z;
 467                 out[3] = w;
 468                 in = (float *) ((char *) in + lpData->dwInSize);
 469                 out = (float *) ((char *) out + lpData->dwOutSize);
 470                 continue;
 471             }
 472         }
 473
 474         w = 1 / w;
 475         x *= w; y *= w; z *= w;
 476
 477         out[0] = vp.dwWidth / 2 + vp.dwX + x * vp.dvScaleX;
 478         out[1] = vp.dwHeight / 2 + vp.dwY - y * vp.dvScaleY;
 479         out[2] = z;
 480         out[3] = w;
 481         in = (float *) ((char *) in + lpData->dwInSize);
 482         out = (float *) ((char *) out + lpData->dwOutSize);
 483     }
 484
 485     /* According to the d3d test, the offscreen flag is set only
 486      * if exactly one vertex is transformed. Its not documented,
 487      * but the test shows that the lpOffscreen flag is set to the
 488      * flag combination of clipping planes that clips the vertex.
 489      *
 490      * If clipping is requested, Windows assumes that the offscreen
 491      * param is a valid pointer.
 492      */
 493     if(dwVertexCount == 1 && dwFlags & D3DTRANSFORM_CLIPPED)
 494     {
 495         *lpOffScreen = outH[0].dwFlags;
 496     }
 497     else if(*lpOffScreen)
 498     {
 499         *lpOffScreen = 0;
 500     }
 501     wined3d_mutex_unlock();
 502
 503     TRACE("All done\n");
 504     return DD_OK;
 505 }
 506
 507 /*****************************************************************************
 508  * IDirect3DViewport3::LightElements
 509  *
 510  * The DirectX 5.0 sdk says that it's not implemented
 511  *
 512  * Params:
 513  *  ?
 514  *
 515  * Returns:
 516  *  DDERR_UNSUPPORTED
 517  *
 518  *****************************************************************************/
 519 static HRESULT WINAPI d3d_viewport_LightElements(IDirect3DViewport3 *iface,
 520         DWORD element_count, D3DLIGHTDATA *data)
 521 {
 522     TRACE("iface %p, element_count %u, data %p.\n", iface, element_count, data);
 523
 524     return DDERR_UNSUPPORTED;
 525 }
 526
 527 /*****************************************************************************
 528  * IDirect3DViewport3::SetBackground
 529  *
 530  * Sets the background material
 531  *
 532  * Params:
 533  *  hMat: Handle from a IDirect3DMaterial interface
 534  *
 535  * Returns:
 536  *  D3D_OK on success
 537  *
 538  *****************************************************************************/
 539 static HRESULT WINAPI d3d_viewport_SetBackground(IDirect3DViewport3 *iface, D3DMATERIALHANDLE hMat)
 540 {
 541     struct d3d_viewport *viewport = impl_from_IDirect3DViewport3(iface);
 542     struct d3d_material *m;
 543
 544     TRACE("iface %p, material %#x.\n", iface, hMat);
 545
 546     wined3d_mutex_lock();
 547
 548     if (!hMat)
 549     {
 550         viewport->background = NULL;
 551         TRACE("Setting background to NULL\n");
 552         wined3d_mutex_unlock();
 553         return D3D_OK;
 554     }
 555
 556     m = ddraw_get_object(&viewport->ddraw->d3ddevice->handle_table, hMat - 1, DDRAW_HANDLE_MATERIAL);
 557     if (!m)
 558     {
 559         WARN("Invalid material handle.\n");
 560         wined3d_mutex_unlock();
 561         return DDERR_INVALIDPARAMS;
 562     }
 563
 564     TRACE("Setting background color : %.8e %.8e %.8e %.8e.\n",
 565             m->mat.u.diffuse.u1.r, m->mat.u.diffuse.u2.g,
 566             m->mat.u.diffuse.u3.b, m->mat.u.diffuse.u4.a);
 567     viewport->background = m;
 568
 569     wined3d_mutex_unlock();
 570
 571     return D3D_OK;
 572 }
 573
 574 /*****************************************************************************
 575  * IDirect3DViewport3::GetBackground
 576  *
 577  * Returns the material handle assigned to the background of the viewport
 578  *
 579  * Params:
 580  *  lphMat: Address to store the handle
 581  *  lpValid: is set to FALSE if no background is set, TRUE if one is set
 582  *
 583  * Returns:
 584  *  D3D_OK
 585  *
 586  *****************************************************************************/
 587 static HRESULT WINAPI d3d_viewport_GetBackground(IDirect3DViewport3 *iface,
 588         D3DMATERIALHANDLE *material, BOOL *valid)
 589 {
 590     struct d3d_viewport *viewport = impl_from_IDirect3DViewport3(iface);
 591
 592     TRACE("iface %p, material %p, valid %p.\n", iface, material, valid);
 593
 594     wined3d_mutex_lock();
 595     if (valid)
 596         *valid = !!viewport->background;
 597     if (material)
 598         *material = viewport->background ? viewport->background->Handle : 0;
 599     wined3d_mutex_unlock();
 600
 601     return D3D_OK;
 602 }
 603
 604 /*****************************************************************************
 605  * IDirect3DViewport3::SetBackgroundDepth
 606  *
 607  * Sets a surface that represents the background depth. It's contents are
 608  * used to set the depth buffer in IDirect3DViewport3::Clear
 609  *
 610  * Params:
 611  *  lpDDSurface: Surface to set
 612  *
 613  * Returns: D3D_OK, because it's a stub
 614  *
 615  *****************************************************************************/
 616 static HRESULT WINAPI d3d_viewport_SetBackgroundDepth(IDirect3DViewport3 *iface, IDirectDrawSurface *surface)
 617 {
 618     FIXME("iface %p, surface %p stub!\n", iface, surface);
 619
 620     return D3D_OK;
 621 }
 622
 623 /*****************************************************************************
 624  * IDirect3DViewport3::GetBackgroundDepth
 625  *
 626  * Returns the surface that represents the depth field
 627  *
 628  * Params:
 629  *  lplpDDSurface: Address to store the interface pointer
 630  *  lpValid: Set to TRUE if a depth is assigned, FALSE otherwise
 631  *
 632  * Returns:
 633  *  D3D_OK, because it's a stub
 634  *  (DDERR_INVALIDPARAMS if DDSurface of Valid is NULL)
 635  *
 636  *****************************************************************************/
 637 static HRESULT WINAPI d3d_viewport_GetBackgroundDepth(IDirect3DViewport3 *iface,
 638         IDirectDrawSurface **surface, BOOL *valid)
 639 {
 640     FIXME("iface %p, surface %p, valid %p stub!\n", iface, surface, valid);
 641
 642     return DD_OK;
 643 }
 644
 645 /*****************************************************************************
 646  * IDirect3DViewport3::Clear
 647  *
 648  * Clears the render target and / or the z buffer
 649  *
 650  * Params:
 651  *  dwCount: The amount of rectangles to clear. If 0, the whole buffer is
 652  *           cleared
 653  *  lpRects: Pointer to the array of rectangles. If NULL, Count must be 0
 654  *  dwFlags: D3DCLEAR_ZBUFFER and / or D3DCLEAR_TARGET
 655  *
 656  * Returns:
 657  *  D3D_OK on success
 658  *  D3DERR_VIEWPORTHASNODEVICE if there's no active device
 659  *  The return value of IDirect3DDevice7::Clear
 660  *
 661  *****************************************************************************/
 662 static HRESULT WINAPI d3d_viewport_Clear(IDirect3DViewport3 *iface,
 663         DWORD rect_count, D3DRECT *rects, DWORD flags)
 664 {
 665     struct d3d_viewport *This = impl_from_IDirect3DViewport3(iface);
 666     DWORD color = 0x00000000;
 667     HRESULT hr;
 668     IDirect3DViewport3 *current_viewport;
 669     IDirect3DDevice3 *d3d_device3;
 670
 671     TRACE("iface %p, rect_count %u, rects %p, flags %#x.\n", iface, rect_count, rects, flags);
 672
 673     if (This->active_device == NULL) {
 674         ERR(" Trying to clear a viewport not attached to a device !\n");
 675         return D3DERR_VIEWPORTHASNODEVICE;
 676     }
 677     d3d_device3 = &This->active_device->IDirect3DDevice3_iface;
 678
 679     wined3d_mutex_lock();
 680
 681     if (flags & D3DCLEAR_TARGET)
 682     {
 683         if (This->background == NULL) {
 684             ERR(" Trying to clear the color buffer without background material !\n");
 685         }
 686         else
 687         {
 688             color = ((int)((This->background->mat.u.diffuse.u1.r) * 255) << 16)
 689                     | ((int) ((This->background->mat.u.diffuse.u2.g) * 255) <<  8)
 690                     | ((int) ((This->background->mat.u.diffuse.u3.b) * 255) <<  0)
 691                     | ((int) ((This->background->mat.u.diffuse.u4.a) * 255) << 24);
 692         }
 693     }
 694
 695     /* Need to temporarily activate viewport to clear it. Previously active one will be restored
 696         afterwards. */
 697     viewport_activate(This, TRUE);
 698
 699     hr = IDirect3DDevice7_Clear(&This->active_device->IDirect3DDevice7_iface, rect_count, rects,
 700             flags & (D3DCLEAR_ZBUFFER | D3DCLEAR_TARGET), color, 1.0, 0x00000000);
 701
 702     IDirect3DDevice3_GetCurrentViewport(d3d_device3, &current_viewport);
 703     if (current_viewport)
 704     {
 705         struct d3d_viewport *vp = impl_from_IDirect3DViewport3(current_viewport);
 706         viewport_activate(vp, TRUE);
 707         IDirect3DViewport3_Release(current_viewport);
 708     }
 709
 710     wined3d_mutex_unlock();
 711
 712     return hr;
 713 }
 714
 715 /*****************************************************************************
 716  * IDirect3DViewport3::AddLight
 717  *
 718  * Adds an light to the viewport
 719  *
 720  * Params:
 721  *  lpDirect3DLight: Interface of the light to add
 722  *
 723  * Returns:
 724  *  D3D_OK on success
 725  *  DDERR_INVALIDPARAMS if Direct3DLight is NULL
 726  *  DDERR_INVALIDPARAMS if there are 8 lights or more
 727  *
 728  *****************************************************************************/
 729 static HRESULT WINAPI d3d_viewport_AddLight(IDirect3DViewport3 *iface, IDirect3DLight *lpDirect3DLight)
 730 {
 731     struct d3d_viewport *This = impl_from_IDirect3DViewport3(iface);
 732     struct d3d_light *light_impl = unsafe_impl_from_IDirect3DLight(lpDirect3DLight);
 733     DWORD i = 0;
 734     DWORD map = This->map_lights;
 735
 736     TRACE("iface %p, light %p.\n", iface, lpDirect3DLight);
 737
 738     wined3d_mutex_lock();
 739
 740     if (This->num_lights >= 8)
 741     {
 742         wined3d_mutex_unlock();
 743         return DDERR_INVALIDPARAMS;
 744     }
 745
 746     /* Find a light number and update both light and viewports objects accordingly */
 747     while (map & 1)
 748     {
 749         map >>= 1;
 750         ++i;
 751     }
 752     light_impl->dwLightIndex = i;
 753     This->num_lights++;
 754     This->map_lights |= 1<<i;
 755
 756     /* Add the light in the 'linked' chain */
 757     list_add_head(&This->light_list, &light_impl->entry);
 758     IDirect3DLight_AddRef(lpDirect3DLight);
 759
 760     /* Attach the light to the viewport */
 761     light_impl->active_viewport = This;
 762
 763     /* If active, activate the light */
 764     if (This->active_device)
 765         light_activate(light_impl);
 766
 767     wined3d_mutex_unlock();
 768
 769     return D3D_OK;
 770 }
 771
 772 /*****************************************************************************
 773  * IDirect3DViewport3::DeleteLight
 774  *
 775  * Deletes a light from the viewports' light list
 776  *
 777  * Params:
 778  *  lpDirect3DLight: Light to delete
 779  *
 780  * Returns:
 781  *  D3D_OK on success
 782  *  DDERR_INVALIDPARAMS if the light wasn't found
 783  *
 784  *****************************************************************************/
 785 static HRESULT WINAPI d3d_viewport_DeleteLight(IDirect3DViewport3 *iface, IDirect3DLight *lpDirect3DLight)
 786 {
 787     struct d3d_viewport *viewport = impl_from_IDirect3DViewport3(iface);
 788     struct d3d_light *l = unsafe_impl_from_IDirect3DLight(lpDirect3DLight);
 789
 790     TRACE("iface %p, light %p.\n", iface, lpDirect3DLight);
 791
 792     wined3d_mutex_lock();
 793
 794     if (l->active_viewport != viewport)
 795     {
 796         WARN("Light %p active viewport is %p.\n", l, l->active_viewport);
 797         wined3d_mutex_unlock();
 798         return DDERR_INVALIDPARAMS;
 799     }
 800
 801     light_deactivate(l);
 802     list_remove(&l->entry);
 803     l->active_viewport = NULL;
 804     IDirect3DLight_Release(lpDirect3DLight);
 805     --viewport->num_lights;
 806     viewport->map_lights &= ~(1 << l->dwLightIndex);
 807
 808     wined3d_mutex_unlock();
 809
 810     return D3D_OK;
 811 }
 812
 813 /*****************************************************************************
 814  * IDirect3DViewport::NextLight
 815  *
 816  * Enumerates the lights associated with the viewport
 817  *
 818  * Params:
 819  *  lpDirect3DLight: Light to start with
 820  *  lplpDirect3DLight: Address to store the successor to
 821  *
 822  * Returns:
 823  *  D3D_OK, because it's a stub
 824  *
 825  *****************************************************************************/
 826 static HRESULT WINAPI d3d_viewport_NextLight(IDirect3DViewport3 *iface,
 827         IDirect3DLight *lpDirect3DLight, IDirect3DLight **lplpDirect3DLight, DWORD flags)
 828 {
 829     struct d3d_viewport *viewport = impl_from_IDirect3DViewport3(iface);
 830     struct d3d_light *l = unsafe_impl_from_IDirect3DLight(lpDirect3DLight);
 831     struct list *entry;
 832     HRESULT hr;
 833
 834     TRACE("iface %p, light %p, next_light %p, flags %#x.\n",
 835             iface, lpDirect3DLight, lplpDirect3DLight, flags);
 836
 837     if (!lplpDirect3DLight)
 838         return DDERR_INVALIDPARAMS;
 839
 840     wined3d_mutex_lock();
 841
 842     switch (flags)
 843     {
 844         case D3DNEXT_NEXT:
 845             if (!l || l->active_viewport != viewport)
 846             {
 847                 if (l)
 848                     WARN("Light %p active viewport is %p.\n", l, l->active_viewport);
 849                 entry = NULL;
 850             }
 851             else
 852                 entry = list_next(&viewport->light_list, &l->entry);
 853             break;
 854
 855         case D3DNEXT_HEAD:
 856             entry = list_head(&viewport->light_list);
 857             break;
 858
 859         case D3DNEXT_TAIL:
 860             entry = list_tail(&viewport->light_list);
 861             break;
 862
 863         default:
 864             entry = NULL;
 865             WARN("Invalid flags %#x.\n", flags);
 866             break;
 867     }
 868
 869     if (entry)
 870     {
 871         *lplpDirect3DLight = (IDirect3DLight *)LIST_ENTRY(entry, struct d3d_light, entry);
 872         IDirect3DLight_AddRef(*lplpDirect3DLight);
 873         hr = D3D_OK;
 874     }
 875     else
 876     {
 877         *lplpDirect3DLight = NULL;
 878         hr = DDERR_INVALIDPARAMS;
 879     }
 880
 881     wined3d_mutex_unlock();
 882
 883     return hr;
 884 }
 885
 886 /*****************************************************************************
 887  * IDirect3DViewport2 Methods.
 888  *****************************************************************************/
 889
 890 /*****************************************************************************
 891  * IDirect3DViewport3::GetViewport2
 892  *
 893  * Returns the currently set viewport in a D3DVIEWPORT2 structure.
 894  * Similar to IDirect3DViewport3::GetViewport
 895  *
 896  * Params:
 897  *  lpData: Pointer to the structure to fill
 898  *
 899  * Returns:
 900  *  D3D_OK on success
 901  *  DDERR_INVALIDPARAMS if the viewport was set with
 902  *                      IDirect3DViewport3::SetViewport
 903  *  DDERR_INVALIDPARAMS if Data is NULL
 904  *
 905  *****************************************************************************/
 906 static HRESULT WINAPI d3d_viewport_GetViewport2(IDirect3DViewport3 *iface, D3DVIEWPORT2 *lpData)
 907 {
 908     struct d3d_viewport *This = impl_from_IDirect3DViewport3(iface);
 909     DWORD dwSize;
 910
 911     TRACE("iface %p, data %p.\n", iface, lpData);
 912
 913     wined3d_mutex_lock();
 914     dwSize = lpData->dwSize;
 915     memset(lpData, 0, dwSize);
 916     if (This->use_vp2)
 917         memcpy(lpData, &(This->viewports.vp2), dwSize);
 918     else {
 919         D3DVIEWPORT2 vp2;
 920         vp2.dwSize = sizeof(vp2);
 921         vp2.dwX = This->viewports.vp1.dwX;
 922         vp2.dwY = This->viewports.vp1.dwY;
 923         vp2.dwWidth = This->viewports.vp1.dwWidth;
 924         vp2.dwHeight = This->viewports.vp1.dwHeight;
 925         vp2.dvClipX = 0.0;
 926         vp2.dvClipY = 0.0;
 927         vp2.dvClipWidth = 0.0;
 928         vp2.dvClipHeight = 0.0;
 929         vp2.dvMinZ = This->viewports.vp1.dvMinZ;
 930         vp2.dvMaxZ = This->viewports.vp1.dvMaxZ;
 931         memcpy(lpData, &vp2, dwSize);
 932     }
 933
 934     if (TRACE_ON(ddraw))
 935     {
 936         TRACE("  returning D3DVIEWPORT2 :\n");
 937         _dump_D3DVIEWPORT2(lpData);
 938     }
 939
 940     wined3d_mutex_unlock();
 941
 942     return D3D_OK;
 943 }
 944
 945 /*****************************************************************************
 946  * IDirect3DViewport3::SetViewport2
 947  *
 948  * Sets the viewport from a D3DVIEWPORT2 structure
 949  *
 950  * Params:
 951  *  lpData: Viewport to set
 952  *
 953  * Returns:
 954  *  D3D_OK on success
 955  *
 956  *****************************************************************************/
 957 static HRESULT WINAPI d3d_viewport_SetViewport2(IDirect3DViewport3 *iface, D3DVIEWPORT2 *lpData)
 958 {
 959     struct d3d_viewport *This = impl_from_IDirect3DViewport3(iface);
 960     IDirect3DViewport3 *current_viewport;
 961
 962     TRACE("iface %p, data %p.\n", iface, lpData);
 963
 964     if (TRACE_ON(ddraw))
 965     {
 966         TRACE("  getting D3DVIEWPORT2 :\n");
 967         _dump_D3DVIEWPORT2(lpData);
 968     }
 969
 970     wined3d_mutex_lock();
 971
 972     This->use_vp2 = 1;
 973     memset(&(This->viewports.vp2), 0, sizeof(This->viewports.vp2));
 974     memcpy(&(This->viewports.vp2), lpData, lpData->dwSize);
 975
 976     if (This->active_device) {
 977         IDirect3DDevice3 *d3d_device3 = &This->active_device->IDirect3DDevice3_iface;
 978         IDirect3DDevice3_GetCurrentViewport(d3d_device3, &current_viewport);
 979         if (current_viewport)
 980         {
 981             if (current_viewport == iface) viewport_activate(This, FALSE);
 982             IDirect3DViewport3_Release(current_viewport);
 983         }
 984     }
 985
 986     wined3d_mutex_unlock();
 987
 988     return D3D_OK;
 989 }
 990
 991 /*****************************************************************************
 992  * IDirect3DViewport3 Methods.
 993  *****************************************************************************/
 994
 995 /*****************************************************************************
 996  * IDirect3DViewport3::SetBackgroundDepth2
 997  *
 998  * Sets a IDirectDrawSurface4 surface as the background depth surface
 999  *
1000  * Params:
1001  *  lpDDS: Surface to set
1002  *
1003  * Returns:
1004  *  D3D_OK, because it's stub
1005  *
1006  *****************************************************************************/
1007 static HRESULT WINAPI d3d_viewport_SetBackgroundDepth2(IDirect3DViewport3 *iface,
1008         IDirectDrawSurface4 *surface)
1009 {
1010     FIXME("iface %p, surface %p stub!\n", iface, surface);
1011
1012     return D3D_OK;
1013 }
1014
1015 /*****************************************************************************
1016  * IDirect3DViewport3::GetBackgroundDepth2
1017  *
1018  * Returns the IDirect3DSurface4 interface to the background depth surface
1019  *
1020  * Params:
1021  *  lplpDDS: Address to store the interface pointer at
1022  *  lpValid: Set to true if a surface is assigned
1023  *
1024  * Returns:
1025  *  D3D_OK because it's a stub
1026  *
1027  *****************************************************************************/
1028 static HRESULT WINAPI d3d_viewport_GetBackgroundDepth2(IDirect3DViewport3 *iface,
1029         IDirectDrawSurface4 **surface, BOOL *valid)
1030 {
1031     FIXME("iface %p, surface %p, valid %p stub!\n", iface, surface, valid);
1032
1033     return D3D_OK;
1034 }
1035
1036 /*****************************************************************************
1037  * IDirect3DViewport3::Clear2
1038  *
1039  * Another clearing method
1040  *
1041  * Params:
1042  *  Count: Number of rectangles to clear
1043  *  Rects: Rectangle array to clear
1044  *  Flags: Some flags :)
1045  *  Color: Color to fill the render target with
1046  *  Z: Value to fill the depth buffer with
1047  *  Stencil: Value to fill the stencil bits with
1048  *
1049  * Returns:
1050  *
1051  *****************************************************************************/
1052 static HRESULT WINAPI d3d_viewport_Clear2(IDirect3DViewport3 *iface, DWORD rect_count,
1053         D3DRECT *rects, DWORD flags, DWORD color, D3DVALUE depth, DWORD stencil)
1054 {
1055     struct d3d_viewport *viewport = impl_from_IDirect3DViewport3(iface);
1056     HRESULT hr;
1057     IDirect3DViewport3 *current_viewport;
1058     IDirect3DDevice3 *d3d_device3;
1059
1060     TRACE("iface %p, rect_count %u, rects %p, flags %#x, color 0x%08x, depth %.8e, stencil %u.\n",
1061             iface, rect_count, rects, flags, color, depth, stencil);
1062
1063     wined3d_mutex_lock();
1064
1065     if (!viewport->active_device)
1066     {
1067         WARN("Trying to clear a viewport not attached to a device.\n");
1068         wined3d_mutex_unlock();
1069         return D3DERR_VIEWPORTHASNODEVICE;
1070     }
1071     d3d_device3 = &viewport->active_device->IDirect3DDevice3_iface;
1072     /* Need to temporarily activate viewport to clear it. Previously active
1073      * one will be restored afterwards. */
1074     viewport_activate(viewport, TRUE);
1075
1076     hr = IDirect3DDevice7_Clear(&viewport->active_device->IDirect3DDevice7_iface,
1077             rect_count, rects, flags, color, depth, stencil);
1078     IDirect3DDevice3_GetCurrentViewport(d3d_device3, &current_viewport);
1079     if (current_viewport)
1080     {
1081         struct d3d_viewport *vp = impl_from_IDirect3DViewport3(current_viewport);
1082         viewport_activate(vp, TRUE);
1083         IDirect3DViewport3_Release(current_viewport);
1084     }
1085
1086     wined3d_mutex_unlock();
1087
1088     return hr;
1089 }
1090
1091 /*****************************************************************************
1092  * The VTable
1093  *****************************************************************************/
1094
1095 static const struct IDirect3DViewport3Vtbl d3d_viewport_vtbl =
1096 {
1097     /*** IUnknown Methods ***/
1098     d3d_viewport_QueryInterface,
1099     d3d_viewport_AddRef,
1100     d3d_viewport_Release,
1101     /*** IDirect3DViewport Methods */
1102     d3d_viewport_Initialize,
1103     d3d_viewport_GetViewport,
1104     d3d_viewport_SetViewport,
1105     d3d_viewport_TransformVertices,
1106     d3d_viewport_LightElements,
1107     d3d_viewport_SetBackground,
1108     d3d_viewport_GetBackground,
1109     d3d_viewport_SetBackgroundDepth,
1110     d3d_viewport_GetBackgroundDepth,
1111     d3d_viewport_Clear,
1112     d3d_viewport_AddLight,
1113     d3d_viewport_DeleteLight,
1114     d3d_viewport_NextLight,
1115     /*** IDirect3DViewport2 Methods ***/
1116     d3d_viewport_GetViewport2,
1117     d3d_viewport_SetViewport2,
1118     /*** IDirect3DViewport3 Methods ***/
1119     d3d_viewport_SetBackgroundDepth2,
1120     d3d_viewport_GetBackgroundDepth2,
1121     d3d_viewport_Clear2,
1122 };
1123
1124 struct d3d_viewport *unsafe_impl_from_IDirect3DViewport3(IDirect3DViewport3 *iface)
1125 {
1126     if (!iface) return NULL;
1127     assert(iface->lpVtbl == &d3d_viewport_vtbl);
1128     return CONTAINING_RECORD(iface, struct d3d_viewport, IDirect3DViewport3_iface);
1129 }
1130
1131 struct d3d_viewport *unsafe_impl_from_IDirect3DViewport2(IDirect3DViewport2 *iface)
1132 {
1133     /* IDirect3DViewport and IDirect3DViewport3 use the same iface. */
1134     if (!iface) return NULL;
1135     assert(iface->lpVtbl == (IDirect3DViewport2Vtbl *)&d3d_viewport_vtbl);
1136     return CONTAINING_RECORD(iface, struct d3d_viewport, IDirect3DViewport3_iface);
1137 }
1138
1139 struct d3d_viewport *unsafe_impl_from_IDirect3DViewport(IDirect3DViewport *iface)
1140 {
1141     /* IDirect3DViewport and IDirect3DViewport3 use the same iface. */
1142     if (!iface) return NULL;
1143     assert(iface->lpVtbl == (IDirect3DViewportVtbl *)&d3d_viewport_vtbl);
1144     return CONTAINING_RECORD(iface, struct d3d_viewport, IDirect3DViewport3_iface);
1145 }
1146
1147 void d3d_viewport_init(struct d3d_viewport *viewport, struct ddraw *ddraw)
1148 {
1149     viewport->IDirect3DViewport3_iface.lpVtbl = &d3d_viewport_vtbl;
1150     viewport->ref = 1;
1151     viewport->ddraw = ddraw;
1152     viewport->use_vp2 = 0xff;
1153     list_init(&viewport->light_list);
1154 }