src/mesa/main/arrayobj.c

   1 /*
   2  * Mesa 3-D graphics library
   3  * Version:  7.2
   4  *
   5  * Copyright (C) 1999-2008  Brian Paul   All Rights Reserved.
   6  * (C) Copyright IBM Corporation 2006
   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  * BRIAN PAUL OR IBM BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
  22  * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF
  23  * OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  24  * SOFTWARE.
  25  */
  26
  27
  28 /**
  29  * \file arrayobj.c
  30  * Functions for the GL_APPLE_vertex_array_object extension.
  31  *
  32  * \todo
  33  * The code in this file borrows a lot from bufferobj.c.  There's a certain
  34  * amount of cruft left over from that origin that may be unnecessary.
  35  *
  36  * \author Ian Romanick <idr@us.ibm.com>
  37  * \author Brian Paul
  38  */
  39
  40
  41 #include "glheader.h"
  42 #include "hash.h"
  43 #include "imports.h"
  44 #include "context.h"
  45 #if FEATURE_ARB_vertex_buffer_object
  46 #include "bufferobj.h"
  47 #endif
  48 #include "arrayobj.h"
  49 #include "glapi/dispatch.h"
  50
  51
  52 /**
  53  * Look up the array object for the given ID.
  54  *
  55  * \returns
  56  * Either a pointer to the array object with the specified ID or \c NULL for
  57  * a non-existent ID.  The spec defines ID 0 as being technically
  58  * non-existent.
  59  */
  60
  61 static INLINE struct gl_array_object *
  62 lookup_arrayobj(GLcontext *ctx, GLuint id)
  63 {
  64    return (id == 0)
  65      ? NULL
  66      : (struct gl_array_object *) _mesa_HashLookup(ctx->Shared->ArrayObjects,
  67                                                    id);
  68 }
  69
  70
  71 /**
  72  * Allocate and initialize a new vertex array object.
  73  *
  74  * This function is intended to be called via
  75  * \c dd_function_table::NewArrayObject.
  76  */
  77 struct gl_array_object *
  78 _mesa_new_array_object( GLcontext *ctx, GLuint name )
  79 {
  80    struct gl_array_object *obj = CALLOC_STRUCT(gl_array_object);
  81    if (obj)
  82       _mesa_initialize_array_object(ctx, obj, name);
  83    return obj;
  84 }
  85
  86
  87 /**
  88  * Delete an array object.
  89  *
  90  * This function is intended to be called via
  91  * \c dd_function_table::DeleteArrayObject.
  92  */
  93 void
  94 _mesa_delete_array_object( GLcontext *ctx, struct gl_array_object *obj )
  95 {
  96    (void) ctx;
  97    _mesa_free(obj);
  98 }
  99
 100
 101 static void
 102 init_array(GLcontext *ctx,
 103            struct gl_client_array *array, GLint size, GLint type)
 104 {
 105    array->Size = size;
 106    array->Type = type;
 107    array->Format = GL_RGBA; /* only significant for GL_EXT_vertex_array_bgra */
 108    array->Stride = 0;
 109    array->StrideB = 0;
 110    array->Ptr = NULL;
 111    array->Enabled = GL_FALSE;
 112    array->Normalized = GL_FALSE;
 113 #if FEATURE_ARB_vertex_buffer_object
 114    /* Vertex array buffers */
 115    array->BufferObj = ctx->Array.NullBufferObj;
 116 #endif
 117 }
 118
 119
 120 /**
 121  * Initialize a gl_array_object's arrays.
 122  */
 123 void
 124 _mesa_initialize_array_object( GLcontext *ctx,
 125                                struct gl_array_object *obj,
 126                                GLuint name )
 127 {
 128    GLuint i;
 129
 130    obj->Name = name;
 131
 132    /* Init the individual arrays */
 133    init_array(ctx, &obj->Vertex, 4, GL_FLOAT);
 134    init_array(ctx, &obj->Normal, 3, GL_FLOAT);
 135    init_array(ctx, &obj->Color, 4, GL_FLOAT);
 136    init_array(ctx, &obj->SecondaryColor, 4, GL_FLOAT);
 137    init_array(ctx, &obj->FogCoord, 1, GL_FLOAT);
 138    init_array(ctx, &obj->Index, 1, GL_FLOAT);
 139    for (i = 0; i < MAX_TEXTURE_COORD_UNITS; i++) {
 140       init_array(ctx, &obj->TexCoord[i], 4, GL_FLOAT);
 141    }
 142    init_array(ctx, &obj->EdgeFlag, 1, GL_BOOL);
 143    for (i = 0; i < VERT_ATTRIB_MAX; i++) {
 144       init_array(ctx, &obj->VertexAttrib[i], 4, GL_FLOAT);
 145    }
 146
 147 #if FEATURE_point_size_array
 148    init_array(ctx, &obj->PointSize, 1, GL_FLOAT);
 149 #endif
 150 }
 151
 152
 153 /**
 154  * Add the given array object to the array object pool.
 155  */
 156 void
 157 _mesa_save_array_object( GLcontext *ctx, struct gl_array_object *obj )
 158 {
 159    if (obj->Name > 0) {
 160       /* insert into hash table */
 161       _mesa_HashInsert(ctx->Shared->ArrayObjects, obj->Name, obj);
 162    }
 163 }
 164
 165
 166 /**
 167  * Remove the given array object from the array object pool.
 168  * Do not deallocate the array object though.
 169  */
 170 void
 171 _mesa_remove_array_object( GLcontext *ctx, struct gl_array_object *obj )
 172 {
 173    if (obj->Name > 0) {
 174       /* remove from hash table */
 175       _mesa_HashRemove(ctx->Shared->ArrayObjects, obj->Name);
 176    }
 177 }
 178
 179
 180 static void
 181 unbind_buffer_object( GLcontext *ctx, struct gl_buffer_object *bufObj )
 182 {
 183    if (bufObj != ctx->Array.NullBufferObj) {
 184       _mesa_reference_buffer_object(ctx, &bufObj, NULL);
 185    }
 186 }
 187
 188
 189 /**********************************************************************/
 190 /* API Functions                                                      */
 191 /**********************************************************************/
 192
 193 /**
 194  * Bind a new array.
 195  *
 196  * \todo
 197  * The binding could be done more efficiently by comparing the non-NULL
 198  * pointers in the old and new objects.  The only arrays that are "dirty" are
 199  * the ones that are non-NULL in either object.
 200  */
 201 void GLAPIENTRY
 202 _mesa_BindVertexArrayAPPLE( GLuint id )
 203 {
 204    GET_CURRENT_CONTEXT(ctx);
 205    struct gl_array_object * const oldObj = ctx->Array.ArrayObj;
 206    struct gl_array_object *newObj = NULL;
 207    ASSERT_OUTSIDE_BEGIN_END(ctx);
 208
 209    ASSERT(oldObj != NULL);
 210
 211    if ( oldObj->Name == id )
 212       return;   /* rebinding the same array object- no change */
 213
 214    /*
 215     * Get pointer to new array object (newBufObj)
 216     */
 217    if (id == 0) {
 218       /* The spec says there is no array object named 0, but we use
 219        * one internally because it simplifies things.
 220        */
 221       newObj = ctx->Array.DefaultArrayObj;
 222    }
 223    else {
 224       /* non-default array object */
 225       newObj = lookup_arrayobj(ctx, id);
 226       if (!newObj) {
 227          /* If this is a new array object id, allocate an array object now.
 228           */
 229
 230          newObj = (*ctx->Driver.NewArrayObject)(ctx, id);
 231          if (!newObj) {
 232             _mesa_error(ctx, GL_OUT_OF_MEMORY, "glBindVertexArrayAPPLE");
 233             return;
 234          }
 235          _mesa_save_array_object(ctx, newObj);
 236       }
 237    }
 238
 239
 240    ctx->NewState |= _NEW_ARRAY;
 241    ctx->Array.NewState |= _NEW_ARRAY_ALL;
 242    ctx->Array.ArrayObj = newObj;
 243
 244
 245    /* Pass BindVertexArray call to device driver */
 246    if (ctx->Driver.BindArrayObject && newObj)
 247       (*ctx->Driver.BindArrayObject)( ctx, newObj );
 248 }
 249
 250
 251 /**
 252  * Delete a set of array objects.
 253  *
 254  * \param n      Number of array objects to delete.
 255  * \param ids    Array of \c n array object IDs.
 256  */
 257 void GLAPIENTRY
 258 _mesa_DeleteVertexArraysAPPLE(GLsizei n, const GLuint *ids)
 259 {
 260    GET_CURRENT_CONTEXT(ctx);
 261    GLsizei i;
 262    ASSERT_OUTSIDE_BEGIN_END(ctx);
 263
 264    if (n < 0) {
 265       _mesa_error(ctx, GL_INVALID_VALUE, "glDeleteVertexArrayAPPLE(n)");
 266       return;
 267    }
 268
 269    _glthread_LOCK_MUTEX(ctx->Shared->Mutex);
 270
 271    for (i = 0; i < n; i++) {
 272       struct gl_array_object *obj = lookup_arrayobj(ctx, ids[i]);
 273
 274       if ( obj != NULL ) {
 275          ASSERT( obj->Name == ids[i] );
 276
 277
 278          /* If the array object is currently bound, the spec says "the binding
 279           * for that object reverts to zero and the default vertex array
 280           * becomes current."
 281           */
 282          if ( obj == ctx->Array.ArrayObj ) {
 283             CALL_BindVertexArrayAPPLE( ctx->Exec, (0) );
 284          }
 285
 286 #if FEATURE_ARB_vertex_buffer_object
 287          /* Unbind any buffer objects that might be bound to arrays in
 288           * this array object.
 289           */
 290          unbind_buffer_object( ctx, obj->Vertex.BufferObj );
 291          unbind_buffer_object( ctx, obj->Normal.BufferObj );
 292          unbind_buffer_object( ctx, obj->Color.BufferObj );
 293          unbind_buffer_object( ctx, obj->SecondaryColor.BufferObj );
 294          unbind_buffer_object( ctx, obj->FogCoord.BufferObj );
 295          unbind_buffer_object( ctx, obj->Index.BufferObj );
 296          for (i = 0; i < MAX_TEXTURE_COORD_UNITS; i++) {
 297             unbind_buffer_object( ctx, obj->TexCoord[i].BufferObj );
 298          }
 299          unbind_buffer_object( ctx, obj->EdgeFlag.BufferObj );
 300          for (i = 0; i < VERT_ATTRIB_MAX; i++) {
 301             unbind_buffer_object( ctx, obj->VertexAttrib[i].BufferObj );
 302          }
 303 #endif
 304
 305          /* The ID is immediately freed for re-use */
 306          _mesa_remove_array_object(ctx, obj);
 307          ctx->Driver.DeleteArrayObject(ctx, obj);
 308       }
 309    }
 310
 311    _glthread_UNLOCK_MUTEX(ctx->Shared->Mutex);
 312 }
 313
 314
 315 /**
 316  * Generate a set of unique array object IDs and store them in \c arrays.
 317  *
 318  * \param n       Number of IDs to generate.
 319  * \param arrays  Array of \c n locations to store the IDs.
 320  */
 321 void GLAPIENTRY
 322 _mesa_GenVertexArraysAPPLE(GLsizei n, GLuint *arrays)
 323 {
 324    GET_CURRENT_CONTEXT(ctx);
 325    GLuint first;
 326    GLint i;
 327    ASSERT_OUTSIDE_BEGIN_END(ctx);
 328
 329    if (n < 0) {
 330       _mesa_error(ctx, GL_INVALID_VALUE, "glGenVertexArraysAPPLE");
 331       return;
 332    }
 333
 334    if (!arrays) {
 335       return;
 336    }
 337
 338    /*
 339     * This must be atomic (generation and allocation of array object IDs)
 340     */
 341    _glthread_LOCK_MUTEX(ctx->Shared->Mutex);
 342
 343    first = _mesa_HashFindFreeKeyBlock(ctx->Shared->ArrayObjects, n);
 344
 345    /* Allocate new, empty array objects and return identifiers */
 346    for (i = 0; i < n; i++) {
 347       struct gl_array_object *obj;
 348       GLuint name = first + i;
 349
 350       obj = (*ctx->Driver.NewArrayObject)( ctx, name );
 351       if (!obj) {
 352          _glthread_UNLOCK_MUTEX(ctx->Shared->Mutex);
 353          _mesa_error(ctx, GL_OUT_OF_MEMORY, "glGenVertexArraysAPPLE");
 354          return;
 355       }
 356       _mesa_save_array_object(ctx, obj);
 357       arrays[i] = first + i;
 358    }
 359
 360    _glthread_UNLOCK_MUTEX(ctx->Shared->Mutex);
 361 }
 362
 363
 364 /**
 365  * Determine if ID is the name of an array object.
 366  *
 367  * \param id  ID of the potential array object.
 368  * \return  \c GL_TRUE if \c id is the name of a array object,
 369  *          \c GL_FALSE otherwise.
 370  */
 371 GLboolean GLAPIENTRY
 372 _mesa_IsVertexArrayAPPLE( GLuint id )
 373 {
 374    struct gl_array_object * obj;
 375    GET_CURRENT_CONTEXT(ctx);
 376    ASSERT_OUTSIDE_BEGIN_END_WITH_RETVAL(ctx, GL_FALSE);
 377
 378    if (id == 0)
 379       return GL_FALSE;
 380
 381    _glthread_LOCK_MUTEX(ctx->Shared->Mutex);
 382    obj = lookup_arrayobj(ctx, id);
 383    _glthread_UNLOCK_MUTEX(ctx->Shared->Mutex);
 384
 385    return (obj != NULL) ? GL_TRUE : GL_FALSE;
 386 }