2 * Mesa 3-D graphics library
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.
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:
15 * The above copyright notice and this permission notice shall be included
16 * in all copies or substantial portions of the Software.
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.
31 * Implementation of Vertex Array Objects (VAOs), from OpenGL 3.1+,
32 * the GL_ARB_vertex_array_object extension, or the older
33 * GL_APPLE_vertex_array_object extension.
36 * The code in this file borrows a lot from bufferobj.c. There's a certain
37 * amount of cruft left over from that origin that may be unnecessary.
39 * \author Ian Romanick <idr@us.ibm.com>
49 #include "bufferobj.h"
54 #include "main/dispatch.h"
55 #include "util/bitscan.h"
59 * Look up the array object for the given ID.
62 * Either a pointer to the array object with the specified ID or \c NULL for
63 * a non-existent ID. The spec defines ID 0 as being technically
67 struct gl_vertex_array_object
*
68 _mesa_lookup_vao(struct gl_context
*ctx
, GLuint id
)
73 return (struct gl_vertex_array_object
*)
74 _mesa_HashLookup(ctx
->Array
.Objects
, id
);
79 * Looks up the array object for the given ID.
81 * Unlike _mesa_lookup_vao, this function generates a GL_INVALID_OPERATION
82 * error if the array object does not exist. It also returns the default
83 * array object when ctx is a compatibility profile context and id is zero.
85 struct gl_vertex_array_object
*
86 _mesa_lookup_vao_err(struct gl_context
*ctx
, GLuint id
, const char *caller
)
88 /* The ARB_direct_state_access specification says:
90 * "<vaobj> is [compatibility profile:
91 * zero, indicating the default vertex array object, or]
92 * the name of the vertex array object."
95 if (ctx
->API
== API_OPENGL_CORE
) {
96 _mesa_error(ctx
, GL_INVALID_OPERATION
,
97 "%s(zero is not valid vaobj name in a core profile "
102 return ctx
->Array
.DefaultVAO
;
104 struct gl_vertex_array_object
*vao
;
106 if (ctx
->Array
.LastLookedUpVAO
&&
107 ctx
->Array
.LastLookedUpVAO
->Name
== id
) {
108 vao
= ctx
->Array
.LastLookedUpVAO
;
110 vao
= (struct gl_vertex_array_object
*)
111 _mesa_HashLookup(ctx
->Array
.Objects
, id
);
113 /* The ARB_direct_state_access specification says:
115 * "An INVALID_OPERATION error is generated if <vaobj> is not
116 * [compatibility profile: zero or] the name of an existing
117 * vertex array object."
119 if (!vao
|| !vao
->EverBound
) {
120 _mesa_error(ctx
, GL_INVALID_OPERATION
,
121 "%s(non-existent vaobj=%u)", caller
, id
);
125 _mesa_reference_vao(ctx
, &ctx
->Array
.LastLookedUpVAO
, vao
);
134 * For all the vertex binding points in the array object, unbind any pointers
135 * to any buffer objects (VBOs).
136 * This is done just prior to array object destruction.
139 unbind_array_object_vbos(struct gl_context
*ctx
, struct gl_vertex_array_object
*obj
)
143 for (i
= 0; i
< ARRAY_SIZE(obj
->VertexBinding
); i
++)
144 _mesa_reference_buffer_object(ctx
, &obj
->VertexBinding
[i
].BufferObj
, NULL
);
146 for (i
= 0; i
< ARRAY_SIZE(obj
->_VertexAttrib
); i
++)
147 _mesa_reference_buffer_object(ctx
, &obj
->_VertexAttrib
[i
].BufferObj
, NULL
);
152 * Allocate and initialize a new vertex array object.
154 struct gl_vertex_array_object
*
155 _mesa_new_vao(struct gl_context
*ctx
, GLuint name
)
157 struct gl_vertex_array_object
*obj
= CALLOC_STRUCT(gl_vertex_array_object
);
159 _mesa_initialize_vao(ctx
, obj
, name
);
165 * Delete an array object.
168 _mesa_delete_vao(struct gl_context
*ctx
, struct gl_vertex_array_object
*obj
)
170 unbind_array_object_vbos(ctx
, obj
);
171 _mesa_reference_buffer_object(ctx
, &obj
->IndexBufferObj
, NULL
);
172 mtx_destroy(&obj
->Mutex
);
179 * Set ptr to vao w/ reference counting.
180 * Note: this should only be called from the _mesa_reference_vao()
184 _mesa_reference_vao_(struct gl_context
*ctx
,
185 struct gl_vertex_array_object
**ptr
,
186 struct gl_vertex_array_object
*vao
)
191 /* Unreference the old array object */
192 GLboolean deleteFlag
= GL_FALSE
;
193 struct gl_vertex_array_object
*oldObj
= *ptr
;
195 mtx_lock(&oldObj
->Mutex
);
196 assert(oldObj
->RefCount
> 0);
198 deleteFlag
= (oldObj
->RefCount
== 0);
199 mtx_unlock(&oldObj
->Mutex
);
202 _mesa_delete_vao(ctx
, oldObj
);
209 /* reference new array object */
210 mtx_lock(&vao
->Mutex
);
211 if (vao
->RefCount
== 0) {
212 /* this array's being deleted (look just above) */
213 /* Not sure this can every really happen. Warn if it does. */
214 _mesa_problem(NULL
, "referencing deleted array object");
221 mtx_unlock(&vao
->Mutex
);
228 init_array(struct gl_context
*ctx
,
229 struct gl_vertex_array_object
*obj
, GLuint index
, GLint size
, GLint type
)
231 struct gl_vertex_attrib_array
*array
= &obj
->VertexAttrib
[index
];
232 struct gl_vertex_buffer_binding
*binding
= &obj
->VertexBinding
[index
];
236 array
->Format
= GL_RGBA
; /* only significant for GL_EXT_vertex_array_bgra */
239 array
->RelativeOffset
= 0;
240 array
->Enabled
= GL_FALSE
;
241 array
->Normalized
= GL_FALSE
;
242 array
->Integer
= GL_FALSE
;
243 array
->Doubles
= GL_FALSE
;
244 array
->_ElementSize
= size
* _mesa_sizeof_type(type
);
245 array
->VertexBinding
= index
;
248 binding
->Stride
= array
->_ElementSize
;
249 binding
->BufferObj
= NULL
;
250 binding
->_BoundArrays
= BITFIELD64_BIT(index
);
252 /* Vertex array buffers */
253 _mesa_reference_buffer_object(ctx
, &binding
->BufferObj
,
254 ctx
->Shared
->NullBufferObj
);
259 * Initialize a gl_vertex_array_object's arrays.
262 _mesa_initialize_vao(struct gl_context
*ctx
,
263 struct gl_vertex_array_object
*obj
,
270 mtx_init(&obj
->Mutex
, mtx_plain
);
273 /* Init the individual arrays */
274 for (i
= 0; i
< ARRAY_SIZE(obj
->VertexAttrib
); i
++) {
276 case VERT_ATTRIB_WEIGHT
:
277 init_array(ctx
, obj
, VERT_ATTRIB_WEIGHT
, 1, GL_FLOAT
);
279 case VERT_ATTRIB_NORMAL
:
280 init_array(ctx
, obj
, VERT_ATTRIB_NORMAL
, 3, GL_FLOAT
);
282 case VERT_ATTRIB_COLOR1
:
283 init_array(ctx
, obj
, VERT_ATTRIB_COLOR1
, 3, GL_FLOAT
);
285 case VERT_ATTRIB_FOG
:
286 init_array(ctx
, obj
, VERT_ATTRIB_FOG
, 1, GL_FLOAT
);
288 case VERT_ATTRIB_COLOR_INDEX
:
289 init_array(ctx
, obj
, VERT_ATTRIB_COLOR_INDEX
, 1, GL_FLOAT
);
291 case VERT_ATTRIB_EDGEFLAG
:
292 init_array(ctx
, obj
, VERT_ATTRIB_EDGEFLAG
, 1, GL_BOOL
);
294 case VERT_ATTRIB_POINT_SIZE
:
295 init_array(ctx
, obj
, VERT_ATTRIB_POINT_SIZE
, 1, GL_FLOAT
);
298 init_array(ctx
, obj
, i
, 4, GL_FLOAT
);
303 _mesa_reference_buffer_object(ctx
, &obj
->IndexBufferObj
,
304 ctx
->Shared
->NullBufferObj
);
309 * Add the given array object to the array object pool.
312 save_array_object( struct gl_context
*ctx
, struct gl_vertex_array_object
*obj
)
315 /* insert into hash table */
316 _mesa_HashInsert(ctx
->Array
.Objects
, obj
->Name
, obj
);
322 * Remove the given array object from the array object pool.
323 * Do not deallocate the array object though.
326 remove_array_object( struct gl_context
*ctx
, struct gl_vertex_array_object
*obj
)
329 /* remove from hash table */
330 _mesa_HashRemove(ctx
->Array
.Objects
, obj
->Name
);
336 * Updates the derived gl_client_arrays when a gl_vertex_attrib_array
337 * or a gl_vertex_buffer_binding has changed.
340 _mesa_update_vao_client_arrays(struct gl_context
*ctx
,
341 struct gl_vertex_array_object
*vao
)
343 GLbitfield64 arrays
= vao
->NewArrays
;
346 const int attrib
= u_bit_scan64(&arrays
);
348 struct gl_client_array
*client_array
;
349 struct gl_vertex_attrib_array
*attrib_array
;
350 struct gl_vertex_buffer_binding
*buffer_binding
;
352 attrib_array
= &vao
->VertexAttrib
[attrib
];
353 buffer_binding
= &vao
->VertexBinding
[attrib_array
->VertexBinding
];
354 client_array
= &vao
->_VertexAttrib
[attrib
];
356 _mesa_update_client_array(ctx
, client_array
, attrib_array
,
363 _mesa_all_varyings_in_vbos(const struct gl_vertex_array_object
*vao
)
365 /* Walk those enabled arrays that have the default vbo attached */
366 GLbitfield64 mask
= vao
->_Enabled
& ~vao
->VertexAttribBufferMask
;
369 /* Do not use u_bit_scan64 as we can walk multiple
370 * attrib arrays at once
372 const int i
= ffsll(mask
) - 1;
373 const struct gl_vertex_attrib_array
*attrib_array
=
374 &vao
->VertexAttrib
[i
];
375 const struct gl_vertex_buffer_binding
*buffer_binding
=
376 &vao
->VertexBinding
[attrib_array
->VertexBinding
];
378 /* Only enabled arrays shall appear in the _Enabled bitmask */
379 assert(attrib_array
->Enabled
);
380 /* We have already masked out vao->VertexAttribBufferMask */
381 assert(!_mesa_is_bufferobj(buffer_binding
->BufferObj
));
383 /* Bail out once we find the first non vbo with a non zero stride */
384 if (buffer_binding
->Stride
!= 0)
387 /* Note that we cannot use the xor variant since the _BoundArray mask
388 * may contain array attributes that are bound but not enabled.
390 mask
&= ~buffer_binding
->_BoundArrays
;
397 _mesa_all_buffers_are_unmapped(const struct gl_vertex_array_object
*vao
)
399 /* Walk the enabled arrays that have a vbo attached */
400 GLbitfield64 mask
= vao
->_Enabled
& vao
->VertexAttribBufferMask
;
403 const int i
= ffsll(mask
) - 1;
404 const struct gl_vertex_attrib_array
*attrib_array
=
405 &vao
->VertexAttrib
[i
];
406 const struct gl_vertex_buffer_binding
*buffer_binding
=
407 &vao
->VertexBinding
[attrib_array
->VertexBinding
];
409 /* Only enabled arrays shall appear in the _Enabled bitmask */
410 assert(attrib_array
->Enabled
);
411 /* We have already masked with vao->VertexAttribBufferMask */
412 assert(_mesa_is_bufferobj(buffer_binding
->BufferObj
));
414 /* Bail out once we find the first disallowed mapping */
415 if (_mesa_check_disallowed_mapping(buffer_binding
->BufferObj
))
418 /* We have handled everything that is bound to this buffer_binding. */
419 mask
&= ~buffer_binding
->_BoundArrays
;
425 /**********************************************************************/
427 /**********************************************************************/
431 * Helper for _mesa_BindVertexArray() and _mesa_BindVertexArrayAPPLE().
432 * \param genRequired specifies behavour when id was not generated with
433 * glGenVertexArrays().
436 bind_vertex_array(struct gl_context
*ctx
, GLuint id
, GLboolean genRequired
)
438 struct gl_vertex_array_object
* const oldObj
= ctx
->Array
.VAO
;
439 struct gl_vertex_array_object
*newObj
= NULL
;
441 assert(oldObj
!= NULL
);
443 if ( oldObj
->Name
== id
)
444 return; /* rebinding the same array object- no change */
447 * Get pointer to new array object (newObj)
450 /* The spec says there is no array object named 0, but we use
451 * one internally because it simplifies things.
453 newObj
= ctx
->Array
.DefaultVAO
;
456 /* non-default array object */
457 newObj
= _mesa_lookup_vao(ctx
, id
);
460 _mesa_error(ctx
, GL_INVALID_OPERATION
,
461 "glBindVertexArray(non-gen name)");
465 /* For APPLE version, generate a new array object now */
466 newObj
= _mesa_new_vao(ctx
, id
);
468 _mesa_error(ctx
, GL_OUT_OF_MEMORY
, "glBindVertexArrayAPPLE");
472 save_array_object(ctx
, newObj
);
475 if (!newObj
->EverBound
) {
476 /* The "Interactions with APPLE_vertex_array_object" section of the
477 * GL_ARB_vertex_array_object spec says:
479 * "The first bind call, either BindVertexArray or
480 * BindVertexArrayAPPLE, determines the semantic of the object."
482 newObj
->ARBsemantics
= genRequired
;
483 newObj
->EverBound
= GL_TRUE
;
487 if (ctx
->Array
.DrawMethod
== DRAW_ARRAYS
) {
488 /* The _DrawArrays pointer is pointing at the VAO being unbound and
489 * that VAO may be in the process of being deleted. If it's not going
490 * to be deleted, this will have no effect, because the pointer needs
491 * to be updated by the VBO module anyway.
493 * Before the VBO module can update the pointer, we have to set it
494 * to NULL for drivers not to set up arrays which are not bound,
495 * or to prevent a crash if the VAO being unbound is going to be
498 ctx
->Array
._DrawArrays
= NULL
;
499 ctx
->Array
.DrawMethod
= DRAW_NONE
;
502 ctx
->NewState
|= _NEW_ARRAY
;
503 _mesa_reference_vao(ctx
, &ctx
->Array
.VAO
, newObj
);
508 * ARB version of glBindVertexArray()
509 * This function behaves differently from glBindVertexArrayAPPLE() in
510 * that this function requires all ids to have been previously generated
511 * by glGenVertexArrays[APPLE]().
514 _mesa_BindVertexArray( GLuint id
)
516 GET_CURRENT_CONTEXT(ctx
);
517 bind_vertex_array(ctx
, id
, GL_TRUE
);
525 * The binding could be done more efficiently by comparing the non-NULL
526 * pointers in the old and new objects. The only arrays that are "dirty" are
527 * the ones that are non-NULL in either object.
530 _mesa_BindVertexArrayAPPLE( GLuint id
)
532 GET_CURRENT_CONTEXT(ctx
);
533 bind_vertex_array(ctx
, id
, GL_FALSE
);
538 * Delete a set of array objects.
540 * \param n Number of array objects to delete.
541 * \param ids Array of \c n array object IDs.
544 _mesa_DeleteVertexArrays(GLsizei n
, const GLuint
*ids
)
546 GET_CURRENT_CONTEXT(ctx
);
550 _mesa_error(ctx
, GL_INVALID_VALUE
, "glDeleteVertexArray(n)");
554 for (i
= 0; i
< n
; i
++) {
555 struct gl_vertex_array_object
*obj
= _mesa_lookup_vao(ctx
, ids
[i
]);
558 assert( obj
->Name
== ids
[i
] );
560 /* If the array object is currently bound, the spec says "the binding
561 * for that object reverts to zero and the default vertex array
564 if ( obj
== ctx
->Array
.VAO
) {
565 _mesa_BindVertexArray(0);
568 /* The ID is immediately freed for re-use */
569 remove_array_object(ctx
, obj
);
571 if (ctx
->Array
.LastLookedUpVAO
== obj
)
572 _mesa_reference_vao(ctx
, &ctx
->Array
.LastLookedUpVAO
, NULL
);
574 /* Unreference the array object.
575 * If refcount hits zero, the object will be deleted.
577 _mesa_reference_vao(ctx
, &obj
, NULL
);
584 * Generate a set of unique array object IDs and store them in \c arrays.
585 * Helper for _mesa_GenVertexArrays[APPLE]() and _mesa_CreateVertexArrays()
588 * \param n Number of IDs to generate.
589 * \param arrays Array of \c n locations to store the IDs.
590 * \param create Indicates that the objects should also be created.
591 * \param func The name of the GL entry point.
594 gen_vertex_arrays(struct gl_context
*ctx
, GLsizei n
, GLuint
*arrays
,
595 bool create
, const char *func
)
601 _mesa_error(ctx
, GL_INVALID_VALUE
, "%s(n < 0)", func
);
609 first
= _mesa_HashFindFreeKeyBlock(ctx
->Array
.Objects
, n
);
611 /* For the sake of simplicity we create the array objects in both
612 * the Gen* and Create* cases. The only difference is the value of
613 * EverBound, which is set to true in the Create* case.
615 for (i
= 0; i
< n
; i
++) {
616 struct gl_vertex_array_object
*obj
;
617 GLuint name
= first
+ i
;
619 obj
= _mesa_new_vao(ctx
, name
);
621 _mesa_error(ctx
, GL_OUT_OF_MEMORY
, "%s", func
);
624 obj
->EverBound
= create
;
625 save_array_object(ctx
, obj
);
626 arrays
[i
] = first
+ i
;
632 * ARB version of glGenVertexArrays()
633 * All arrays will be required to live in VBOs.
636 _mesa_GenVertexArrays(GLsizei n
, GLuint
*arrays
)
638 GET_CURRENT_CONTEXT(ctx
);
639 gen_vertex_arrays(ctx
, n
, arrays
, false, "glGenVertexArrays");
644 * APPLE version of glGenVertexArraysAPPLE()
645 * Arrays may live in VBOs or ordinary memory.
648 _mesa_GenVertexArraysAPPLE(GLsizei n
, GLuint
*arrays
)
650 GET_CURRENT_CONTEXT(ctx
);
651 gen_vertex_arrays(ctx
, n
, arrays
, false, "glGenVertexArraysAPPLE");
656 * ARB_direct_state_access
657 * Generates ID's and creates the array objects.
660 _mesa_CreateVertexArrays(GLsizei n
, GLuint
*arrays
)
662 GET_CURRENT_CONTEXT(ctx
);
663 gen_vertex_arrays(ctx
, n
, arrays
, true, "glCreateVertexArrays");
668 * Determine if ID is the name of an array object.
670 * \param id ID of the potential array object.
671 * \return \c GL_TRUE if \c id is the name of a array object,
672 * \c GL_FALSE otherwise.
675 _mesa_IsVertexArray( GLuint id
)
677 struct gl_vertex_array_object
* obj
;
678 GET_CURRENT_CONTEXT(ctx
);
679 ASSERT_OUTSIDE_BEGIN_END_WITH_RETVAL(ctx
, GL_FALSE
);
684 obj
= _mesa_lookup_vao(ctx
, id
);
688 return obj
->EverBound
;
693 * Sets the element array buffer binding of a vertex array object.
695 * This is the ARB_direct_state_access equivalent of
696 * glBindBuffer(GL_ELEMENT_ARRAY_BUFFER, buffer).
699 _mesa_VertexArrayElementBuffer(GLuint vaobj
, GLuint buffer
)
701 GET_CURRENT_CONTEXT(ctx
);
702 struct gl_vertex_array_object
*vao
;
703 struct gl_buffer_object
*bufObj
;
705 ASSERT_OUTSIDE_BEGIN_END(ctx
);
707 /* The GL_ARB_direct_state_access specification says:
709 * "An INVALID_OPERATION error is generated by VertexArrayElementBuffer
710 * if <vaobj> is not [compatibility profile: zero or] the name of an
711 * existing vertex array object."
713 vao
=_mesa_lookup_vao_err(ctx
, vaobj
, "glVertexArrayElementBuffer");
717 /* The GL_ARB_direct_state_access specification says:
719 * "An INVALID_OPERATION error is generated if <buffer> is not zero or
720 * the name of an existing buffer object."
723 bufObj
= _mesa_lookup_bufferobj_err(ctx
, buffer
,
724 "glVertexArrayElementBuffer");
726 bufObj
= ctx
->Shared
->NullBufferObj
;
729 _mesa_reference_buffer_object(ctx
, &vao
->IndexBufferObj
, bufObj
);
734 _mesa_GetVertexArrayiv(GLuint vaobj
, GLenum pname
, GLint
*param
)
736 GET_CURRENT_CONTEXT(ctx
);
737 struct gl_vertex_array_object
*vao
;
739 ASSERT_OUTSIDE_BEGIN_END(ctx
);
741 /* The GL_ARB_direct_state_access specification says:
743 * "An INVALID_OPERATION error is generated if <vaobj> is not
744 * [compatibility profile: zero or] the name of an existing
745 * vertex array object."
747 vao
=_mesa_lookup_vao_err(ctx
, vaobj
, "glGetVertexArrayiv");
751 /* The GL_ARB_direct_state_access specification says:
753 * "An INVALID_ENUM error is generated if <pname> is not
754 * ELEMENT_ARRAY_BUFFER_BINDING."
756 if (pname
!= GL_ELEMENT_ARRAY_BUFFER_BINDING
) {
757 _mesa_error(ctx
, GL_INVALID_ENUM
,
758 "glGetVertexArrayiv(pname != "
759 "GL_ELEMENT_ARRAY_BUFFER_BINDING)");
763 param
[0] = vao
->IndexBufferObj
->Name
;