dlls/d3d9/vertexdeclaration.c

   1 /*
   2  * IDirect3DVertexDeclaration9 implementation
   3  *
   4  * Copyright 2002-2003 Raphael Junqueira
   5  *                     Jason Edmeades
   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 typedef struct _D3DDECLTYPE_INFO {
  28     D3DDECLTYPE d3dType;
  29     enum wined3d_format_id format;
  30     int         size;
  31     int         typesize;
  32 } D3DDECLTYPE_INFO;
  33
  34 static D3DDECLTYPE_INFO const d3d_dtype_lookup[D3DDECLTYPE_UNUSED] = {
  35    {D3DDECLTYPE_FLOAT1,    WINED3DFMT_R32_FLOAT,          1, sizeof(float)},
  36    {D3DDECLTYPE_FLOAT2,    WINED3DFMT_R32G32_FLOAT,       2, sizeof(float)},
  37    {D3DDECLTYPE_FLOAT3,    WINED3DFMT_R32G32B32_FLOAT,    3, sizeof(float)},
  38    {D3DDECLTYPE_FLOAT4,    WINED3DFMT_R32G32B32A32_FLOAT, 4, sizeof(float)},
  39    {D3DDECLTYPE_D3DCOLOR,  WINED3DFMT_B8G8R8A8_UNORM,     4, sizeof(BYTE)},
  40    {D3DDECLTYPE_UBYTE4,    WINED3DFMT_R8G8B8A8_UINT,      4, sizeof(BYTE)},
  41    {D3DDECLTYPE_SHORT2,    WINED3DFMT_R16G16_SINT,        2, sizeof(short int)},
  42    {D3DDECLTYPE_SHORT4,    WINED3DFMT_R16G16B16A16_SINT,  4, sizeof(short int)},
  43    {D3DDECLTYPE_UBYTE4N,   WINED3DFMT_R8G8B8A8_UNORM,     4, sizeof(BYTE)},
  44    {D3DDECLTYPE_SHORT2N,   WINED3DFMT_R16G16_SNORM,       2, sizeof(short int)},
  45    {D3DDECLTYPE_SHORT4N,   WINED3DFMT_R16G16B16A16_SNORM, 4, sizeof(short int)},
  46    {D3DDECLTYPE_USHORT2N,  WINED3DFMT_R16G16_UNORM,       2, sizeof(short int)},
  47    {D3DDECLTYPE_USHORT4N,  WINED3DFMT_R16G16B16A16_UNORM, 4, sizeof(short int)},
  48    {D3DDECLTYPE_UDEC3,     WINED3DFMT_R10G10B10A2_UINT,   3, sizeof(short int)},
  49    {D3DDECLTYPE_DEC3N,     WINED3DFMT_R10G10B10A2_SNORM,  3, sizeof(short int)},
  50    {D3DDECLTYPE_FLOAT16_2, WINED3DFMT_R16G16_FLOAT,       2, sizeof(short int)},
  51    {D3DDECLTYPE_FLOAT16_4, WINED3DFMT_R16G16B16A16_FLOAT, 4, sizeof(short int)}};
  52
  53 #define D3D_DECL_SIZE(type)          d3d_dtype_lookup[type].size
  54 #define D3D_DECL_TYPESIZE(type)      d3d_dtype_lookup[type].typesize
  55
  56 HRESULT vdecl_convert_fvf(
  57     DWORD fvf,
  58     D3DVERTEXELEMENT9** ppVertexElements) {
  59
  60     unsigned int idx, idx2;
  61     unsigned int offset;
  62     BOOL has_pos = (fvf & D3DFVF_POSITION_MASK) != 0;
  63     BOOL has_blend = (fvf & D3DFVF_XYZB5) > D3DFVF_XYZRHW;
  64     BOOL has_blend_idx = has_blend &&
  65        (((fvf & D3DFVF_XYZB5) == D3DFVF_XYZB5) ||
  66         (fvf & D3DFVF_LASTBETA_D3DCOLOR) ||
  67         (fvf & D3DFVF_LASTBETA_UBYTE4));
  68     BOOL has_normal = (fvf & D3DFVF_NORMAL) != 0;
  69     BOOL has_psize = (fvf & D3DFVF_PSIZE) != 0;
  70
  71     BOOL has_diffuse = (fvf & D3DFVF_DIFFUSE) != 0;
  72     BOOL has_specular = (fvf & D3DFVF_SPECULAR) !=0;
  73
  74     DWORD num_textures = (fvf & D3DFVF_TEXCOUNT_MASK) >> D3DFVF_TEXCOUNT_SHIFT;
  75     DWORD texcoords = (fvf & 0xFFFF0000) >> 16;
  76
  77     D3DVERTEXELEMENT9 end_element = D3DDECL_END();
  78     D3DVERTEXELEMENT9 *elements = NULL;
  79
  80     unsigned int size;
  81     DWORD num_blends = 1 + (((fvf & D3DFVF_XYZB5) - D3DFVF_XYZB1) >> 1);
  82     if (has_blend_idx) num_blends--;
  83
  84     /* Compute declaration size */
  85     size = has_pos + (has_blend && num_blends > 0) + has_blend_idx + has_normal +
  86            has_psize + has_diffuse + has_specular + num_textures + 1;
  87
  88     /* convert the declaration */
  89     elements = HeapAlloc(GetProcessHeap(), 0, size * sizeof(D3DVERTEXELEMENT9));
  90     if (!elements) return D3DERR_OUTOFVIDEOMEMORY;
  91
  92     elements[size-1] = end_element;
  93     idx = 0;
  94     if (has_pos) {
  95         if (!has_blend && (fvf & D3DFVF_XYZRHW)) {
  96             elements[idx].Type = D3DDECLTYPE_FLOAT4;
  97             elements[idx].Usage = D3DDECLUSAGE_POSITIONT;
  98         }
  99         else if (!has_blend && (fvf & D3DFVF_XYZW) == D3DFVF_XYZW) {
 100             elements[idx].Type = D3DDECLTYPE_FLOAT4;
 101             elements[idx].Usage = D3DDECLUSAGE_POSITION;
 102         }
 103         else {
 104             elements[idx].Type = D3DDECLTYPE_FLOAT3;
 105             elements[idx].Usage = D3DDECLUSAGE_POSITION;
 106         }
 107         elements[idx].UsageIndex = 0;
 108         idx++;
 109     }
 110     if (has_blend && (num_blends > 0)) {
 111         if (((fvf & D3DFVF_XYZB5) == D3DFVF_XYZB2) && (fvf & D3DFVF_LASTBETA_D3DCOLOR))
 112             elements[idx].Type = D3DDECLTYPE_D3DCOLOR;
 113         else {
 114             switch(num_blends) {
 115                 case 1: elements[idx].Type = D3DDECLTYPE_FLOAT1; break;
 116                 case 2: elements[idx].Type = D3DDECLTYPE_FLOAT2; break;
 117                 case 3: elements[idx].Type = D3DDECLTYPE_FLOAT3; break;
 118                 case 4: elements[idx].Type = D3DDECLTYPE_FLOAT4; break;
 119                 default:
 120                     ERR("Unexpected amount of blend values: %u\n", num_blends);
 121             }
 122         }
 123         elements[idx].Usage = D3DDECLUSAGE_BLENDWEIGHT;
 124         elements[idx].UsageIndex = 0;
 125         idx++;
 126     }
 127     if (has_blend_idx) {
 128         if (fvf & D3DFVF_LASTBETA_UBYTE4 ||
 129             (((fvf & D3DFVF_XYZB5) == D3DFVF_XYZB2) && (fvf & D3DFVF_LASTBETA_D3DCOLOR)))
 130             elements[idx].Type = D3DDECLTYPE_UBYTE4;
 131         else if (fvf & D3DFVF_LASTBETA_D3DCOLOR)
 132             elements[idx].Type = D3DDECLTYPE_D3DCOLOR;
 133         else
 134             elements[idx].Type = D3DDECLTYPE_FLOAT1;
 135         elements[idx].Usage = D3DDECLUSAGE_BLENDINDICES;
 136         elements[idx].UsageIndex = 0;
 137         idx++;
 138     }
 139     if (has_normal) {
 140         elements[idx].Type = D3DDECLTYPE_FLOAT3;
 141         elements[idx].Usage = D3DDECLUSAGE_NORMAL;
 142         elements[idx].UsageIndex = 0;
 143         idx++;
 144     }
 145     if (has_psize) {
 146         elements[idx].Type = D3DDECLTYPE_FLOAT1;
 147         elements[idx].Usage = D3DDECLUSAGE_PSIZE;
 148         elements[idx].UsageIndex = 0;
 149         idx++;
 150     }
 151     if (has_diffuse) {
 152         elements[idx].Type = D3DDECLTYPE_D3DCOLOR;
 153         elements[idx].Usage = D3DDECLUSAGE_COLOR;
 154         elements[idx].UsageIndex = 0;
 155         idx++;
 156     }
 157     if (has_specular) {
 158         elements[idx].Type = D3DDECLTYPE_D3DCOLOR;
 159         elements[idx].Usage = D3DDECLUSAGE_COLOR;
 160         elements[idx].UsageIndex = 1;
 161         idx++;
 162     }
 163     for (idx2 = 0; idx2 < num_textures; idx2++) {
 164         unsigned int numcoords = (texcoords >> (idx2*2)) & 0x03;
 165         switch (numcoords) {
 166             case D3DFVF_TEXTUREFORMAT1:
 167                 elements[idx].Type = D3DDECLTYPE_FLOAT1;
 168                 break;
 169             case D3DFVF_TEXTUREFORMAT2:
 170                 elements[idx].Type = D3DDECLTYPE_FLOAT2;
 171                 break;
 172             case D3DFVF_TEXTUREFORMAT3:
 173                 elements[idx].Type = D3DDECLTYPE_FLOAT3;
 174                 break;
 175             case D3DFVF_TEXTUREFORMAT4:
 176                 elements[idx].Type = D3DDECLTYPE_FLOAT4;
 177                 break;
 178         }
 179         elements[idx].Usage = D3DDECLUSAGE_TEXCOORD;
 180         elements[idx].UsageIndex = idx2;
 181         idx++;
 182     }
 183
 184     /* Now compute offsets, and initialize the rest of the fields */
 185     for (idx = 0, offset = 0; idx < size-1; idx++) {
 186         elements[idx].Stream = 0;
 187         elements[idx].Method = D3DDECLMETHOD_DEFAULT;
 188         elements[idx].Offset = offset;
 189         offset += D3D_DECL_SIZE(elements[idx].Type) * D3D_DECL_TYPESIZE(elements[idx].Type);
 190     }
 191
 192     *ppVertexElements = elements;
 193     return D3D_OK;
 194 }
 195
 196 /* IDirect3DVertexDeclaration9 IUnknown parts follow: */
 197 static HRESULT WINAPI IDirect3DVertexDeclaration9Impl_QueryInterface(LPDIRECT3DVERTEXDECLARATION9 iface, REFIID riid, LPVOID* ppobj) {
 198     IDirect3DVertexDeclaration9Impl *This = (IDirect3DVertexDeclaration9Impl *)iface;
 199
 200     TRACE("iface %p, riid %s, object %p.\n", iface, debugstr_guid(riid), ppobj);
 201
 202     if (IsEqualGUID(riid, &IID_IUnknown)
 203         || IsEqualGUID(riid, &IID_IDirect3DVertexDeclaration9)) {
 204         IDirect3DVertexDeclaration9_AddRef(iface);
 205         *ppobj = This;
 206         return S_OK;
 207     }
 208
 209     WARN("(%p)->(%s,%p),not found\n", This, debugstr_guid(riid), ppobj);
 210     *ppobj = NULL;
 211     return E_NOINTERFACE;
 212 }
 213
 214 static ULONG WINAPI IDirect3DVertexDeclaration9Impl_AddRef(LPDIRECT3DVERTEXDECLARATION9 iface) {
 215     IDirect3DVertexDeclaration9Impl *This = (IDirect3DVertexDeclaration9Impl *)iface;
 216     ULONG ref = InterlockedIncrement(&This->ref);
 217
 218     TRACE("%p increasing refcount to %u.\n", iface, ref);
 219
 220     if(ref == 1) {
 221         IDirect3DDevice9Ex_AddRef(This->parentDevice);
 222         if (!This->convFVF)
 223         {
 224             wined3d_mutex_lock();
 225             IWineD3DVertexDeclaration_AddRef(This->wineD3DVertexDeclaration);
 226             wined3d_mutex_unlock();
 227         }
 228     }
 229
 230     return ref;
 231 }
 232
 233 void IDirect3DVertexDeclaration9Impl_Destroy(LPDIRECT3DVERTEXDECLARATION9 iface) {
 234     IDirect3DVertexDeclaration9Impl *This = (IDirect3DVertexDeclaration9Impl *)iface;
 235
 236     if(This->ref != 0) {
 237         /* Should not happen unless wine has a bug or the application releases references it does not own */
 238         ERR("Destroying vdecl with ref != 0\n");
 239     }
 240
 241     wined3d_mutex_lock();
 242     IWineD3DVertexDeclaration_Release(This->wineD3DVertexDeclaration);
 243     wined3d_mutex_unlock();
 244 }
 245
 246 static ULONG WINAPI IDirect3DVertexDeclaration9Impl_Release(LPDIRECT3DVERTEXDECLARATION9 iface) {
 247     IDirect3DVertexDeclaration9Impl *This = (IDirect3DVertexDeclaration9Impl *)iface;
 248     ULONG ref = InterlockedDecrement(&This->ref);
 249
 250     TRACE("%p decreasing refcount to %u.\n", iface, ref);
 251
 252     if (ref == 0) {
 253         IDirect3DDevice9Ex *parentDevice = This->parentDevice;
 254
 255         if(!This->convFVF) {
 256             IDirect3DVertexDeclaration9Impl_Destroy(iface);
 257         }
 258
 259         /* Release the device last, as it may cause the device to be destroyed. */
 260         IDirect3DDevice9Ex_Release(parentDevice);
 261     }
 262     return ref;
 263 }
 264
 265 /* IDirect3DVertexDeclaration9 Interface follow: */
 266 static HRESULT WINAPI IDirect3DVertexDeclaration9Impl_GetDevice(IDirect3DVertexDeclaration9 *iface,
 267         IDirect3DDevice9 **device)
 268 {
 269     IDirect3DVertexDeclaration9Impl *This = (IDirect3DVertexDeclaration9Impl *)iface;
 270
 271     TRACE("iface %p, device %p.\n", iface, device);
 272
 273     *device = (IDirect3DDevice9 *)This->parentDevice;
 274     IDirect3DDevice9_AddRef(*device);
 275
 276     TRACE("Returning device %p.\n", *device);
 277
 278     return D3D_OK;
 279 }
 280
 281 static HRESULT WINAPI IDirect3DVertexDeclaration9Impl_GetDeclaration(LPDIRECT3DVERTEXDECLARATION9 iface, D3DVERTEXELEMENT9* pDecl, UINT* pNumElements) {
 282     IDirect3DVertexDeclaration9Impl *This = (IDirect3DVertexDeclaration9Impl *)iface;
 283
 284     TRACE("iface %p, elements %p, element_count %p.\n", iface, pDecl, pNumElements);
 285
 286     *pNumElements = This->element_count;
 287
 288     /* Passing a NULL pDecl is used to just retrieve the number of elements */
 289     if (!pDecl) {
 290         TRACE("NULL pDecl passed. Returning D3D_OK.\n");
 291         return D3D_OK;
 292     }
 293
 294     TRACE("Copying %p to %p\n", This->elements, pDecl);
 295     CopyMemory(pDecl, This->elements, This->element_count * sizeof(D3DVERTEXELEMENT9));
 296
 297     return D3D_OK;
 298 }
 299
 300 static const IDirect3DVertexDeclaration9Vtbl Direct3DVertexDeclaration9_Vtbl =
 301 {
 302     /* IUnknown */
 303     IDirect3DVertexDeclaration9Impl_QueryInterface,
 304     IDirect3DVertexDeclaration9Impl_AddRef,
 305     IDirect3DVertexDeclaration9Impl_Release,
 306     /* IDirect3DVertexDeclaration9 */
 307     IDirect3DVertexDeclaration9Impl_GetDevice,
 308     IDirect3DVertexDeclaration9Impl_GetDeclaration
 309 };
 310
 311 static void STDMETHODCALLTYPE d3d9_vertexdeclaration_wined3d_object_destroyed(void *parent)
 312 {
 313     IDirect3DVertexDeclaration9Impl *declaration = parent;
 314     HeapFree(GetProcessHeap(), 0, declaration->elements);
 315     HeapFree(GetProcessHeap(), 0, declaration);
 316 }
 317
 318 static const struct wined3d_parent_ops d3d9_vertexdeclaration_wined3d_parent_ops =
 319 {
 320     d3d9_vertexdeclaration_wined3d_object_destroyed,
 321 };
 322
 323 static HRESULT convert_to_wined3d_declaration(const D3DVERTEXELEMENT9* d3d9_elements,
 324         WINED3DVERTEXELEMENT **wined3d_elements, UINT *element_count)
 325 {
 326     const D3DVERTEXELEMENT9* element;
 327     UINT count = 1;
 328     UINT i;
 329
 330     TRACE("d3d9_elements %p, wined3d_elements %p\n", d3d9_elements, wined3d_elements);
 331
 332     element = d3d9_elements;
 333     while (element++->Stream != 0xff && count++ < 128);
 334
 335     if (count == 128) return E_FAIL;
 336
 337     /* Skip the END element */
 338     --count;
 339
 340     *wined3d_elements = HeapAlloc(GetProcessHeap(), 0, count * sizeof(WINED3DVERTEXELEMENT));
 341     if (!*wined3d_elements) {
 342         FIXME("Memory allocation failed\n");
 343         return D3DERR_OUTOFVIDEOMEMORY;
 344     }
 345
 346     for (i = 0; i < count; ++i)
 347     {
 348         if (d3d9_elements[i].Type >= (sizeof(d3d_dtype_lookup) / sizeof(*d3d_dtype_lookup)))
 349         {
 350             WARN("Invalid element type %#x.\n", d3d9_elements[i].Type);
 351             HeapFree(GetProcessHeap(), 0, *wined3d_elements);
 352             return E_FAIL;
 353         }
 354         (*wined3d_elements)[i].format = d3d_dtype_lookup[d3d9_elements[i].Type].format;
 355         (*wined3d_elements)[i].input_slot = d3d9_elements[i].Stream;
 356         (*wined3d_elements)[i].offset = d3d9_elements[i].Offset;
 357         (*wined3d_elements)[i].output_slot = ~0U;
 358         (*wined3d_elements)[i].method = d3d9_elements[i].Method;
 359         (*wined3d_elements)[i].usage = d3d9_elements[i].Usage;
 360         (*wined3d_elements)[i].usage_idx = d3d9_elements[i].UsageIndex;
 361     }
 362
 363     *element_count = count;
 364
 365     return D3D_OK;
 366 }
 367
 368 HRESULT vertexdeclaration_init(IDirect3DVertexDeclaration9Impl *declaration,
 369         IDirect3DDevice9Impl *device, const D3DVERTEXELEMENT9 *elements)
 370 {
 371     WINED3DVERTEXELEMENT *wined3d_elements;
 372     UINT wined3d_element_count;
 373     UINT element_count;
 374     HRESULT hr;
 375
 376     hr = convert_to_wined3d_declaration(elements, &wined3d_elements, &wined3d_element_count);
 377     if (FAILED(hr))
 378     {
 379         WARN("Failed to create wined3d vertex declaration elements, hr %#x.\n", hr);
 380         return hr;
 381     }
 382
 383     declaration->lpVtbl = &Direct3DVertexDeclaration9_Vtbl;
 384     declaration->ref = 1;
 385
 386     element_count = wined3d_element_count + 1;
 387     declaration->elements = HeapAlloc(GetProcessHeap(), 0, element_count * sizeof(*declaration->elements));
 388     if (!declaration->elements)
 389     {
 390         HeapFree(GetProcessHeap(), 0, wined3d_elements);
 391         ERR("Failed to allocate vertex declaration elements memory.\n");
 392         return D3DERR_OUTOFVIDEOMEMORY;
 393     }
 394     memcpy(declaration->elements, elements, element_count * sizeof(*elements));
 395     declaration->element_count = element_count;
 396
 397     wined3d_mutex_lock();
 398     hr = IWineD3DDevice_CreateVertexDeclaration(device->WineD3DDevice, wined3d_elements, wined3d_element_count,
 399             declaration, &d3d9_vertexdeclaration_wined3d_parent_ops, &declaration->wineD3DVertexDeclaration);
 400     wined3d_mutex_unlock();
 401     HeapFree(GetProcessHeap(), 0, wined3d_elements);
 402     if (FAILED(hr))
 403     {
 404         HeapFree(GetProcessHeap(), 0, declaration->elements);
 405         WARN("Failed to create wined3d vertex declaration, hr %#x.\n", hr);
 406         return hr;
 407     }
 408
 409     declaration->parentDevice = (IDirect3DDevice9Ex *)device;
 410     IDirect3DDevice9Ex_AddRef(declaration->parentDevice);
 411
 412     return D3D_OK;
 413 }