2 * Mesa 3-D graphics library
5 * Copyright (C) 1999-2008 Brian Paul All Rights Reserved.
6 * (C) Copyright IBM Corporation 2006
7 * Copyright (C) 2009 VMware, Inc. All Rights Reserved.
9 * Permission is hereby granted, free of charge, to any person obtaining a
10 * copy of this software and associated documentation files (the "Software"),
11 * to deal in the Software without restriction, including without limitation
12 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
13 * and/or sell copies of the Software, and to permit persons to whom the
14 * Software is furnished to do so, subject to the following conditions:
16 * The above copyright notice and this permission notice shall be included
17 * in all copies or substantial portions of the Software.
19 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
20 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
22 * BRIAN PAUL OR IBM BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
23 * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF
24 * OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
31 * Functions for the GL_APPLE_vertex_array_object extension.
34 * The code in this file borrows a lot from bufferobj.c. There's a certain
35 * amount of cruft left over from that origin that may be unnecessary.
37 * \author Ian Romanick <idr@us.ibm.com>
47 #include "mfeatures.h"
48 #include "bufferobj.h"
53 #include "main/dispatch.h"
57 * Look up the array object for the given ID.
60 * Either a pointer to the array object with the specified ID or \c NULL for
61 * a non-existent ID. The spec defines ID 0 as being technically
65 static inline struct gl_array_object
*
66 lookup_arrayobj(struct gl_context
*ctx
, GLuint id
)
71 return (struct gl_array_object
*)
72 _mesa_HashLookup(ctx
->Array
.Objects
, id
);
77 * For all the vertex arrays in the array object, unbind any pointers
78 * to any buffer objects (VBOs).
79 * This is done just prior to array object destruction.
82 unbind_array_object_vbos(struct gl_context
*ctx
, struct gl_array_object
*obj
)
86 for (i
= 0; i
< Elements(obj
->VertexAttrib
); i
++)
87 _mesa_reference_buffer_object(ctx
, &obj
->VertexAttrib
[i
].BufferObj
, NULL
);
92 * Allocate and initialize a new vertex array object.
94 * This function is intended to be called via
95 * \c dd_function_table::NewArrayObject.
97 struct gl_array_object
*
98 _mesa_new_array_object( struct gl_context
*ctx
, GLuint name
)
100 struct gl_array_object
*obj
= CALLOC_STRUCT(gl_array_object
);
102 _mesa_initialize_array_object(ctx
, obj
, name
);
108 * Delete an array object.
110 * This function is intended to be called via
111 * \c dd_function_table::DeleteArrayObject.
114 _mesa_delete_array_object( struct gl_context
*ctx
, struct gl_array_object
*obj
)
117 unbind_array_object_vbos(ctx
, obj
);
118 _mesa_reference_buffer_object(ctx
, &obj
->ElementArrayBufferObj
, NULL
);
119 _glthread_DESTROY_MUTEX(obj
->Mutex
);
125 * Set ptr to arrayObj w/ reference counting.
126 * Note: this should only be called from the _mesa_reference_array_object()
130 _mesa_reference_array_object_(struct gl_context
*ctx
,
131 struct gl_array_object
**ptr
,
132 struct gl_array_object
*arrayObj
)
134 assert(*ptr
!= arrayObj
);
137 /* Unreference the old array object */
138 GLboolean deleteFlag
= GL_FALSE
;
139 struct gl_array_object
*oldObj
= *ptr
;
141 _glthread_LOCK_MUTEX(oldObj
->Mutex
);
142 ASSERT(oldObj
->RefCount
> 0);
145 printf("ArrayObj %p %d DECR to %d\n",
146 (void *) oldObj
, oldObj
->Name
, oldObj
->RefCount
);
148 deleteFlag
= (oldObj
->RefCount
== 0);
149 _glthread_UNLOCK_MUTEX(oldObj
->Mutex
);
152 ASSERT(ctx
->Driver
.DeleteArrayObject
);
153 ctx
->Driver
.DeleteArrayObject(ctx
, oldObj
);
161 /* reference new array object */
162 _glthread_LOCK_MUTEX(arrayObj
->Mutex
);
163 if (arrayObj
->RefCount
== 0) {
164 /* this array's being deleted (look just above) */
165 /* Not sure this can every really happen. Warn if it does. */
166 _mesa_problem(NULL
, "referencing deleted array object");
170 arrayObj
->RefCount
++;
172 printf("ArrayObj %p %d INCR to %d\n",
173 (void *) arrayObj
, arrayObj
->Name
, arrayObj
->RefCount
);
177 _glthread_UNLOCK_MUTEX(arrayObj
->Mutex
);
184 init_array(struct gl_context
*ctx
,
185 struct gl_client_array
*array
, GLint size
, GLint type
)
189 array
->Format
= GL_RGBA
; /* only significant for GL_EXT_vertex_array_bgra */
193 array
->Enabled
= GL_FALSE
;
194 array
->Normalized
= GL_FALSE
;
195 array
->Integer
= GL_FALSE
;
196 array
->_ElementSize
= size
* _mesa_sizeof_type(type
);
197 /* Vertex array buffers */
198 _mesa_reference_buffer_object(ctx
, &array
->BufferObj
,
199 ctx
->Shared
->NullBufferObj
);
204 * Initialize a gl_array_object's arrays.
207 _mesa_initialize_array_object( struct gl_context
*ctx
,
208 struct gl_array_object
*obj
,
215 _glthread_INIT_MUTEX(obj
->Mutex
);
218 /* Init the individual arrays */
219 for (i
= 0; i
< Elements(obj
->VertexAttrib
); i
++) {
221 case VERT_ATTRIB_WEIGHT
:
222 init_array(ctx
, &obj
->VertexAttrib
[VERT_ATTRIB_WEIGHT
], 1, GL_FLOAT
);
224 case VERT_ATTRIB_NORMAL
:
225 init_array(ctx
, &obj
->VertexAttrib
[VERT_ATTRIB_NORMAL
], 3, GL_FLOAT
);
227 case VERT_ATTRIB_COLOR1
:
228 init_array(ctx
, &obj
->VertexAttrib
[VERT_ATTRIB_COLOR1
], 3, GL_FLOAT
);
230 case VERT_ATTRIB_FOG
:
231 init_array(ctx
, &obj
->VertexAttrib
[VERT_ATTRIB_FOG
], 1, GL_FLOAT
);
233 case VERT_ATTRIB_COLOR_INDEX
:
234 init_array(ctx
, &obj
->VertexAttrib
[VERT_ATTRIB_COLOR_INDEX
], 1, GL_FLOAT
);
236 case VERT_ATTRIB_EDGEFLAG
:
237 init_array(ctx
, &obj
->VertexAttrib
[VERT_ATTRIB_EDGEFLAG
], 1, GL_BOOL
);
239 case VERT_ATTRIB_POINT_SIZE
:
240 init_array(ctx
, &obj
->VertexAttrib
[VERT_ATTRIB_POINT_SIZE
], 1, GL_FLOAT
);
243 init_array(ctx
, &obj
->VertexAttrib
[i
], 4, GL_FLOAT
);
248 _mesa_reference_buffer_object(ctx
, &obj
->ElementArrayBufferObj
,
249 ctx
->Shared
->NullBufferObj
);
254 * Add the given array object to the array object pool.
257 save_array_object( struct gl_context
*ctx
, struct gl_array_object
*obj
)
260 /* insert into hash table */
261 _mesa_HashInsert(ctx
->Array
.Objects
, obj
->Name
, obj
);
267 * Remove the given array object from the array object pool.
268 * Do not deallocate the array object though.
271 remove_array_object( struct gl_context
*ctx
, struct gl_array_object
*obj
)
274 /* remove from hash table */
275 _mesa_HashRemove(ctx
->Array
.Objects
, obj
->Name
);
282 * Helper for _mesa_update_array_object_max_element().
283 * \return min(arrayObj->VertexAttrib[*]._MaxElement).
286 compute_max_element(struct gl_array_object
*arrayObj
, GLbitfield64 enabled
)
288 GLuint min
= ~((GLuint
)0);
291 struct gl_client_array
*client_array
;
292 GLint attrib
= ffsll(enabled
) - 1;
293 enabled
^= BITFIELD64_BIT(attrib
);
295 client_array
= &arrayObj
->VertexAttrib
[attrib
];
296 assert(client_array
->Enabled
);
297 _mesa_update_array_max_element(client_array
);
298 min
= MIN2(min
, client_array
->_MaxElement
);
306 * Examine vertex arrays to update the gl_array_object::_MaxElement field.
309 _mesa_update_array_object_max_element(struct gl_context
*ctx
,
310 struct gl_array_object
*arrayObj
)
312 GLbitfield64 enabled
;
314 if (!ctx
->VertexProgram
._Current
||
315 ctx
->VertexProgram
._Current
== ctx
->VertexProgram
._TnlProgram
) {
316 enabled
= _mesa_array_object_get_enabled_ff(arrayObj
);
318 enabled
= _mesa_array_object_get_enabled_arb(arrayObj
);
321 /* _MaxElement is one past the last legal array element */
322 arrayObj
->_MaxElement
= compute_max_element(arrayObj
, enabled
);
326 /**********************************************************************/
328 /**********************************************************************/
332 * Helper for _mesa_BindVertexArray() and _mesa_BindVertexArrayAPPLE().
333 * \param genRequired specifies behavour when id was not generated with
334 * glGenVertexArrays().
337 bind_vertex_array(struct gl_context
*ctx
, GLuint id
, GLboolean genRequired
)
339 struct gl_array_object
* const oldObj
= ctx
->Array
.ArrayObj
;
340 struct gl_array_object
*newObj
= NULL
;
341 ASSERT_OUTSIDE_BEGIN_END(ctx
);
343 ASSERT(oldObj
!= NULL
);
345 if ( oldObj
->Name
== id
)
346 return; /* rebinding the same array object- no change */
349 * Get pointer to new array object (newObj)
352 /* The spec says there is no array object named 0, but we use
353 * one internally because it simplifies things.
355 newObj
= ctx
->Array
.DefaultArrayObj
;
358 /* non-default array object */
359 newObj
= lookup_arrayobj(ctx
, id
);
362 _mesa_error(ctx
, GL_INVALID_OPERATION
, "glBindVertexArray(non-gen name)");
366 /* For APPLE version, generate a new array object now */
367 newObj
= (*ctx
->Driver
.NewArrayObject
)(ctx
, id
);
369 _mesa_error(ctx
, GL_OUT_OF_MEMORY
, "glBindVertexArrayAPPLE");
373 save_array_object(ctx
, newObj
);
376 if (!newObj
->_Used
) {
377 /* The "Interactions with APPLE_vertex_array_object" section of the
378 * GL_ARB_vertex_array_object spec says:
380 * "The first bind call, either BindVertexArray or
381 * BindVertexArrayAPPLE, determines the semantic of the object."
383 newObj
->ARBsemantics
= genRequired
;
384 newObj
->_Used
= GL_TRUE
;
388 ctx
->NewState
|= _NEW_ARRAY
;
389 _mesa_reference_array_object(ctx
, &ctx
->Array
.ArrayObj
, newObj
);
391 /* Pass BindVertexArray call to device driver */
392 if (ctx
->Driver
.BindArrayObject
&& newObj
)
393 ctx
->Driver
.BindArrayObject(ctx
, newObj
);
398 * ARB version of glBindVertexArray()
399 * This function behaves differently from glBindVertexArrayAPPLE() in
400 * that this function requires all ids to have been previously generated
401 * by glGenVertexArrays[APPLE]().
404 _mesa_BindVertexArray( GLuint id
)
406 GET_CURRENT_CONTEXT(ctx
);
407 bind_vertex_array(ctx
, id
, GL_TRUE
);
415 * The binding could be done more efficiently by comparing the non-NULL
416 * pointers in the old and new objects. The only arrays that are "dirty" are
417 * the ones that are non-NULL in either object.
420 _mesa_BindVertexArrayAPPLE( GLuint id
)
422 GET_CURRENT_CONTEXT(ctx
);
423 bind_vertex_array(ctx
, id
, GL_FALSE
);
428 * Delete a set of array objects.
430 * \param n Number of array objects to delete.
431 * \param ids Array of \c n array object IDs.
434 _mesa_DeleteVertexArraysAPPLE(GLsizei n
, const GLuint
*ids
)
436 GET_CURRENT_CONTEXT(ctx
);
438 ASSERT_OUTSIDE_BEGIN_END(ctx
);
441 _mesa_error(ctx
, GL_INVALID_VALUE
, "glDeleteVertexArrayAPPLE(n)");
445 for (i
= 0; i
< n
; i
++) {
446 struct gl_array_object
*obj
= lookup_arrayobj(ctx
, ids
[i
]);
449 ASSERT( obj
->Name
== ids
[i
] );
451 /* If the array object is currently bound, the spec says "the binding
452 * for that object reverts to zero and the default vertex array
455 if ( obj
== ctx
->Array
.ArrayObj
) {
456 _mesa_BindVertexArray(0);
459 /* The ID is immediately freed for re-use */
460 remove_array_object(ctx
, obj
);
462 /* Unreference the array object.
463 * If refcount hits zero, the object will be deleted.
465 _mesa_reference_array_object(ctx
, &obj
, NULL
);
472 * Generate a set of unique array object IDs and store them in \c arrays.
473 * Helper for _mesa_GenVertexArrays[APPLE]() functions below.
474 * \param n Number of IDs to generate.
475 * \param arrays Array of \c n locations to store the IDs.
476 * \param vboOnly Will arrays have to reside in VBOs?
479 gen_vertex_arrays(struct gl_context
*ctx
, GLsizei n
, GLuint
*arrays
)
483 ASSERT_OUTSIDE_BEGIN_END(ctx
);
486 _mesa_error(ctx
, GL_INVALID_VALUE
, "glGenVertexArraysAPPLE");
494 first
= _mesa_HashFindFreeKeyBlock(ctx
->Array
.Objects
, n
);
496 /* Allocate new, empty array objects and return identifiers */
497 for (i
= 0; i
< n
; i
++) {
498 struct gl_array_object
*obj
;
499 GLuint name
= first
+ i
;
501 obj
= (*ctx
->Driver
.NewArrayObject
)( ctx
, name
);
503 _mesa_error(ctx
, GL_OUT_OF_MEMORY
, "glGenVertexArraysAPPLE");
506 save_array_object(ctx
, obj
);
507 arrays
[i
] = first
+ i
;
513 * ARB version of glGenVertexArrays()
514 * All arrays will be required to live in VBOs.
517 _mesa_GenVertexArrays(GLsizei n
, GLuint
*arrays
)
519 GET_CURRENT_CONTEXT(ctx
);
520 gen_vertex_arrays(ctx
, n
, arrays
);
525 * APPLE version of glGenVertexArraysAPPLE()
526 * Arrays may live in VBOs or ordinary memory.
529 _mesa_GenVertexArraysAPPLE(GLsizei n
, GLuint
*arrays
)
531 GET_CURRENT_CONTEXT(ctx
);
532 gen_vertex_arrays(ctx
, n
, arrays
);
537 * Determine if ID is the name of an array object.
539 * \param id ID of the potential array object.
540 * \return \c GL_TRUE if \c id is the name of a array object,
541 * \c GL_FALSE otherwise.
544 _mesa_IsVertexArrayAPPLE( GLuint id
)
546 struct gl_array_object
* obj
;
547 GET_CURRENT_CONTEXT(ctx
);
548 ASSERT_OUTSIDE_BEGIN_END_WITH_RETVAL(ctx
, GL_FALSE
);
553 obj
= lookup_arrayobj(ctx
, id
);
555 return (obj
!= NULL
) ? GL_TRUE
: GL_FALSE
;