mesa: tidy up left over APPLE_vertex_array_object semantics
[mesa.git] / src / mesa / main / arrayobj.c
1 /*
2 * Mesa 3-D graphics library
3 *
4 * Copyright (C) 1999-2008 Brian Paul All Rights Reserved.
5 * (C) Copyright IBM Corporation 2006
6 * Copyright (C) 2009 VMware, Inc. All Rights Reserved.
7 *
8 * Permission is hereby granted, free of charge, to any person obtaining a
9 * copy of this software and associated documentation files (the "Software"),
10 * to deal in the Software without restriction, including without limitation
11 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
12 * and/or sell copies of the Software, and to permit persons to whom the
13 * Software is furnished to do so, subject to the following conditions:
14 *
15 * The above copyright notice and this permission notice shall be included
16 * in all copies or substantial portions of the Software.
17 *
18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
19 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
21 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
22 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
23 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
24 * OTHER DEALINGS IN THE SOFTWARE.
25 */
26
27
28 /**
29 * \file arrayobj.c
30 *
31 * Implementation of Vertex Array Objects (VAOs), from OpenGL 3.1+ /
32 * the GL_ARB_vertex_array_object extension.
33 *
34 * \todo
35 * The code in this file borrows a lot from bufferobj.c. There's a certain
36 * amount of cruft left over from that origin that may be unnecessary.
37 *
38 * \author Ian Romanick <idr@us.ibm.com>
39 * \author Brian Paul
40 */
41
42
43 #include "glheader.h"
44 #include "hash.h"
45 #include "image.h"
46 #include "imports.h"
47 #include "context.h"
48 #include "bufferobj.h"
49 #include "arrayobj.h"
50 #include "macros.h"
51 #include "mtypes.h"
52 #include "varray.h"
53 #include "main/dispatch.h"
54 #include "util/bitscan.h"
55
56
57 /**
58 * Look up the array object for the given ID.
59 *
60 * \returns
61 * Either a pointer to the array object with the specified ID or \c NULL for
62 * a non-existent ID. The spec defines ID 0 as being technically
63 * non-existent.
64 */
65
66 struct gl_vertex_array_object *
67 _mesa_lookup_vao(struct gl_context *ctx, GLuint id)
68 {
69 if (id == 0)
70 return NULL;
71 else
72 return (struct gl_vertex_array_object *)
73 _mesa_HashLookupLocked(ctx->Array.Objects, id);
74 }
75
76
77 /**
78 * Looks up the array object for the given ID.
79 *
80 * Unlike _mesa_lookup_vao, this function generates a GL_INVALID_OPERATION
81 * error if the array object does not exist. It also returns the default
82 * array object when ctx is a compatibility profile context and id is zero.
83 */
84 struct gl_vertex_array_object *
85 _mesa_lookup_vao_err(struct gl_context *ctx, GLuint id, const char *caller)
86 {
87 /* The ARB_direct_state_access specification says:
88 *
89 * "<vaobj> is [compatibility profile:
90 * zero, indicating the default vertex array object, or]
91 * the name of the vertex array object."
92 */
93 if (id == 0) {
94 if (ctx->API == API_OPENGL_CORE) {
95 _mesa_error(ctx, GL_INVALID_OPERATION,
96 "%s(zero is not valid vaobj name in a core profile "
97 "context)", caller);
98 return NULL;
99 }
100
101 return ctx->Array.DefaultVAO;
102 } else {
103 struct gl_vertex_array_object *vao;
104
105 if (ctx->Array.LastLookedUpVAO &&
106 ctx->Array.LastLookedUpVAO->Name == id) {
107 vao = ctx->Array.LastLookedUpVAO;
108 } else {
109 vao = (struct gl_vertex_array_object *)
110 _mesa_HashLookupLocked(ctx->Array.Objects, id);
111
112 /* The ARB_direct_state_access specification says:
113 *
114 * "An INVALID_OPERATION error is generated if <vaobj> is not
115 * [compatibility profile: zero or] the name of an existing
116 * vertex array object."
117 */
118 if (!vao || !vao->EverBound) {
119 _mesa_error(ctx, GL_INVALID_OPERATION,
120 "%s(non-existent vaobj=%u)", caller, id);
121 return NULL;
122 }
123
124 _mesa_reference_vao(ctx, &ctx->Array.LastLookedUpVAO, vao);
125 }
126
127 return vao;
128 }
129 }
130
131
132 /**
133 * For all the vertex binding points in the array object, unbind any pointers
134 * to any buffer objects (VBOs).
135 * This is done just prior to array object destruction.
136 */
137 static void
138 unbind_array_object_vbos(struct gl_context *ctx, struct gl_vertex_array_object *obj)
139 {
140 GLuint i;
141
142 for (i = 0; i < ARRAY_SIZE(obj->BufferBinding); i++)
143 _mesa_reference_buffer_object(ctx, &obj->BufferBinding[i].BufferObj, NULL);
144
145 for (i = 0; i < ARRAY_SIZE(obj->_VertexAttrib); i++)
146 _mesa_reference_buffer_object(ctx, &obj->_VertexAttrib[i].BufferObj, NULL);
147 }
148
149
150 /**
151 * Allocate and initialize a new vertex array object.
152 */
153 struct gl_vertex_array_object *
154 _mesa_new_vao(struct gl_context *ctx, GLuint name)
155 {
156 struct gl_vertex_array_object *obj = CALLOC_STRUCT(gl_vertex_array_object);
157 if (obj)
158 _mesa_initialize_vao(ctx, obj, name);
159 return obj;
160 }
161
162
163 /**
164 * Delete an array object.
165 */
166 void
167 _mesa_delete_vao(struct gl_context *ctx, struct gl_vertex_array_object *obj)
168 {
169 unbind_array_object_vbos(ctx, obj);
170 _mesa_reference_buffer_object(ctx, &obj->IndexBufferObj, NULL);
171 free(obj->Label);
172 free(obj);
173 }
174
175
176 /**
177 * Set ptr to vao w/ reference counting.
178 * Note: this should only be called from the _mesa_reference_vao()
179 * inline function.
180 */
181 void
182 _mesa_reference_vao_(struct gl_context *ctx,
183 struct gl_vertex_array_object **ptr,
184 struct gl_vertex_array_object *vao)
185 {
186 assert(*ptr != vao);
187
188 if (*ptr) {
189 /* Unreference the old array object */
190 struct gl_vertex_array_object *oldObj = *ptr;
191
192 assert(oldObj->RefCount > 0);
193 oldObj->RefCount--;
194
195 if (oldObj->RefCount == 0)
196 _mesa_delete_vao(ctx, oldObj);
197
198 *ptr = NULL;
199 }
200 assert(!*ptr);
201
202 if (vao) {
203 /* reference new array object */
204 assert(vao->RefCount > 0);
205
206 vao->RefCount++;
207 *ptr = vao;
208 }
209 }
210
211
212 /**
213 * Initialize attribtes of a vertex array within a vertex array object.
214 * \param vao the container vertex array object
215 * \param index which array in the VAO to initialize
216 * \param size number of components (1, 2, 3 or 4) per attribute
217 * \param type datatype of the attribute (GL_FLOAT, GL_INT, etc).
218 */
219 static void
220 init_array(struct gl_context *ctx,
221 struct gl_vertex_array_object *vao,
222 GLuint index, GLint size, GLint type)
223 {
224 struct gl_array_attributes *array = &vao->VertexAttrib[index];
225 struct gl_vertex_buffer_binding *binding = &vao->BufferBinding[index];
226
227 array->Size = size;
228 array->Type = type;
229 array->Format = GL_RGBA; /* only significant for GL_EXT_vertex_array_bgra */
230 array->Stride = 0;
231 array->Ptr = NULL;
232 array->RelativeOffset = 0;
233 array->Enabled = GL_FALSE;
234 array->Normalized = GL_FALSE;
235 array->Integer = GL_FALSE;
236 array->Doubles = GL_FALSE;
237 array->_ElementSize = size * _mesa_sizeof_type(type);
238 array->BufferBindingIndex = index;
239
240 binding->Offset = 0;
241 binding->Stride = array->_ElementSize;
242 binding->BufferObj = NULL;
243 binding->_BoundArrays = BITFIELD64_BIT(index);
244
245 /* Vertex array buffers */
246 _mesa_reference_buffer_object(ctx, &binding->BufferObj,
247 ctx->Shared->NullBufferObj);
248 }
249
250
251 /**
252 * Initialize a gl_vertex_array_object's arrays.
253 */
254 void
255 _mesa_initialize_vao(struct gl_context *ctx,
256 struct gl_vertex_array_object *vao,
257 GLuint name)
258 {
259 GLuint i;
260
261 vao->Name = name;
262
263 vao->RefCount = 1;
264
265 /* Init the individual arrays */
266 for (i = 0; i < ARRAY_SIZE(vao->VertexAttrib); i++) {
267 switch (i) {
268 case VERT_ATTRIB_WEIGHT:
269 init_array(ctx, vao, VERT_ATTRIB_WEIGHT, 1, GL_FLOAT);
270 break;
271 case VERT_ATTRIB_NORMAL:
272 init_array(ctx, vao, VERT_ATTRIB_NORMAL, 3, GL_FLOAT);
273 break;
274 case VERT_ATTRIB_COLOR1:
275 init_array(ctx, vao, VERT_ATTRIB_COLOR1, 3, GL_FLOAT);
276 break;
277 case VERT_ATTRIB_FOG:
278 init_array(ctx, vao, VERT_ATTRIB_FOG, 1, GL_FLOAT);
279 break;
280 case VERT_ATTRIB_COLOR_INDEX:
281 init_array(ctx, vao, VERT_ATTRIB_COLOR_INDEX, 1, GL_FLOAT);
282 break;
283 case VERT_ATTRIB_EDGEFLAG:
284 init_array(ctx, vao, VERT_ATTRIB_EDGEFLAG, 1, GL_BOOL);
285 break;
286 case VERT_ATTRIB_POINT_SIZE:
287 init_array(ctx, vao, VERT_ATTRIB_POINT_SIZE, 1, GL_FLOAT);
288 break;
289 default:
290 init_array(ctx, vao, i, 4, GL_FLOAT);
291 break;
292 }
293 }
294
295 _mesa_reference_buffer_object(ctx, &vao->IndexBufferObj,
296 ctx->Shared->NullBufferObj);
297 }
298
299
300 /**
301 * Add the given array object to the array object pool.
302 */
303 static void
304 save_array_object(struct gl_context *ctx, struct gl_vertex_array_object *vao)
305 {
306 if (vao->Name > 0) {
307 /* insert into hash table */
308 _mesa_HashInsertLocked(ctx->Array.Objects, vao->Name, vao);
309 }
310 }
311
312
313 /**
314 * Remove the given array object from the array object pool.
315 * Do not deallocate the array object though.
316 */
317 static void
318 remove_array_object(struct gl_context *ctx, struct gl_vertex_array_object *vao)
319 {
320 if (vao->Name > 0) {
321 /* remove from hash table */
322 _mesa_HashRemoveLocked(ctx->Array.Objects, vao->Name);
323 }
324 }
325
326
327 /**
328 * Updates the derived gl_vertex_arrays when a gl_vertex_attrib_array
329 * or a gl_vertex_buffer_binding has changed.
330 */
331 void
332 _mesa_update_vao_client_arrays(struct gl_context *ctx,
333 struct gl_vertex_array_object *vao)
334 {
335 GLbitfield64 arrays = vao->NewArrays;
336
337 while (arrays) {
338 const int attrib = u_bit_scan64(&arrays);
339 struct gl_vertex_array *client_array = &vao->_VertexAttrib[attrib];
340 const struct gl_array_attributes *attrib_array =
341 &vao->VertexAttrib[attrib];
342 const struct gl_vertex_buffer_binding *buffer_binding =
343 &vao->BufferBinding[attrib_array->BufferBindingIndex];
344
345 _mesa_update_client_array(ctx, client_array, attrib_array,
346 buffer_binding);
347 }
348 }
349
350
351 bool
352 _mesa_all_varyings_in_vbos(const struct gl_vertex_array_object *vao)
353 {
354 /* Walk those enabled arrays that have the default vbo attached */
355 GLbitfield64 mask = vao->_Enabled & ~vao->VertexAttribBufferMask;
356
357 while (mask) {
358 /* Do not use u_bit_scan64 as we can walk multiple
359 * attrib arrays at once
360 */
361 const int i = ffsll(mask) - 1;
362 const struct gl_array_attributes *attrib_array =
363 &vao->VertexAttrib[i];
364 const struct gl_vertex_buffer_binding *buffer_binding =
365 &vao->BufferBinding[attrib_array->BufferBindingIndex];
366
367 /* Only enabled arrays shall appear in the _Enabled bitmask */
368 assert(attrib_array->Enabled);
369 /* We have already masked out vao->VertexAttribBufferMask */
370 assert(!_mesa_is_bufferobj(buffer_binding->BufferObj));
371
372 /* Bail out once we find the first non vbo with a non zero stride */
373 if (buffer_binding->Stride != 0)
374 return false;
375
376 /* Note that we cannot use the xor variant since the _BoundArray mask
377 * may contain array attributes that are bound but not enabled.
378 */
379 mask &= ~buffer_binding->_BoundArrays;
380 }
381
382 return true;
383 }
384
385 bool
386 _mesa_all_buffers_are_unmapped(const struct gl_vertex_array_object *vao)
387 {
388 /* Walk the enabled arrays that have a vbo attached */
389 GLbitfield64 mask = vao->_Enabled & vao->VertexAttribBufferMask;
390
391 while (mask) {
392 const int i = ffsll(mask) - 1;
393 const struct gl_array_attributes *attrib_array =
394 &vao->VertexAttrib[i];
395 const struct gl_vertex_buffer_binding *buffer_binding =
396 &vao->BufferBinding[attrib_array->BufferBindingIndex];
397
398 /* Only enabled arrays shall appear in the _Enabled bitmask */
399 assert(attrib_array->Enabled);
400 /* We have already masked with vao->VertexAttribBufferMask */
401 assert(_mesa_is_bufferobj(buffer_binding->BufferObj));
402
403 /* Bail out once we find the first disallowed mapping */
404 if (_mesa_check_disallowed_mapping(buffer_binding->BufferObj))
405 return false;
406
407 /* We have handled everything that is bound to this buffer_binding. */
408 mask &= ~buffer_binding->_BoundArrays;
409 }
410
411 return true;
412 }
413
414 /**********************************************************************/
415 /* API Functions */
416 /**********************************************************************/
417
418
419 /**
420 * ARB version of glBindVertexArray()
421 */
422 void GLAPIENTRY
423 _mesa_BindVertexArray( GLuint id )
424 {
425 GET_CURRENT_CONTEXT(ctx);
426
427 struct gl_vertex_array_object * const oldObj = ctx->Array.VAO;
428 struct gl_vertex_array_object *newObj = NULL;
429
430 assert(oldObj != NULL);
431
432 if (oldObj->Name == id)
433 return; /* rebinding the same array object- no change */
434
435 /*
436 * Get pointer to new array object (newObj)
437 */
438 if (id == 0) {
439 /* The spec says there is no array object named 0, but we use
440 * one internally because it simplifies things.
441 */
442 newObj = ctx->Array.DefaultVAO;
443 }
444 else {
445 /* non-default array object */
446 newObj = _mesa_lookup_vao(ctx, id);
447 if (!newObj) {
448 _mesa_error(ctx, GL_INVALID_OPERATION,
449 "glBindVertexArray(non-gen name)");
450 return;
451 }
452
453 newObj->EverBound = GL_TRUE;
454 }
455
456 if (ctx->Array.DrawMethod == DRAW_ARRAYS) {
457 /* The _DrawArrays pointer is pointing at the VAO being unbound and
458 * that VAO may be in the process of being deleted. If it's not going
459 * to be deleted, this will have no effect, because the pointer needs
460 * to be updated by the VBO module anyway.
461 *
462 * Before the VBO module can update the pointer, we have to set it
463 * to NULL for drivers not to set up arrays which are not bound,
464 * or to prevent a crash if the VAO being unbound is going to be
465 * deleted.
466 */
467 ctx->Array._DrawArrays = NULL;
468 ctx->Array.DrawMethod = DRAW_NONE;
469 }
470
471 ctx->NewState |= _NEW_ARRAY;
472 _mesa_reference_vao(ctx, &ctx->Array.VAO, newObj);
473 }
474
475
476 /**
477 * Delete a set of array objects.
478 *
479 * \param n Number of array objects to delete.
480 * \param ids Array of \c n array object IDs.
481 */
482 void GLAPIENTRY
483 _mesa_DeleteVertexArrays(GLsizei n, const GLuint *ids)
484 {
485 GET_CURRENT_CONTEXT(ctx);
486 GLsizei i;
487
488 if (n < 0) {
489 _mesa_error(ctx, GL_INVALID_VALUE, "glDeleteVertexArray(n)");
490 return;
491 }
492
493 for (i = 0; i < n; i++) {
494 struct gl_vertex_array_object *obj = _mesa_lookup_vao(ctx, ids[i]);
495
496 if ( obj != NULL ) {
497 assert( obj->Name == ids[i] );
498
499 /* If the array object is currently bound, the spec says "the binding
500 * for that object reverts to zero and the default vertex array
501 * becomes current."
502 */
503 if ( obj == ctx->Array.VAO ) {
504 _mesa_BindVertexArray(0);
505 }
506
507 /* The ID is immediately freed for re-use */
508 remove_array_object(ctx, obj);
509
510 if (ctx->Array.LastLookedUpVAO == obj)
511 _mesa_reference_vao(ctx, &ctx->Array.LastLookedUpVAO, NULL);
512
513 /* Unreference the array object.
514 * If refcount hits zero, the object will be deleted.
515 */
516 _mesa_reference_vao(ctx, &obj, NULL);
517 }
518 }
519 }
520
521
522 /**
523 * Generate a set of unique array object IDs and store them in \c arrays.
524 * Helper for _mesa_GenVertexArrays() and _mesa_CreateVertexArrays()
525 * below.
526 *
527 * \param n Number of IDs to generate.
528 * \param arrays Array of \c n locations to store the IDs.
529 * \param create Indicates that the objects should also be created.
530 * \param func The name of the GL entry point.
531 */
532 static void
533 gen_vertex_arrays(struct gl_context *ctx, GLsizei n, GLuint *arrays,
534 bool create, const char *func)
535 {
536 GLuint first;
537 GLint i;
538
539 if (n < 0) {
540 _mesa_error(ctx, GL_INVALID_VALUE, "%s(n < 0)", func);
541 return;
542 }
543
544 if (!arrays) {
545 return;
546 }
547
548 first = _mesa_HashFindFreeKeyBlock(ctx->Array.Objects, n);
549
550 /* For the sake of simplicity we create the array objects in both
551 * the Gen* and Create* cases. The only difference is the value of
552 * EverBound, which is set to true in the Create* case.
553 */
554 for (i = 0; i < n; i++) {
555 struct gl_vertex_array_object *obj;
556 GLuint name = first + i;
557
558 obj = _mesa_new_vao(ctx, name);
559 if (!obj) {
560 _mesa_error(ctx, GL_OUT_OF_MEMORY, "%s", func);
561 return;
562 }
563 obj->EverBound = create;
564 save_array_object(ctx, obj);
565 arrays[i] = first + i;
566 }
567 }
568
569
570 /**
571 * ARB version of glGenVertexArrays()
572 * All arrays will be required to live in VBOs.
573 */
574 void GLAPIENTRY
575 _mesa_GenVertexArrays(GLsizei n, GLuint *arrays)
576 {
577 GET_CURRENT_CONTEXT(ctx);
578 gen_vertex_arrays(ctx, n, arrays, false, "glGenVertexArrays");
579 }
580
581
582 /**
583 * ARB_direct_state_access
584 * Generates ID's and creates the array objects.
585 */
586 void GLAPIENTRY
587 _mesa_CreateVertexArrays(GLsizei n, GLuint *arrays)
588 {
589 GET_CURRENT_CONTEXT(ctx);
590 gen_vertex_arrays(ctx, n, arrays, true, "glCreateVertexArrays");
591 }
592
593
594 /**
595 * Determine if ID is the name of an array object.
596 *
597 * \param id ID of the potential array object.
598 * \return \c GL_TRUE if \c id is the name of a array object,
599 * \c GL_FALSE otherwise.
600 */
601 GLboolean GLAPIENTRY
602 _mesa_IsVertexArray( GLuint id )
603 {
604 struct gl_vertex_array_object * obj;
605 GET_CURRENT_CONTEXT(ctx);
606 ASSERT_OUTSIDE_BEGIN_END_WITH_RETVAL(ctx, GL_FALSE);
607
608 if (id == 0)
609 return GL_FALSE;
610
611 obj = _mesa_lookup_vao(ctx, id);
612 if (obj == NULL)
613 return GL_FALSE;
614
615 return obj->EverBound;
616 }
617
618
619 /**
620 * Sets the element array buffer binding of a vertex array object.
621 *
622 * This is the ARB_direct_state_access equivalent of
623 * glBindBuffer(GL_ELEMENT_ARRAY_BUFFER, buffer).
624 */
625 void GLAPIENTRY
626 _mesa_VertexArrayElementBuffer(GLuint vaobj, GLuint buffer)
627 {
628 GET_CURRENT_CONTEXT(ctx);
629 struct gl_vertex_array_object *vao;
630 struct gl_buffer_object *bufObj;
631
632 ASSERT_OUTSIDE_BEGIN_END(ctx);
633
634 /* The GL_ARB_direct_state_access specification says:
635 *
636 * "An INVALID_OPERATION error is generated by VertexArrayElementBuffer
637 * if <vaobj> is not [compatibility profile: zero or] the name of an
638 * existing vertex array object."
639 */
640 vao =_mesa_lookup_vao_err(ctx, vaobj, "glVertexArrayElementBuffer");
641 if (!vao)
642 return;
643
644 /* The GL_ARB_direct_state_access specification says:
645 *
646 * "An INVALID_OPERATION error is generated if <buffer> is not zero or
647 * the name of an existing buffer object."
648 */
649 if (buffer != 0)
650 bufObj = _mesa_lookup_bufferobj_err(ctx, buffer,
651 "glVertexArrayElementBuffer");
652 else
653 bufObj = ctx->Shared->NullBufferObj;
654
655 if (bufObj)
656 _mesa_reference_buffer_object(ctx, &vao->IndexBufferObj, bufObj);
657 }
658
659
660 void GLAPIENTRY
661 _mesa_GetVertexArrayiv(GLuint vaobj, GLenum pname, GLint *param)
662 {
663 GET_CURRENT_CONTEXT(ctx);
664 struct gl_vertex_array_object *vao;
665
666 ASSERT_OUTSIDE_BEGIN_END(ctx);
667
668 /* The GL_ARB_direct_state_access specification says:
669 *
670 * "An INVALID_OPERATION error is generated if <vaobj> is not
671 * [compatibility profile: zero or] the name of an existing
672 * vertex array object."
673 */
674 vao =_mesa_lookup_vao_err(ctx, vaobj, "glGetVertexArrayiv");
675 if (!vao)
676 return;
677
678 /* The GL_ARB_direct_state_access specification says:
679 *
680 * "An INVALID_ENUM error is generated if <pname> is not
681 * ELEMENT_ARRAY_BUFFER_BINDING."
682 */
683 if (pname != GL_ELEMENT_ARRAY_BUFFER_BINDING) {
684 _mesa_error(ctx, GL_INVALID_ENUM,
685 "glGetVertexArrayiv(pname != "
686 "GL_ELEMENT_ARRAY_BUFFER_BINDING)");
687 return;
688 }
689
690 param[0] = vao->IndexBufferObj->Name;
691 }