vbo: replace the comment on vbo_copy_vertices()
[mesa.git] / src / mesa / vbo / vbo_exec_draw.c
1 /*
2 * Mesa 3-D graphics library
3 *
4 * Copyright (C) 1999-2008 Brian Paul All Rights Reserved.
5 *
6 * Permission is hereby granted, free of charge, to any person obtaining a
7 * copy of this software and associated documentation files (the "Software"),
8 * to deal in the Software without restriction, including without limitation
9 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
10 * and/or sell copies of the Software, and to permit persons to whom the
11 * Software is furnished to do so, subject to the following conditions:
12 *
13 * The above copyright notice and this permission notice shall be included
14 * in all copies or substantial portions of the Software.
15 *
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
17 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
19 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
20 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
21 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
22 * OTHER DEALINGS IN THE SOFTWARE.
23 *
24 * Authors:
25 * Keith Whitwell <keithw@vmware.com>
26 */
27
28 #include <stdio.h>
29 #include "main/glheader.h"
30 #include "main/bufferobj.h"
31 #include "main/compiler.h"
32 #include "main/context.h"
33 #include "main/enums.h"
34 #include "main/state.h"
35 #include "main/vtxfmt.h"
36
37 #include "vbo_context.h"
38 #include "vbo_noop.h"
39
40
41 static void
42 vbo_exec_debug_verts( struct vbo_exec_context *exec )
43 {
44 GLuint count = exec->vtx.vert_count;
45 GLuint i;
46
47 printf("%s: %u vertices %d primitives, %d vertsize\n",
48 __func__,
49 count,
50 exec->vtx.prim_count,
51 exec->vtx.vertex_size);
52
53 for (i = 0 ; i < exec->vtx.prim_count ; i++) {
54 struct _mesa_prim *prim = &exec->vtx.prim[i];
55 printf(" prim %d: %s%s %d..%d %s %s\n",
56 i,
57 _mesa_lookup_prim_by_nr(prim->mode),
58 prim->weak ? " (weak)" : "",
59 prim->start,
60 prim->start + prim->count,
61 prim->begin ? "BEGIN" : "(wrap)",
62 prim->end ? "END" : "(wrap)");
63 }
64 }
65
66
67 /**
68 * Copy zero, one or two vertices from the current vertex buffer into
69 * the temporary "copy" buffer.
70 * This is used when a single primitive overflows a vertex buffer and
71 * we need to continue the primitive in a new vertex buffer.
72 * The temporary "copy" buffer holds the vertices which need to get
73 * copied from the old buffer to the new one.
74 */
75 static GLuint
76 vbo_copy_vertices( struct vbo_exec_context *exec )
77 {
78 GLuint nr = exec->vtx.prim[exec->vtx.prim_count-1].count;
79 GLuint ovf, i;
80 GLuint sz = exec->vtx.vertex_size;
81 fi_type *dst = exec->vtx.copied.buffer;
82 const fi_type *src = (exec->vtx.buffer_map +
83 exec->vtx.prim[exec->vtx.prim_count-1].start *
84 exec->vtx.vertex_size);
85
86 switch (exec->ctx->Driver.CurrentExecPrimitive) {
87 case GL_POINTS:
88 return 0;
89 case GL_LINES:
90 ovf = nr&1;
91 for (i = 0 ; i < ovf ; i++)
92 memcpy( dst+i*sz, src+(nr-ovf+i)*sz, sz * sizeof(GLfloat) );
93 return i;
94 case GL_TRIANGLES:
95 ovf = nr%3;
96 for (i = 0 ; i < ovf ; i++)
97 memcpy( dst+i*sz, src+(nr-ovf+i)*sz, sz * sizeof(GLfloat) );
98 return i;
99 case GL_QUADS:
100 ovf = nr&3;
101 for (i = 0 ; i < ovf ; i++)
102 memcpy( dst+i*sz, src+(nr-ovf+i)*sz, sz * sizeof(GLfloat) );
103 return i;
104 case GL_LINE_STRIP:
105 if (nr == 0) {
106 return 0;
107 }
108 else {
109 memcpy( dst, src+(nr-1)*sz, sz * sizeof(GLfloat) );
110 return 1;
111 }
112 case GL_LINE_LOOP:
113 case GL_TRIANGLE_FAN:
114 case GL_POLYGON:
115 if (nr == 0) {
116 return 0;
117 }
118 else if (nr == 1) {
119 memcpy( dst, src+0, sz * sizeof(GLfloat) );
120 return 1;
121 }
122 else {
123 memcpy( dst, src+0, sz * sizeof(GLfloat) );
124 memcpy( dst+sz, src+(nr-1)*sz, sz * sizeof(GLfloat) );
125 return 2;
126 }
127 case GL_TRIANGLE_STRIP:
128 /* no parity issue, but need to make sure the tri is not drawn twice */
129 if (nr & 1) {
130 exec->vtx.prim[exec->vtx.prim_count-1].count--;
131 }
132 /* fallthrough */
133 case GL_QUAD_STRIP:
134 switch (nr) {
135 case 0:
136 ovf = 0;
137 break;
138 case 1:
139 ovf = 1;
140 break;
141 default:
142 ovf = 2 + (nr & 1);
143 break;
144 }
145 for (i = 0 ; i < ovf ; i++)
146 memcpy( dst+i*sz, src+(nr-ovf+i)*sz, sz * sizeof(GLfloat) );
147 return i;
148 case PRIM_OUTSIDE_BEGIN_END:
149 return 0;
150 default:
151 assert(0);
152 return 0;
153 }
154 }
155
156
157
158 /* TODO: populate these as the vertex is defined:
159 */
160 static void
161 vbo_exec_bind_arrays( struct gl_context *ctx )
162 {
163 struct vbo_context *vbo = vbo_context(ctx);
164 struct vbo_exec_context *exec = &vbo->exec;
165 struct gl_client_array *arrays = exec->vtx.arrays;
166 const GLuint *map;
167 GLuint attr;
168 GLbitfield64 varying_inputs = 0x0;
169
170 /* Install the default (ie Current) attributes first, then overlay
171 * all active ones.
172 */
173 switch (get_program_mode(exec->ctx)) {
174 case VP_NONE:
175 for (attr = 0; attr < VERT_ATTRIB_FF_MAX; attr++) {
176 exec->vtx.inputs[attr] = &vbo->currval[VBO_ATTRIB_POS+attr];
177 }
178 for (attr = 0; attr < MAT_ATTRIB_MAX; attr++) {
179 assert(VERT_ATTRIB_GENERIC(attr) < ARRAY_SIZE(exec->vtx.inputs));
180 exec->vtx.inputs[VERT_ATTRIB_GENERIC(attr)] =
181 &vbo->currval[VBO_ATTRIB_MAT_FRONT_AMBIENT+attr];
182 }
183 map = vbo->map_vp_none;
184 break;
185 case VP_ARB:
186 for (attr = 0; attr < VERT_ATTRIB_FF_MAX; attr++) {
187 exec->vtx.inputs[attr] = &vbo->currval[VBO_ATTRIB_POS+attr];
188 }
189 for (attr = 0; attr < VERT_ATTRIB_GENERIC_MAX; attr++) {
190 assert(VERT_ATTRIB_GENERIC(attr) < ARRAY_SIZE(exec->vtx.inputs));
191 exec->vtx.inputs[VERT_ATTRIB_GENERIC(attr)] =
192 &vbo->currval[VBO_ATTRIB_GENERIC0+attr];
193 }
194 map = vbo->map_vp_arb;
195
196 /* check if VERT_ATTRIB_POS is not read but VERT_BIT_GENERIC0 is read.
197 * In that case we effectively need to route the data from
198 * glVertexAttrib(0, val) calls to feed into the GENERIC0 input.
199 */
200 if ((ctx->VertexProgram._Current->Base.InputsRead & VERT_BIT_POS) == 0 &&
201 (ctx->VertexProgram._Current->Base.InputsRead & VERT_BIT_GENERIC0)) {
202 exec->vtx.inputs[VERT_ATTRIB_GENERIC0] = exec->vtx.inputs[0];
203 exec->vtx.attrsz[VERT_ATTRIB_GENERIC0] = exec->vtx.attrsz[0];
204 exec->vtx.attrptr[VERT_ATTRIB_GENERIC0] = exec->vtx.attrptr[0];
205 exec->vtx.attrsz[0] = 0;
206 }
207 break;
208 default:
209 assert(0);
210 }
211
212 for (attr = 0; attr < VERT_ATTRIB_MAX ; attr++) {
213 const GLuint src = map[attr];
214
215 if (exec->vtx.attrsz[src]) {
216 GLsizeiptr offset = (GLbyte *)exec->vtx.attrptr[src] -
217 (GLbyte *)exec->vtx.vertex;
218
219 /* override the default array set above */
220 assert(attr < ARRAY_SIZE(exec->vtx.inputs));
221 assert(attr < ARRAY_SIZE(exec->vtx.arrays)); /* arrays[] */
222 exec->vtx.inputs[attr] = &arrays[attr];
223
224 if (_mesa_is_bufferobj(exec->vtx.bufferobj)) {
225 /* a real buffer obj: Ptr is an offset, not a pointer */
226 assert(exec->vtx.bufferobj->Mappings[MAP_INTERNAL].Pointer);
227 assert(offset >= 0);
228 arrays[attr].Ptr = (GLubyte *)
229 exec->vtx.bufferobj->Mappings[MAP_INTERNAL].Offset + offset;
230 }
231 else {
232 /* Ptr into ordinary app memory */
233 arrays[attr].Ptr = (GLubyte *)exec->vtx.buffer_map + offset;
234 }
235 arrays[attr].Size = exec->vtx.attrsz[src];
236 arrays[attr].StrideB = exec->vtx.vertex_size * sizeof(GLfloat);
237 arrays[attr].Stride = exec->vtx.vertex_size * sizeof(GLfloat);
238 arrays[attr].Type = exec->vtx.attrtype[src];
239 arrays[attr].Integer =
240 vbo_attrtype_to_integer_flag(exec->vtx.attrtype[src]);
241 arrays[attr].Format = GL_RGBA;
242 arrays[attr].Enabled = 1;
243 arrays[attr]._ElementSize = arrays[attr].Size * sizeof(GLfloat);
244 _mesa_reference_buffer_object(ctx,
245 &arrays[attr].BufferObj,
246 exec->vtx.bufferobj);
247
248 varying_inputs |= VERT_BIT(attr);
249 }
250 }
251
252 _mesa_set_varying_vp_inputs( ctx, varying_inputs );
253 ctx->NewDriverState |= ctx->DriverFlags.NewArray;
254 }
255
256
257 /**
258 * Unmap the VBO. This is called before drawing.
259 */
260 static void
261 vbo_exec_vtx_unmap( struct vbo_exec_context *exec )
262 {
263 if (_mesa_is_bufferobj(exec->vtx.bufferobj)) {
264 struct gl_context *ctx = exec->ctx;
265
266 if (ctx->Driver.FlushMappedBufferRange) {
267 GLintptr offset = exec->vtx.buffer_used -
268 exec->vtx.bufferobj->Mappings[MAP_INTERNAL].Offset;
269 GLsizeiptr length = (exec->vtx.buffer_ptr - exec->vtx.buffer_map) *
270 sizeof(float);
271
272 if (length)
273 ctx->Driver.FlushMappedBufferRange(ctx, offset, length,
274 exec->vtx.bufferobj,
275 MAP_INTERNAL);
276 }
277
278 exec->vtx.buffer_used += (exec->vtx.buffer_ptr -
279 exec->vtx.buffer_map) * sizeof(float);
280
281 assert(exec->vtx.buffer_used <= VBO_VERT_BUFFER_SIZE);
282 assert(exec->vtx.buffer_ptr != NULL);
283
284 ctx->Driver.UnmapBuffer(ctx, exec->vtx.bufferobj, MAP_INTERNAL);
285 exec->vtx.buffer_map = NULL;
286 exec->vtx.buffer_ptr = NULL;
287 exec->vtx.max_vert = 0;
288 }
289 }
290
291
292 /**
293 * Map the vertex buffer to begin storing glVertex, glColor, etc data.
294 */
295 void
296 vbo_exec_vtx_map( struct vbo_exec_context *exec )
297 {
298 struct gl_context *ctx = exec->ctx;
299 const GLenum accessRange = GL_MAP_WRITE_BIT | /* for MapBufferRange */
300 GL_MAP_INVALIDATE_RANGE_BIT |
301 GL_MAP_UNSYNCHRONIZED_BIT |
302 GL_MAP_FLUSH_EXPLICIT_BIT |
303 MESA_MAP_NOWAIT_BIT;
304 const GLenum usage = GL_STREAM_DRAW_ARB;
305
306 if (!_mesa_is_bufferobj(exec->vtx.bufferobj))
307 return;
308
309 assert(!exec->vtx.buffer_map);
310 assert(!exec->vtx.buffer_ptr);
311
312 if (VBO_VERT_BUFFER_SIZE > exec->vtx.buffer_used + 1024) {
313 /* The VBO exists and there's room for more */
314 if (exec->vtx.bufferobj->Size > 0) {
315 exec->vtx.buffer_map =
316 (fi_type *)ctx->Driver.MapBufferRange(ctx,
317 exec->vtx.buffer_used,
318 (VBO_VERT_BUFFER_SIZE -
319 exec->vtx.buffer_used),
320 accessRange,
321 exec->vtx.bufferobj,
322 MAP_INTERNAL);
323 exec->vtx.buffer_ptr = exec->vtx.buffer_map;
324 }
325 else {
326 exec->vtx.buffer_ptr = exec->vtx.buffer_map = NULL;
327 }
328 }
329
330 if (!exec->vtx.buffer_map) {
331 /* Need to allocate a new VBO */
332 exec->vtx.buffer_used = 0;
333
334 if (ctx->Driver.BufferData(ctx, GL_ARRAY_BUFFER_ARB,
335 VBO_VERT_BUFFER_SIZE,
336 NULL, usage,
337 GL_MAP_WRITE_BIT |
338 GL_DYNAMIC_STORAGE_BIT |
339 GL_CLIENT_STORAGE_BIT,
340 exec->vtx.bufferobj)) {
341 /* buffer allocation worked, now map the buffer */
342 exec->vtx.buffer_map =
343 (fi_type *)ctx->Driver.MapBufferRange(ctx,
344 0, VBO_VERT_BUFFER_SIZE,
345 accessRange,
346 exec->vtx.bufferobj,
347 MAP_INTERNAL);
348 }
349 else {
350 _mesa_error(ctx, GL_OUT_OF_MEMORY, "VBO allocation");
351 exec->vtx.buffer_map = NULL;
352 }
353 }
354
355 exec->vtx.buffer_ptr = exec->vtx.buffer_map;
356
357 if (!exec->vtx.buffer_map) {
358 /* out of memory */
359 _mesa_install_exec_vtxfmt( ctx, &exec->vtxfmt_noop );
360 }
361 else {
362 if (_mesa_using_noop_vtxfmt(ctx->Exec)) {
363 /* The no-op functions are installed so switch back to regular
364 * functions. We do this test just to avoid frequent and needless
365 * calls to _mesa_install_exec_vtxfmt().
366 */
367 _mesa_install_exec_vtxfmt(ctx, &exec->vtxfmt);
368 }
369 }
370
371 if (0)
372 printf("map %d..\n", exec->vtx.buffer_used);
373 }
374
375
376
377 /**
378 * Execute the buffer and save copied verts.
379 * \param keep_unmapped if true, leave the VBO unmapped when we're done.
380 */
381 void
382 vbo_exec_vtx_flush(struct vbo_exec_context *exec, GLboolean keepUnmapped)
383 {
384 if (0)
385 vbo_exec_debug_verts( exec );
386
387 if (exec->vtx.prim_count &&
388 exec->vtx.vert_count) {
389
390 exec->vtx.copied.nr = vbo_copy_vertices( exec );
391
392 if (exec->vtx.copied.nr != exec->vtx.vert_count) {
393 struct gl_context *ctx = exec->ctx;
394
395 /* Before the update_state() as this may raise _NEW_VARYING_VP_INPUTS
396 * from _mesa_set_varying_vp_inputs().
397 */
398 vbo_exec_bind_arrays( ctx );
399
400 if (ctx->NewState)
401 _mesa_update_state( ctx );
402
403 if (_mesa_is_bufferobj(exec->vtx.bufferobj)) {
404 vbo_exec_vtx_unmap( exec );
405 }
406
407 if (0)
408 printf("%s %d %d\n", __func__, exec->vtx.prim_count,
409 exec->vtx.vert_count);
410
411 vbo_context(ctx)->draw_prims( ctx,
412 exec->vtx.prim,
413 exec->vtx.prim_count,
414 NULL,
415 GL_TRUE,
416 0,
417 exec->vtx.vert_count - 1,
418 NULL, 0, NULL);
419
420 /* If using a real VBO, get new storage -- unless asked not to.
421 */
422 if (_mesa_is_bufferobj(exec->vtx.bufferobj) && !keepUnmapped) {
423 vbo_exec_vtx_map( exec );
424 }
425 }
426 }
427
428 /* May have to unmap explicitly if we didn't draw:
429 */
430 if (keepUnmapped &&
431 _mesa_is_bufferobj(exec->vtx.bufferobj) &&
432 exec->vtx.buffer_map) {
433 vbo_exec_vtx_unmap( exec );
434 }
435
436 if (keepUnmapped || exec->vtx.vertex_size == 0)
437 exec->vtx.max_vert = 0;
438 else
439 exec->vtx.max_vert = ((VBO_VERT_BUFFER_SIZE - exec->vtx.buffer_used) /
440 (exec->vtx.vertex_size * sizeof(GLfloat)));
441
442 exec->vtx.buffer_ptr = exec->vtx.buffer_map;
443 exec->vtx.prim_count = 0;
444 exec->vtx.vert_count = 0;
445 }