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"
58 * Look up the array object for the given ID.
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
66 struct gl_vertex_array_object
*
67 _mesa_lookup_vao(struct gl_context
*ctx
, GLuint id
)
72 return (struct gl_vertex_array_object
*)
73 _mesa_HashLookup(ctx
->Array
.Objects
, id
);
78 * Looks up the array object for the given ID.
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.
84 struct gl_vertex_array_object
*
85 _mesa_lookup_vao_err(struct gl_context
*ctx
, GLuint id
, const char *caller
)
87 /* The ARB_direct_state_access specification says:
89 * "<vaobj> is [compatibility profile:
90 * zero, indicating the default vertex array object, or]
91 * the name of the vertex array object."
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 "
101 return ctx
->Array
.DefaultVAO
;
103 struct gl_vertex_array_object
*vao
;
105 if (ctx
->Array
.LastLookedUpVAO
&&
106 ctx
->Array
.LastLookedUpVAO
->Name
== id
) {
107 vao
= ctx
->Array
.LastLookedUpVAO
;
109 vao
= (struct gl_vertex_array_object
*)
110 _mesa_HashLookup(ctx
->Array
.Objects
, id
);
112 /* The ARB_direct_state_access specification says:
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."
118 if (!vao
|| !vao
->EverBound
) {
119 _mesa_error(ctx
, GL_INVALID_OPERATION
,
120 "%s(non-existent vaobj=%u)", caller
, id
);
124 _mesa_reference_vao(ctx
, &ctx
->Array
.LastLookedUpVAO
, vao
);
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.
138 unbind_array_object_vbos(struct gl_context
*ctx
, struct gl_vertex_array_object
*obj
)
142 for (i
= 0; i
< ARRAY_SIZE(obj
->VertexBinding
); i
++)
143 _mesa_reference_buffer_object(ctx
, &obj
->VertexBinding
[i
].BufferObj
, NULL
);
145 for (i
= 0; i
< ARRAY_SIZE(obj
->_VertexAttrib
); i
++)
146 _mesa_reference_buffer_object(ctx
, &obj
->_VertexAttrib
[i
].BufferObj
, NULL
);
151 * Allocate and initialize a new vertex array object.
153 * This function is intended to be called via
154 * \c dd_function_table::NewArrayObject.
156 struct gl_vertex_array_object
*
157 _mesa_new_vao(struct gl_context
*ctx
, GLuint name
)
159 struct gl_vertex_array_object
*obj
= CALLOC_STRUCT(gl_vertex_array_object
);
161 _mesa_initialize_vao(ctx
, obj
, name
);
167 * Delete an array object.
169 * This function is intended to be called via
170 * \c dd_function_table::DeleteArrayObject.
173 _mesa_delete_vao(struct gl_context
*ctx
, struct gl_vertex_array_object
*obj
)
175 unbind_array_object_vbos(ctx
, obj
);
176 _mesa_reference_buffer_object(ctx
, &obj
->IndexBufferObj
, NULL
);
177 mtx_destroy(&obj
->Mutex
);
184 * Set ptr to vao w/ reference counting.
185 * Note: this should only be called from the _mesa_reference_vao()
189 _mesa_reference_vao_(struct gl_context
*ctx
,
190 struct gl_vertex_array_object
**ptr
,
191 struct gl_vertex_array_object
*vao
)
196 /* Unreference the old array object */
197 GLboolean deleteFlag
= GL_FALSE
;
198 struct gl_vertex_array_object
*oldObj
= *ptr
;
200 mtx_lock(&oldObj
->Mutex
);
201 assert(oldObj
->RefCount
> 0);
203 deleteFlag
= (oldObj
->RefCount
== 0);
204 mtx_unlock(&oldObj
->Mutex
);
207 assert(ctx
->Driver
.DeleteArrayObject
);
208 ctx
->Driver
.DeleteArrayObject(ctx
, oldObj
);
216 /* reference new array object */
217 mtx_lock(&vao
->Mutex
);
218 if (vao
->RefCount
== 0) {
219 /* this array's being deleted (look just above) */
220 /* Not sure this can every really happen. Warn if it does. */
221 _mesa_problem(NULL
, "referencing deleted array object");
228 mtx_unlock(&vao
->Mutex
);
235 init_array(struct gl_context
*ctx
,
236 struct gl_vertex_array_object
*obj
, GLuint index
, GLint size
, GLint type
)
238 struct gl_vertex_attrib_array
*array
= &obj
->VertexAttrib
[index
];
239 struct gl_vertex_buffer_binding
*binding
= &obj
->VertexBinding
[index
];
243 array
->Format
= GL_RGBA
; /* only significant for GL_EXT_vertex_array_bgra */
246 array
->RelativeOffset
= 0;
247 array
->Enabled
= GL_FALSE
;
248 array
->Normalized
= GL_FALSE
;
249 array
->Integer
= GL_FALSE
;
250 array
->Doubles
= GL_FALSE
;
251 array
->_ElementSize
= size
* _mesa_sizeof_type(type
);
252 array
->VertexBinding
= index
;
255 binding
->Stride
= array
->_ElementSize
;
256 binding
->BufferObj
= NULL
;
257 binding
->_BoundArrays
= BITFIELD64_BIT(index
);
259 /* Vertex array buffers */
260 _mesa_reference_buffer_object(ctx
, &binding
->BufferObj
,
261 ctx
->Shared
->NullBufferObj
);
266 * Initialize a gl_vertex_array_object's arrays.
269 _mesa_initialize_vao(struct gl_context
*ctx
,
270 struct gl_vertex_array_object
*obj
,
277 mtx_init(&obj
->Mutex
, mtx_plain
);
280 /* Init the individual arrays */
281 for (i
= 0; i
< ARRAY_SIZE(obj
->VertexAttrib
); i
++) {
283 case VERT_ATTRIB_WEIGHT
:
284 init_array(ctx
, obj
, VERT_ATTRIB_WEIGHT
, 1, GL_FLOAT
);
286 case VERT_ATTRIB_NORMAL
:
287 init_array(ctx
, obj
, VERT_ATTRIB_NORMAL
, 3, GL_FLOAT
);
289 case VERT_ATTRIB_COLOR1
:
290 init_array(ctx
, obj
, VERT_ATTRIB_COLOR1
, 3, GL_FLOAT
);
292 case VERT_ATTRIB_FOG
:
293 init_array(ctx
, obj
, VERT_ATTRIB_FOG
, 1, GL_FLOAT
);
295 case VERT_ATTRIB_COLOR_INDEX
:
296 init_array(ctx
, obj
, VERT_ATTRIB_COLOR_INDEX
, 1, GL_FLOAT
);
298 case VERT_ATTRIB_EDGEFLAG
:
299 init_array(ctx
, obj
, VERT_ATTRIB_EDGEFLAG
, 1, GL_BOOL
);
301 case VERT_ATTRIB_POINT_SIZE
:
302 init_array(ctx
, obj
, VERT_ATTRIB_POINT_SIZE
, 1, GL_FLOAT
);
305 init_array(ctx
, obj
, i
, 4, GL_FLOAT
);
310 _mesa_reference_buffer_object(ctx
, &obj
->IndexBufferObj
,
311 ctx
->Shared
->NullBufferObj
);
316 * Add the given array object to the array object pool.
319 save_array_object( struct gl_context
*ctx
, struct gl_vertex_array_object
*obj
)
322 /* insert into hash table */
323 _mesa_HashInsert(ctx
->Array
.Objects
, obj
->Name
, obj
);
329 * Remove the given array object from the array object pool.
330 * Do not deallocate the array object though.
333 remove_array_object( struct gl_context
*ctx
, struct gl_vertex_array_object
*obj
)
336 /* remove from hash table */
337 _mesa_HashRemove(ctx
->Array
.Objects
, obj
->Name
);
343 * Updates the derived gl_client_arrays when a gl_vertex_attrib_array
344 * or a gl_vertex_buffer_binding has changed.
347 _mesa_update_vao_client_arrays(struct gl_context
*ctx
,
348 struct gl_vertex_array_object
*vao
)
350 GLbitfield64 arrays
= vao
->NewArrays
;
353 struct gl_client_array
*client_array
;
354 struct gl_vertex_attrib_array
*attrib_array
;
355 struct gl_vertex_buffer_binding
*buffer_binding
;
357 GLint attrib
= ffsll(arrays
) - 1;
358 arrays
^= BITFIELD64_BIT(attrib
);
360 attrib_array
= &vao
->VertexAttrib
[attrib
];
361 buffer_binding
= &vao
->VertexBinding
[attrib_array
->VertexBinding
];
362 client_array
= &vao
->_VertexAttrib
[attrib
];
364 _mesa_update_client_array(ctx
, client_array
, attrib_array
,
370 /**********************************************************************/
372 /**********************************************************************/
376 * Helper for _mesa_BindVertexArray() and _mesa_BindVertexArrayAPPLE().
377 * \param genRequired specifies behavour when id was not generated with
378 * glGenVertexArrays().
381 bind_vertex_array(struct gl_context
*ctx
, GLuint id
, GLboolean genRequired
)
383 struct gl_vertex_array_object
* const oldObj
= ctx
->Array
.VAO
;
384 struct gl_vertex_array_object
*newObj
= NULL
;
386 assert(oldObj
!= NULL
);
388 if ( oldObj
->Name
== id
)
389 return; /* rebinding the same array object- no change */
392 * Get pointer to new array object (newObj)
395 /* The spec says there is no array object named 0, but we use
396 * one internally because it simplifies things.
398 newObj
= ctx
->Array
.DefaultVAO
;
401 /* non-default array object */
402 newObj
= _mesa_lookup_vao(ctx
, id
);
405 _mesa_error(ctx
, GL_INVALID_OPERATION
,
406 "glBindVertexArray(non-gen name)");
410 /* For APPLE version, generate a new array object now */
411 newObj
= (*ctx
->Driver
.NewArrayObject
)(ctx
, id
);
413 _mesa_error(ctx
, GL_OUT_OF_MEMORY
, "glBindVertexArrayAPPLE");
417 save_array_object(ctx
, newObj
);
420 if (!newObj
->EverBound
) {
421 /* The "Interactions with APPLE_vertex_array_object" section of the
422 * GL_ARB_vertex_array_object spec says:
424 * "The first bind call, either BindVertexArray or
425 * BindVertexArrayAPPLE, determines the semantic of the object."
427 newObj
->ARBsemantics
= genRequired
;
428 newObj
->EverBound
= GL_TRUE
;
432 if (ctx
->Array
.DrawMethod
== DRAW_ARRAYS
) {
433 /* The _DrawArrays pointer is pointing at the VAO being unbound and
434 * that VAO may be in the process of being deleted. If it's not going
435 * to be deleted, this will have no effect, because the pointer needs
436 * to be updated by the VBO module anyway.
438 * Before the VBO module can update the pointer, we have to set it
439 * to NULL for drivers not to set up arrays which are not bound,
440 * or to prevent a crash if the VAO being unbound is going to be
443 ctx
->Array
._DrawArrays
= NULL
;
444 ctx
->Array
.DrawMethod
= DRAW_NONE
;
447 ctx
->NewState
|= _NEW_ARRAY
;
448 _mesa_reference_vao(ctx
, &ctx
->Array
.VAO
, newObj
);
450 /* Pass BindVertexArray call to device driver */
451 if (ctx
->Driver
.BindArrayObject
&& newObj
)
452 ctx
->Driver
.BindArrayObject(ctx
, newObj
);
457 * ARB version of glBindVertexArray()
458 * This function behaves differently from glBindVertexArrayAPPLE() in
459 * that this function requires all ids to have been previously generated
460 * by glGenVertexArrays[APPLE]().
463 _mesa_BindVertexArray( GLuint id
)
465 GET_CURRENT_CONTEXT(ctx
);
466 bind_vertex_array(ctx
, id
, GL_TRUE
);
474 * The binding could be done more efficiently by comparing the non-NULL
475 * pointers in the old and new objects. The only arrays that are "dirty" are
476 * the ones that are non-NULL in either object.
479 _mesa_BindVertexArrayAPPLE( GLuint id
)
481 GET_CURRENT_CONTEXT(ctx
);
482 bind_vertex_array(ctx
, id
, GL_FALSE
);
487 * Delete a set of array objects.
489 * \param n Number of array objects to delete.
490 * \param ids Array of \c n array object IDs.
493 _mesa_DeleteVertexArrays(GLsizei n
, const GLuint
*ids
)
495 GET_CURRENT_CONTEXT(ctx
);
499 _mesa_error(ctx
, GL_INVALID_VALUE
, "glDeleteVertexArray(n)");
503 for (i
= 0; i
< n
; i
++) {
504 struct gl_vertex_array_object
*obj
= _mesa_lookup_vao(ctx
, ids
[i
]);
507 assert( obj
->Name
== ids
[i
] );
509 /* If the array object is currently bound, the spec says "the binding
510 * for that object reverts to zero and the default vertex array
513 if ( obj
== ctx
->Array
.VAO
) {
514 _mesa_BindVertexArray(0);
517 /* The ID is immediately freed for re-use */
518 remove_array_object(ctx
, obj
);
520 if (ctx
->Array
.LastLookedUpVAO
== obj
)
521 _mesa_reference_vao(ctx
, &ctx
->Array
.LastLookedUpVAO
, NULL
);
523 /* Unreference the array object.
524 * If refcount hits zero, the object will be deleted.
526 _mesa_reference_vao(ctx
, &obj
, NULL
);
533 * Generate a set of unique array object IDs and store them in \c arrays.
534 * Helper for _mesa_GenVertexArrays[APPLE]() and _mesa_CreateVertexArrays()
537 * \param n Number of IDs to generate.
538 * \param arrays Array of \c n locations to store the IDs.
539 * \param create Indicates that the objects should also be created.
540 * \param func The name of the GL entry point.
543 gen_vertex_arrays(struct gl_context
*ctx
, GLsizei n
, GLuint
*arrays
,
544 bool create
, const char *func
)
550 _mesa_error(ctx
, GL_INVALID_VALUE
, "%s(n < 0)", func
);
558 first
= _mesa_HashFindFreeKeyBlock(ctx
->Array
.Objects
, n
);
560 /* For the sake of simplicity we create the array objects in both
561 * the Gen* and Create* cases. The only difference is the value of
562 * EverBound, which is set to true in the Create* case.
564 for (i
= 0; i
< n
; i
++) {
565 struct gl_vertex_array_object
*obj
;
566 GLuint name
= first
+ i
;
568 obj
= (*ctx
->Driver
.NewArrayObject
)( ctx
, name
);
570 _mesa_error(ctx
, GL_OUT_OF_MEMORY
, "%s", func
);
573 obj
->EverBound
= create
;
574 save_array_object(ctx
, obj
);
575 arrays
[i
] = first
+ i
;
581 * ARB version of glGenVertexArrays()
582 * All arrays will be required to live in VBOs.
585 _mesa_GenVertexArrays(GLsizei n
, GLuint
*arrays
)
587 GET_CURRENT_CONTEXT(ctx
);
588 gen_vertex_arrays(ctx
, n
, arrays
, false, "glGenVertexArrays");
593 * APPLE version of glGenVertexArraysAPPLE()
594 * Arrays may live in VBOs or ordinary memory.
597 _mesa_GenVertexArraysAPPLE(GLsizei n
, GLuint
*arrays
)
599 GET_CURRENT_CONTEXT(ctx
);
600 gen_vertex_arrays(ctx
, n
, arrays
, false, "glGenVertexArraysAPPLE");
605 * ARB_direct_state_access
606 * Generates ID's and creates the array objects.
609 _mesa_CreateVertexArrays(GLsizei n
, GLuint
*arrays
)
611 GET_CURRENT_CONTEXT(ctx
);
612 gen_vertex_arrays(ctx
, n
, arrays
, true, "glCreateVertexArrays");
617 * Determine if ID is the name of an array object.
619 * \param id ID of the potential array object.
620 * \return \c GL_TRUE if \c id is the name of a array object,
621 * \c GL_FALSE otherwise.
624 _mesa_IsVertexArray( GLuint id
)
626 struct gl_vertex_array_object
* obj
;
627 GET_CURRENT_CONTEXT(ctx
);
628 ASSERT_OUTSIDE_BEGIN_END_WITH_RETVAL(ctx
, GL_FALSE
);
633 obj
= _mesa_lookup_vao(ctx
, id
);
637 return obj
->EverBound
;
642 * Sets the element array buffer binding of a vertex array object.
644 * This is the ARB_direct_state_access equivalent of
645 * glBindBuffer(GL_ELEMENT_ARRAY_BUFFER, buffer).
648 _mesa_VertexArrayElementBuffer(GLuint vaobj
, GLuint buffer
)
650 GET_CURRENT_CONTEXT(ctx
);
651 struct gl_vertex_array_object
*vao
;
652 struct gl_buffer_object
*bufObj
;
654 ASSERT_OUTSIDE_BEGIN_END(ctx
);
656 /* The GL_ARB_direct_state_access specification says:
658 * "An INVALID_OPERATION error is generated by VertexArrayElementBuffer
659 * if <vaobj> is not [compatibility profile: zero or] the name of an
660 * existing vertex array object."
662 vao
=_mesa_lookup_vao_err(ctx
, vaobj
, "glVertexArrayElementBuffer");
666 /* The GL_ARB_direct_state_access specification says:
668 * "An INVALID_OPERATION error is generated if <buffer> is not zero or
669 * the name of an existing buffer object."
672 bufObj
= _mesa_lookup_bufferobj_err(ctx
, buffer
,
673 "glVertexArrayElementBuffer");
675 bufObj
= ctx
->Shared
->NullBufferObj
;
678 _mesa_reference_buffer_object(ctx
, &vao
->IndexBufferObj
, bufObj
);
683 _mesa_GetVertexArrayiv(GLuint vaobj
, GLenum pname
, GLint
*param
)
685 GET_CURRENT_CONTEXT(ctx
);
686 struct gl_vertex_array_object
*vao
;
688 ASSERT_OUTSIDE_BEGIN_END(ctx
);
690 /* The GL_ARB_direct_state_access specification says:
692 * "An INVALID_OPERATION error is generated if <vaobj> is not
693 * [compatibility profile: zero or] the name of an existing
694 * vertex array object."
696 vao
=_mesa_lookup_vao_err(ctx
, vaobj
, "glGetVertexArrayiv");
700 /* The GL_ARB_direct_state_access specification says:
702 * "An INVALID_ENUM error is generated if <pname> is not
703 * ELEMENT_ARRAY_BUFFER_BINDING."
705 if (pname
!= GL_ELEMENT_ARRAY_BUFFER_BINDING
) {
706 _mesa_error(ctx
, GL_INVALID_ENUM
,
707 "glGetVertexArrayiv(pname != "
708 "GL_ELEMENT_ARRAY_BUFFER_BINDING)");
712 param
[0] = vao
->IndexBufferObj
->Name
;