2 * vertex declaration implementation
4 * Copyright 2002-2005 Raphael Junqueira
5 * Copyright 2004 Jason Edmeades
6 * Copyright 2004 Christian Costa
7 * Copyright 2005 Oliver Stieber
8 * Copyright 2009 Henri Verbeet for CodeWeavers
10 * This library is free software; you can redistribute it and/or
11 * modify it under the terms of the GNU Lesser General Public
12 * License as published by the Free Software Foundation; either
13 * version 2.1 of the License, or (at your option) any later version.
15 * This library is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 * Lesser General Public License for more details.
20 * You should have received a copy of the GNU Lesser General Public
21 * License along with this library; if not, write to the Free Software
22 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
26 #include "wine/port.h"
27 #include "wined3d_private.h"
29 WINE_DEFAULT_DEBUG_CHANNEL(d3d_decl);
31 static void dump_wined3d_vertex_element(const struct wined3d_vertex_element *element)
33 TRACE(" format: %s (%#x)\n", debug_d3dformat(element->format), element->format);
34 TRACE(" input_slot: %u\n", element->input_slot);
35 TRACE(" offset: %u\n", element->offset);
36 TRACE("output_slot: %u\n", element->output_slot);
37 TRACE(" method: %s (%#x)\n", debug_d3ddeclmethod(element->method), element->method);
38 TRACE(" usage: %s (%#x)\n", debug_d3ddeclusage(element->usage), element->usage);
39 TRACE(" usage_idx: %u\n", element->usage_idx);
42 ULONG CDECL wined3d_vertex_declaration_incref(struct wined3d_vertex_declaration *declaration)
44 ULONG refcount = InterlockedIncrement(&declaration->ref);
46 TRACE("%p increasing refcount to %u.\n", declaration, refcount);
51 ULONG CDECL wined3d_vertex_declaration_decref(struct wined3d_vertex_declaration *declaration)
53 ULONG refcount = InterlockedDecrement(&declaration->ref);
55 TRACE("%p decreasing refcount to %u.\n", declaration, refcount);
59 HeapFree(GetProcessHeap(), 0, declaration->elements);
60 declaration->parent_ops->wined3d_object_destroyed(declaration->parent);
61 HeapFree(GetProcessHeap(), 0, declaration);
67 void * CDECL wined3d_vertex_declaration_get_parent(const struct wined3d_vertex_declaration *declaration)
69 TRACE("declaration %p.\n", declaration);
71 return declaration->parent;
74 static BOOL declaration_element_valid_ffp(const struct wined3d_vertex_element *element)
76 switch(element->usage)
78 case WINED3D_DECL_USAGE_POSITION:
79 case WINED3D_DECL_USAGE_POSITIONT:
80 switch(element->format)
82 case WINED3DFMT_R32G32_FLOAT:
83 case WINED3DFMT_R32G32B32_FLOAT:
84 case WINED3DFMT_R32G32B32A32_FLOAT:
85 case WINED3DFMT_R16G16_SINT:
86 case WINED3DFMT_R16G16B16A16_SINT:
87 case WINED3DFMT_R16G16_FLOAT:
88 case WINED3DFMT_R16G16B16A16_FLOAT:
94 case WINED3D_DECL_USAGE_BLEND_WEIGHT:
95 switch(element->format)
97 case WINED3DFMT_R32_FLOAT:
98 case WINED3DFMT_R32G32_FLOAT:
99 case WINED3DFMT_R32G32B32_FLOAT:
100 case WINED3DFMT_R32G32B32A32_FLOAT:
101 case WINED3DFMT_B8G8R8A8_UNORM:
102 case WINED3DFMT_R8G8B8A8_UINT:
103 case WINED3DFMT_R16G16_SINT:
104 case WINED3DFMT_R16G16B16A16_SINT:
105 case WINED3DFMT_R16G16_FLOAT:
106 case WINED3DFMT_R16G16B16A16_FLOAT:
112 case WINED3D_DECL_USAGE_NORMAL:
113 switch(element->format)
115 case WINED3DFMT_R32G32B32_FLOAT:
116 case WINED3DFMT_R32G32B32A32_FLOAT:
117 case WINED3DFMT_R16G16B16A16_SINT:
118 case WINED3DFMT_R16G16B16A16_FLOAT:
124 case WINED3D_DECL_USAGE_TEXCOORD:
125 switch(element->format)
127 case WINED3DFMT_R32_FLOAT:
128 case WINED3DFMT_R32G32_FLOAT:
129 case WINED3DFMT_R32G32B32_FLOAT:
130 case WINED3DFMT_R32G32B32A32_FLOAT:
131 case WINED3DFMT_R16G16_SINT:
132 case WINED3DFMT_R16G16B16A16_SINT:
133 case WINED3DFMT_R16G16_FLOAT:
134 case WINED3DFMT_R16G16B16A16_FLOAT:
140 case WINED3D_DECL_USAGE_COLOR:
141 switch(element->format)
143 case WINED3DFMT_R32G32B32_FLOAT:
144 case WINED3DFMT_R32G32B32A32_FLOAT:
145 case WINED3DFMT_B8G8R8A8_UNORM:
146 case WINED3DFMT_R8G8B8A8_UINT:
147 case WINED3DFMT_R16G16B16A16_SINT:
148 case WINED3DFMT_R8G8B8A8_UNORM:
149 case WINED3DFMT_R16G16B16A16_SNORM:
150 case WINED3DFMT_R16G16B16A16_UNORM:
151 case WINED3DFMT_R16G16B16A16_FLOAT:
162 static HRESULT vertexdeclaration_init(struct wined3d_vertex_declaration *declaration,
163 struct wined3d_device *device, const struct wined3d_vertex_element *elements, UINT element_count,
164 void *parent, const struct wined3d_parent_ops *parent_ops)
166 const struct wined3d_gl_info *gl_info = &device->adapter->gl_info;
167 WORD preloaded = 0; /* MAX_STREAMS, 16 */
170 if (TRACE_ON(d3d_decl))
172 for (i = 0; i < element_count; ++i)
174 dump_wined3d_vertex_element(elements + i);
178 declaration->ref = 1;
179 declaration->parent = parent;
180 declaration->parent_ops = parent_ops;
181 declaration->device = device;
182 declaration->elements = HeapAlloc(GetProcessHeap(), 0, sizeof(*declaration->elements) * element_count);
183 if (!declaration->elements)
185 ERR("Failed to allocate elements memory.\n");
186 return E_OUTOFMEMORY;
188 declaration->element_count = element_count;
190 /* Do some static analysis on the elements to make reading the
191 * declaration more comfortable for the drawing code. */
192 for (i = 0; i < element_count; ++i)
194 struct wined3d_vertex_declaration_element *e = &declaration->elements[i];
196 e->format = wined3d_get_format(gl_info, elements[i].format);
197 e->ffp_valid = declaration_element_valid_ffp(&elements[i]);
198 e->input_slot = elements[i].input_slot;
199 e->offset = elements[i].offset;
200 e->output_slot = elements[i].output_slot;
201 e->method = elements[i].method;
202 e->usage = elements[i].usage;
203 e->usage_idx = elements[i].usage_idx;
205 if (e->usage == WINED3D_DECL_USAGE_POSITIONT)
206 declaration->position_transformed = TRUE;
208 /* Find the streams used in the declaration. The vertex buffers have
209 * to be loaded when drawing, but filter tesselation pseudo streams. */
210 if (e->input_slot >= MAX_STREAMS) continue;
212 if (!e->format->gl_vtx_format)
214 FIXME("The application tries to use an unsupported format (%s), returning E_FAIL.\n",
215 debug_d3dformat(elements[i].format));
216 HeapFree(GetProcessHeap(), 0, declaration->elements);
222 WARN("Declaration element %u is not 4 byte aligned(%u), returning E_FAIL.\n", i, e->offset);
223 HeapFree(GetProcessHeap(), 0, declaration->elements);
227 if (!(preloaded & (1 << e->input_slot)))
229 declaration->streams[declaration->num_streams] = e->input_slot;
230 ++declaration->num_streams;
231 preloaded |= 1 << e->input_slot;
234 if (elements[i].format == WINED3DFMT_R16G16_FLOAT || elements[i].format == WINED3DFMT_R16G16B16A16_FLOAT)
236 if (!gl_info->supported[ARB_HALF_FLOAT_VERTEX]) declaration->half_float_conv_needed = TRUE;
243 HRESULT CDECL wined3d_vertex_declaration_create(struct wined3d_device *device,
244 const struct wined3d_vertex_element *elements, UINT element_count, void *parent,
245 const struct wined3d_parent_ops *parent_ops, struct wined3d_vertex_declaration **declaration)
247 struct wined3d_vertex_declaration *object;
250 TRACE("device %p, elements %p, element_count %u, parent %p, parent_ops %p, declaration %p.\n",
251 device, elements, element_count, parent, parent_ops, declaration);
253 object = HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY, sizeof(*object));
256 ERR("Failed to allocate vertex declaration memory.\n");
257 return E_OUTOFMEMORY;
260 hr = vertexdeclaration_init(object, device, elements, element_count, parent, parent_ops);
263 WARN("Failed to initialize vertex declaration, hr %#x.\n", hr);
264 HeapFree(GetProcessHeap(), 0, object);
268 TRACE("Created vertex declaration %p.\n", object);
269 *declaration = object;
274 struct wined3d_fvf_convert_state
276 const struct wined3d_gl_info *gl_info;
277 struct wined3d_vertex_element *elements;
282 static void append_decl_element(struct wined3d_fvf_convert_state *state,
283 enum wined3d_format_id format_id, enum wined3d_decl_usage usage, UINT usage_idx)
285 struct wined3d_vertex_element *elements = state->elements;
286 const struct wined3d_format *format;
287 UINT offset = state->offset;
288 UINT idx = state->idx;
290 elements[idx].format = format_id;
291 elements[idx].input_slot = 0;
292 elements[idx].offset = offset;
293 elements[idx].output_slot = 0;
294 elements[idx].method = WINED3D_DECL_METHOD_DEFAULT;
295 elements[idx].usage = usage;
296 elements[idx].usage_idx = usage_idx;
298 format = wined3d_get_format(state->gl_info, format_id);
299 state->offset += format->component_count * format->component_size;
303 static unsigned int convert_fvf_to_declaration(const struct wined3d_gl_info *gl_info,
304 DWORD fvf, struct wined3d_vertex_element **elements)
306 BOOL has_pos = !!(fvf & WINED3DFVF_POSITION_MASK);
307 BOOL has_blend = (fvf & WINED3DFVF_XYZB5) > WINED3DFVF_XYZRHW;
308 BOOL has_blend_idx = has_blend &&
309 (((fvf & WINED3DFVF_XYZB5) == WINED3DFVF_XYZB5) ||
310 (fvf & WINED3DFVF_LASTBETA_D3DCOLOR) ||
311 (fvf & WINED3DFVF_LASTBETA_UBYTE4));
312 BOOL has_normal = !!(fvf & WINED3DFVF_NORMAL);
313 BOOL has_psize = !!(fvf & WINED3DFVF_PSIZE);
314 BOOL has_diffuse = !!(fvf & WINED3DFVF_DIFFUSE);
315 BOOL has_specular = !!(fvf & WINED3DFVF_SPECULAR);
317 DWORD num_textures = (fvf & WINED3DFVF_TEXCOUNT_MASK) >> WINED3DFVF_TEXCOUNT_SHIFT;
318 DWORD texcoords = (fvf & 0xffff0000) >> 16;
319 struct wined3d_fvf_convert_state state;
322 DWORD num_blends = 1 + (((fvf & WINED3DFVF_XYZB5) - WINED3DFVF_XYZB1) >> 1);
323 if (has_blend_idx) num_blends--;
325 /* Compute declaration size */
326 size = has_pos + (has_blend && num_blends > 0) + has_blend_idx + has_normal +
327 has_psize + has_diffuse + has_specular + num_textures;
329 state.gl_info = gl_info;
330 state.elements = HeapAlloc(GetProcessHeap(), 0, size * sizeof(*state.elements));
331 if (!state.elements) return ~0U;
337 if (!has_blend && (fvf & WINED3DFVF_XYZRHW))
338 append_decl_element(&state, WINED3DFMT_R32G32B32A32_FLOAT, WINED3D_DECL_USAGE_POSITIONT, 0);
339 else if ((fvf & WINED3DFVF_XYZW) == WINED3DFVF_XYZW)
340 append_decl_element(&state, WINED3DFMT_R32G32B32A32_FLOAT, WINED3D_DECL_USAGE_POSITION, 0);
342 append_decl_element(&state, WINED3DFMT_R32G32B32_FLOAT, WINED3D_DECL_USAGE_POSITION, 0);
345 if (has_blend && (num_blends > 0))
347 if ((fvf & WINED3DFVF_XYZB5) == WINED3DFVF_XYZB2 && (fvf & WINED3DFVF_LASTBETA_D3DCOLOR))
348 append_decl_element(&state, WINED3DFMT_B8G8R8A8_UNORM, WINED3D_DECL_USAGE_BLEND_WEIGHT, 0);
354 append_decl_element(&state, WINED3DFMT_R32_FLOAT, WINED3D_DECL_USAGE_BLEND_WEIGHT, 0);
357 append_decl_element(&state, WINED3DFMT_R32G32_FLOAT, WINED3D_DECL_USAGE_BLEND_WEIGHT, 0);
360 append_decl_element(&state, WINED3DFMT_R32G32B32_FLOAT, WINED3D_DECL_USAGE_BLEND_WEIGHT, 0);
363 append_decl_element(&state, WINED3DFMT_R32G32B32A32_FLOAT, WINED3D_DECL_USAGE_BLEND_WEIGHT, 0);
366 ERR("Unexpected amount of blend values: %u\n", num_blends);
373 if ((fvf & WINED3DFVF_LASTBETA_UBYTE4)
374 || ((fvf & WINED3DFVF_XYZB5) == WINED3DFVF_XYZB2 && (fvf & WINED3DFVF_LASTBETA_D3DCOLOR)))
375 append_decl_element(&state, WINED3DFMT_R8G8B8A8_UINT, WINED3D_DECL_USAGE_BLEND_INDICES, 0);
376 else if (fvf & WINED3DFVF_LASTBETA_D3DCOLOR)
377 append_decl_element(&state, WINED3DFMT_B8G8R8A8_UNORM, WINED3D_DECL_USAGE_BLEND_INDICES, 0);
379 append_decl_element(&state, WINED3DFMT_R32_FLOAT, WINED3D_DECL_USAGE_BLEND_INDICES, 0);
383 append_decl_element(&state, WINED3DFMT_R32G32B32_FLOAT, WINED3D_DECL_USAGE_NORMAL, 0);
385 append_decl_element(&state, WINED3DFMT_R32_FLOAT, WINED3D_DECL_USAGE_PSIZE, 0);
387 append_decl_element(&state, WINED3DFMT_B8G8R8A8_UNORM, WINED3D_DECL_USAGE_COLOR, 0);
389 append_decl_element(&state, WINED3DFMT_B8G8R8A8_UNORM, WINED3D_DECL_USAGE_COLOR, 1);
391 for (idx = 0; idx < num_textures; ++idx)
393 switch ((texcoords >> (idx * 2)) & 0x03)
395 case WINED3DFVF_TEXTUREFORMAT1:
396 append_decl_element(&state, WINED3DFMT_R32_FLOAT, WINED3D_DECL_USAGE_TEXCOORD, idx);
398 case WINED3DFVF_TEXTUREFORMAT2:
399 append_decl_element(&state, WINED3DFMT_R32G32_FLOAT, WINED3D_DECL_USAGE_TEXCOORD, idx);
401 case WINED3DFVF_TEXTUREFORMAT3:
402 append_decl_element(&state, WINED3DFMT_R32G32B32_FLOAT, WINED3D_DECL_USAGE_TEXCOORD, idx);
404 case WINED3DFVF_TEXTUREFORMAT4:
405 append_decl_element(&state, WINED3DFMT_R32G32B32A32_FLOAT, WINED3D_DECL_USAGE_TEXCOORD, idx);
410 *elements = state.elements;
414 HRESULT CDECL wined3d_vertex_declaration_create_from_fvf(struct wined3d_device *device,
415 DWORD fvf, void *parent, const struct wined3d_parent_ops *parent_ops,
416 struct wined3d_vertex_declaration **declaration)
418 struct wined3d_vertex_element *elements;
422 TRACE("device %p, fvf %#x, parent %p, parent_ops %p, declaration %p.\n",
423 device, fvf, parent, parent_ops, declaration);
425 size = convert_fvf_to_declaration(&device->adapter->gl_info, fvf, &elements);
426 if (size == ~0U) return E_OUTOFMEMORY;
428 hr = wined3d_vertex_declaration_create(device, elements, size, parent, parent_ops, declaration);
429 HeapFree(GetProcessHeap(), 0, elements);