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
->BufferBinding
); i
++)
144 _mesa_reference_buffer_object(ctx
, &obj
->BufferBinding
[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
);
178 * Set ptr to vao w/ reference counting.
179 * Note: this should only be called from the _mesa_reference_vao()
183 _mesa_reference_vao_(struct gl_context
*ctx
,
184 struct gl_vertex_array_object
**ptr
,
185 struct gl_vertex_array_object
*vao
)
190 /* Unreference the old array object */
191 GLboolean deleteFlag
= GL_FALSE
;
192 struct gl_vertex_array_object
*oldObj
= *ptr
;
194 assert(oldObj
->RefCount
> 0);
196 deleteFlag
= (oldObj
->RefCount
== 0);
199 _mesa_delete_vao(ctx
, oldObj
);
206 /* reference new array object */
207 assert(vao
->RefCount
> 0);
216 * Initialize attribtes of a vertex array within a vertex array object.
217 * \param vao the container vertex array object
218 * \param index which array in the VAO to initialize
219 * \param size number of components (1, 2, 3 or 4) per attribute
220 * \param type datatype of the attribute (GL_FLOAT, GL_INT, etc).
223 init_array(struct gl_context
*ctx
,
224 struct gl_vertex_array_object
*vao
,
225 GLuint index
, GLint size
, GLint type
)
227 struct gl_array_attributes
*array
= &vao
->VertexAttrib
[index
];
228 struct gl_vertex_buffer_binding
*binding
= &vao
->BufferBinding
[index
];
232 array
->Format
= GL_RGBA
; /* only significant for GL_EXT_vertex_array_bgra */
235 array
->RelativeOffset
= 0;
236 array
->Enabled
= GL_FALSE
;
237 array
->Normalized
= GL_FALSE
;
238 array
->Integer
= GL_FALSE
;
239 array
->Doubles
= GL_FALSE
;
240 array
->_ElementSize
= size
* _mesa_sizeof_type(type
);
241 array
->BufferBindingIndex
= index
;
244 binding
->Stride
= array
->_ElementSize
;
245 binding
->BufferObj
= NULL
;
246 binding
->_BoundArrays
= BITFIELD64_BIT(index
);
248 /* Vertex array buffers */
249 _mesa_reference_buffer_object(ctx
, &binding
->BufferObj
,
250 ctx
->Shared
->NullBufferObj
);
255 * Initialize a gl_vertex_array_object's arrays.
258 _mesa_initialize_vao(struct gl_context
*ctx
,
259 struct gl_vertex_array_object
*vao
,
268 /* Init the individual arrays */
269 for (i
= 0; i
< ARRAY_SIZE(vao
->VertexAttrib
); i
++) {
271 case VERT_ATTRIB_WEIGHT
:
272 init_array(ctx
, vao
, VERT_ATTRIB_WEIGHT
, 1, GL_FLOAT
);
274 case VERT_ATTRIB_NORMAL
:
275 init_array(ctx
, vao
, VERT_ATTRIB_NORMAL
, 3, GL_FLOAT
);
277 case VERT_ATTRIB_COLOR1
:
278 init_array(ctx
, vao
, VERT_ATTRIB_COLOR1
, 3, GL_FLOAT
);
280 case VERT_ATTRIB_FOG
:
281 init_array(ctx
, vao
, VERT_ATTRIB_FOG
, 1, GL_FLOAT
);
283 case VERT_ATTRIB_COLOR_INDEX
:
284 init_array(ctx
, vao
, VERT_ATTRIB_COLOR_INDEX
, 1, GL_FLOAT
);
286 case VERT_ATTRIB_EDGEFLAG
:
287 init_array(ctx
, vao
, VERT_ATTRIB_EDGEFLAG
, 1, GL_BOOL
);
289 case VERT_ATTRIB_POINT_SIZE
:
290 init_array(ctx
, vao
, VERT_ATTRIB_POINT_SIZE
, 1, GL_FLOAT
);
293 init_array(ctx
, vao
, i
, 4, GL_FLOAT
);
298 _mesa_reference_buffer_object(ctx
, &vao
->IndexBufferObj
,
299 ctx
->Shared
->NullBufferObj
);
304 * Add the given array object to the array object pool.
307 save_array_object(struct gl_context
*ctx
, struct gl_vertex_array_object
*vao
)
310 /* insert into hash table */
311 _mesa_HashInsert(ctx
->Array
.Objects
, vao
->Name
, vao
);
317 * Remove the given array object from the array object pool.
318 * Do not deallocate the array object though.
321 remove_array_object(struct gl_context
*ctx
, struct gl_vertex_array_object
*vao
)
324 /* remove from hash table */
325 _mesa_HashRemove(ctx
->Array
.Objects
, vao
->Name
);
331 * Updates the derived gl_vertex_arrays when a gl_vertex_attrib_array
332 * or a gl_vertex_buffer_binding has changed.
335 _mesa_update_vao_client_arrays(struct gl_context
*ctx
,
336 struct gl_vertex_array_object
*vao
)
338 GLbitfield64 arrays
= vao
->NewArrays
;
341 const int attrib
= u_bit_scan64(&arrays
);
342 struct gl_vertex_array
*client_array
= &vao
->_VertexAttrib
[attrib
];
343 const struct gl_array_attributes
*attrib_array
=
344 &vao
->VertexAttrib
[attrib
];
345 const struct gl_vertex_buffer_binding
*buffer_binding
=
346 &vao
->BufferBinding
[attrib_array
->BufferBindingIndex
];
348 _mesa_update_client_array(ctx
, client_array
, attrib_array
,
355 _mesa_all_varyings_in_vbos(const struct gl_vertex_array_object
*vao
)
357 /* Walk those enabled arrays that have the default vbo attached */
358 GLbitfield64 mask
= vao
->_Enabled
& ~vao
->VertexAttribBufferMask
;
361 /* Do not use u_bit_scan64 as we can walk multiple
362 * attrib arrays at once
364 const int i
= ffsll(mask
) - 1;
365 const struct gl_array_attributes
*attrib_array
=
366 &vao
->VertexAttrib
[i
];
367 const struct gl_vertex_buffer_binding
*buffer_binding
=
368 &vao
->BufferBinding
[attrib_array
->BufferBindingIndex
];
370 /* Only enabled arrays shall appear in the _Enabled bitmask */
371 assert(attrib_array
->Enabled
);
372 /* We have already masked out vao->VertexAttribBufferMask */
373 assert(!_mesa_is_bufferobj(buffer_binding
->BufferObj
));
375 /* Bail out once we find the first non vbo with a non zero stride */
376 if (buffer_binding
->Stride
!= 0)
379 /* Note that we cannot use the xor variant since the _BoundArray mask
380 * may contain array attributes that are bound but not enabled.
382 mask
&= ~buffer_binding
->_BoundArrays
;
389 _mesa_all_buffers_are_unmapped(const struct gl_vertex_array_object
*vao
)
391 /* Walk the enabled arrays that have a vbo attached */
392 GLbitfield64 mask
= vao
->_Enabled
& vao
->VertexAttribBufferMask
;
395 const int i
= ffsll(mask
) - 1;
396 const struct gl_array_attributes
*attrib_array
=
397 &vao
->VertexAttrib
[i
];
398 const struct gl_vertex_buffer_binding
*buffer_binding
=
399 &vao
->BufferBinding
[attrib_array
->BufferBindingIndex
];
401 /* Only enabled arrays shall appear in the _Enabled bitmask */
402 assert(attrib_array
->Enabled
);
403 /* We have already masked with vao->VertexAttribBufferMask */
404 assert(_mesa_is_bufferobj(buffer_binding
->BufferObj
));
406 /* Bail out once we find the first disallowed mapping */
407 if (_mesa_check_disallowed_mapping(buffer_binding
->BufferObj
))
410 /* We have handled everything that is bound to this buffer_binding. */
411 mask
&= ~buffer_binding
->_BoundArrays
;
417 /**********************************************************************/
419 /**********************************************************************/
423 * Helper for _mesa_BindVertexArray() and _mesa_BindVertexArrayAPPLE().
424 * \param genRequired specifies behavour when id was not generated with
425 * glGenVertexArrays().
428 bind_vertex_array(struct gl_context
*ctx
, GLuint id
, GLboolean genRequired
)
430 struct gl_vertex_array_object
* const oldObj
= ctx
->Array
.VAO
;
431 struct gl_vertex_array_object
*newObj
= NULL
;
433 assert(oldObj
!= NULL
);
435 if ( oldObj
->Name
== id
)
436 return; /* rebinding the same array object- no change */
439 * Get pointer to new array object (newObj)
442 /* The spec says there is no array object named 0, but we use
443 * one internally because it simplifies things.
445 newObj
= ctx
->Array
.DefaultVAO
;
448 /* non-default array object */
449 newObj
= _mesa_lookup_vao(ctx
, id
);
452 _mesa_error(ctx
, GL_INVALID_OPERATION
,
453 "glBindVertexArray(non-gen name)");
457 /* For APPLE version, generate a new array object now */
458 newObj
= _mesa_new_vao(ctx
, id
);
460 _mesa_error(ctx
, GL_OUT_OF_MEMORY
, "glBindVertexArrayAPPLE");
464 save_array_object(ctx
, newObj
);
467 if (!newObj
->EverBound
) {
468 /* The "Interactions with APPLE_vertex_array_object" section of the
469 * GL_ARB_vertex_array_object spec says:
471 * "The first bind call, either BindVertexArray or
472 * BindVertexArrayAPPLE, determines the semantic of the object."
474 newObj
->ARBsemantics
= genRequired
;
475 newObj
->EverBound
= GL_TRUE
;
479 if (ctx
->Array
.DrawMethod
== DRAW_ARRAYS
) {
480 /* The _DrawArrays pointer is pointing at the VAO being unbound and
481 * that VAO may be in the process of being deleted. If it's not going
482 * to be deleted, this will have no effect, because the pointer needs
483 * to be updated by the VBO module anyway.
485 * Before the VBO module can update the pointer, we have to set it
486 * to NULL for drivers not to set up arrays which are not bound,
487 * or to prevent a crash if the VAO being unbound is going to be
490 ctx
->Array
._DrawArrays
= NULL
;
491 ctx
->Array
.DrawMethod
= DRAW_NONE
;
494 ctx
->NewState
|= _NEW_ARRAY
;
495 _mesa_reference_vao(ctx
, &ctx
->Array
.VAO
, newObj
);
500 * ARB version of glBindVertexArray()
501 * This function behaves differently from glBindVertexArrayAPPLE() in
502 * that this function requires all ids to have been previously generated
503 * by glGenVertexArrays[APPLE]().
506 _mesa_BindVertexArray( GLuint id
)
508 GET_CURRENT_CONTEXT(ctx
);
509 bind_vertex_array(ctx
, id
, GL_TRUE
);
517 * The binding could be done more efficiently by comparing the non-NULL
518 * pointers in the old and new objects. The only arrays that are "dirty" are
519 * the ones that are non-NULL in either object.
522 _mesa_BindVertexArrayAPPLE( GLuint id
)
524 GET_CURRENT_CONTEXT(ctx
);
525 bind_vertex_array(ctx
, id
, GL_FALSE
);
530 * Delete a set of array objects.
532 * \param n Number of array objects to delete.
533 * \param ids Array of \c n array object IDs.
536 _mesa_DeleteVertexArrays(GLsizei n
, const GLuint
*ids
)
538 GET_CURRENT_CONTEXT(ctx
);
542 _mesa_error(ctx
, GL_INVALID_VALUE
, "glDeleteVertexArray(n)");
546 for (i
= 0; i
< n
; i
++) {
547 struct gl_vertex_array_object
*obj
= _mesa_lookup_vao(ctx
, ids
[i
]);
550 assert( obj
->Name
== ids
[i
] );
552 /* If the array object is currently bound, the spec says "the binding
553 * for that object reverts to zero and the default vertex array
556 if ( obj
== ctx
->Array
.VAO
) {
557 _mesa_BindVertexArray(0);
560 /* The ID is immediately freed for re-use */
561 remove_array_object(ctx
, obj
);
563 if (ctx
->Array
.LastLookedUpVAO
== obj
)
564 _mesa_reference_vao(ctx
, &ctx
->Array
.LastLookedUpVAO
, NULL
);
566 /* Unreference the array object.
567 * If refcount hits zero, the object will be deleted.
569 _mesa_reference_vao(ctx
, &obj
, NULL
);
576 * Generate a set of unique array object IDs and store them in \c arrays.
577 * Helper for _mesa_GenVertexArrays[APPLE]() and _mesa_CreateVertexArrays()
580 * \param n Number of IDs to generate.
581 * \param arrays Array of \c n locations to store the IDs.
582 * \param create Indicates that the objects should also be created.
583 * \param func The name of the GL entry point.
586 gen_vertex_arrays(struct gl_context
*ctx
, GLsizei n
, GLuint
*arrays
,
587 bool create
, const char *func
)
593 _mesa_error(ctx
, GL_INVALID_VALUE
, "%s(n < 0)", func
);
601 first
= _mesa_HashFindFreeKeyBlock(ctx
->Array
.Objects
, n
);
603 /* For the sake of simplicity we create the array objects in both
604 * the Gen* and Create* cases. The only difference is the value of
605 * EverBound, which is set to true in the Create* case.
607 for (i
= 0; i
< n
; i
++) {
608 struct gl_vertex_array_object
*obj
;
609 GLuint name
= first
+ i
;
611 obj
= _mesa_new_vao(ctx
, name
);
613 _mesa_error(ctx
, GL_OUT_OF_MEMORY
, "%s", func
);
616 obj
->EverBound
= create
;
617 save_array_object(ctx
, obj
);
618 arrays
[i
] = first
+ i
;
624 * ARB version of glGenVertexArrays()
625 * All arrays will be required to live in VBOs.
628 _mesa_GenVertexArrays(GLsizei n
, GLuint
*arrays
)
630 GET_CURRENT_CONTEXT(ctx
);
631 gen_vertex_arrays(ctx
, n
, arrays
, false, "glGenVertexArrays");
636 * APPLE version of glGenVertexArraysAPPLE()
637 * Arrays may live in VBOs or ordinary memory.
640 _mesa_GenVertexArraysAPPLE(GLsizei n
, GLuint
*arrays
)
642 GET_CURRENT_CONTEXT(ctx
);
643 gen_vertex_arrays(ctx
, n
, arrays
, false, "glGenVertexArraysAPPLE");
648 * ARB_direct_state_access
649 * Generates ID's and creates the array objects.
652 _mesa_CreateVertexArrays(GLsizei n
, GLuint
*arrays
)
654 GET_CURRENT_CONTEXT(ctx
);
655 gen_vertex_arrays(ctx
, n
, arrays
, true, "glCreateVertexArrays");
660 * Determine if ID is the name of an array object.
662 * \param id ID of the potential array object.
663 * \return \c GL_TRUE if \c id is the name of a array object,
664 * \c GL_FALSE otherwise.
667 _mesa_IsVertexArray( GLuint id
)
669 struct gl_vertex_array_object
* obj
;
670 GET_CURRENT_CONTEXT(ctx
);
671 ASSERT_OUTSIDE_BEGIN_END_WITH_RETVAL(ctx
, GL_FALSE
);
676 obj
= _mesa_lookup_vao(ctx
, id
);
680 return obj
->EverBound
;
685 * Sets the element array buffer binding of a vertex array object.
687 * This is the ARB_direct_state_access equivalent of
688 * glBindBuffer(GL_ELEMENT_ARRAY_BUFFER, buffer).
691 _mesa_VertexArrayElementBuffer(GLuint vaobj
, GLuint buffer
)
693 GET_CURRENT_CONTEXT(ctx
);
694 struct gl_vertex_array_object
*vao
;
695 struct gl_buffer_object
*bufObj
;
697 ASSERT_OUTSIDE_BEGIN_END(ctx
);
699 /* The GL_ARB_direct_state_access specification says:
701 * "An INVALID_OPERATION error is generated by VertexArrayElementBuffer
702 * if <vaobj> is not [compatibility profile: zero or] the name of an
703 * existing vertex array object."
705 vao
=_mesa_lookup_vao_err(ctx
, vaobj
, "glVertexArrayElementBuffer");
709 /* The GL_ARB_direct_state_access specification says:
711 * "An INVALID_OPERATION error is generated if <buffer> is not zero or
712 * the name of an existing buffer object."
715 bufObj
= _mesa_lookup_bufferobj_err(ctx
, buffer
,
716 "glVertexArrayElementBuffer");
718 bufObj
= ctx
->Shared
->NullBufferObj
;
721 _mesa_reference_buffer_object(ctx
, &vao
->IndexBufferObj
, bufObj
);
726 _mesa_GetVertexArrayiv(GLuint vaobj
, GLenum pname
, GLint
*param
)
728 GET_CURRENT_CONTEXT(ctx
);
729 struct gl_vertex_array_object
*vao
;
731 ASSERT_OUTSIDE_BEGIN_END(ctx
);
733 /* The GL_ARB_direct_state_access specification says:
735 * "An INVALID_OPERATION error is generated if <vaobj> is not
736 * [compatibility profile: zero or] the name of an existing
737 * vertex array object."
739 vao
=_mesa_lookup_vao_err(ctx
, vaobj
, "glGetVertexArrayiv");
743 /* The GL_ARB_direct_state_access specification says:
745 * "An INVALID_ENUM error is generated if <pname> is not
746 * ELEMENT_ARRAY_BUFFER_BINDING."
748 if (pname
!= GL_ELEMENT_ARRAY_BUFFER_BINDING
) {
749 _mesa_error(ctx
, GL_INVALID_ENUM
,
750 "glGetVertexArrayiv(pname != "
751 "GL_ELEMENT_ARRAY_BUFFER_BINDING)");
755 param
[0] = vao
->IndexBufferObj
->Name
;