src/mesa/main/arrayobj.c

   1 /*
   2  * Mesa 3-D graphics library
   3  * Version:  6.5
   4  *
   5  * Copyright (C) 1999-2004  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 "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 = MALLOC_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 void
 102 _mesa_initialize_array_object( GLcontext *ctx,
 103                                struct gl_array_object *obj,
 104                                GLuint name )
 105 {
 106    GLuint i;
 107
 108    obj->Name = name;
 109
 110    /* Vertex arrays */
 111    obj->Vertex.Size = 4;
 112    obj->Vertex.Type = GL_FLOAT;
 113    obj->Vertex.Stride = 0;
 114    obj->Vertex.StrideB = 0;
 115    obj->Vertex.Ptr = NULL;
 116    obj->Vertex.Enabled = GL_FALSE;
 117    obj->Vertex.Flags = CA_CLIENT_DATA;
 118    obj->Normal.Type = GL_FLOAT;
 119    obj->Normal.Stride = 0;
 120    obj->Normal.StrideB = 0;
 121    obj->Normal.Ptr = NULL;
 122    obj->Normal.Enabled = GL_FALSE;
 123    obj->Normal.Flags = CA_CLIENT_DATA;
 124    obj->Color.Size = 4;
 125    obj->Color.Type = GL_FLOAT;
 126    obj->Color.Stride = 0;
 127    obj->Color.StrideB = 0;
 128    obj->Color.Ptr = NULL;
 129    obj->Color.Enabled = GL_FALSE;
 130    obj->Color.Flags = CA_CLIENT_DATA;
 131    obj->SecondaryColor.Size = 4;
 132    obj->SecondaryColor.Type = GL_FLOAT;
 133    obj->SecondaryColor.Stride = 0;
 134    obj->SecondaryColor.StrideB = 0;
 135    obj->SecondaryColor.Ptr = NULL;
 136    obj->SecondaryColor.Enabled = GL_FALSE;
 137    obj->SecondaryColor.Flags = CA_CLIENT_DATA;
 138    obj->FogCoord.Size = 1;
 139    obj->FogCoord.Type = GL_FLOAT;
 140    obj->FogCoord.Stride = 0;
 141    obj->FogCoord.StrideB = 0;
 142    obj->FogCoord.Ptr = NULL;
 143    obj->FogCoord.Enabled = GL_FALSE;
 144    obj->FogCoord.Flags = CA_CLIENT_DATA;
 145    obj->Index.Type = GL_FLOAT;
 146    obj->Index.Stride = 0;
 147    obj->Index.StrideB = 0;
 148    obj->Index.Ptr = NULL;
 149    obj->Index.Enabled = GL_FALSE;
 150    obj->Index.Flags = CA_CLIENT_DATA;
 151    for (i = 0; i < MAX_TEXTURE_UNITS; i++) {
 152       obj->TexCoord[i].Size = 4;
 153       obj->TexCoord[i].Type = GL_FLOAT;
 154       obj->TexCoord[i].Stride = 0;
 155       obj->TexCoord[i].StrideB = 0;
 156       obj->TexCoord[i].Ptr = NULL;
 157       obj->TexCoord[i].Enabled = GL_FALSE;
 158       obj->TexCoord[i].Flags = CA_CLIENT_DATA;
 159    }
 160    obj->EdgeFlag.Stride = 0;
 161    obj->EdgeFlag.StrideB = 0;
 162    obj->EdgeFlag.Ptr = NULL;
 163    obj->EdgeFlag.Enabled = GL_FALSE;
 164    obj->EdgeFlag.Flags = CA_CLIENT_DATA;
 165    for (i = 0; i < VERT_ATTRIB_MAX; i++) {
 166       obj->VertexAttrib[i].Size = 4;
 167       obj->VertexAttrib[i].Type = GL_FLOAT;
 168       obj->VertexAttrib[i].Stride = 0;
 169       obj->VertexAttrib[i].StrideB = 0;
 170       obj->VertexAttrib[i].Ptr = NULL;
 171       obj->VertexAttrib[i].Enabled = GL_FALSE;
 172       obj->VertexAttrib[i].Normalized = GL_FALSE;
 173       obj->VertexAttrib[i].Flags = CA_CLIENT_DATA;
 174    }
 175
 176 #if FEATURE_ARB_vertex_buffer_object
 177    /* Vertex array buffers */
 178    obj->Vertex.BufferObj = ctx->Array.NullBufferObj;
 179    obj->Normal.BufferObj = ctx->Array.NullBufferObj;
 180    obj->Color.BufferObj = ctx->Array.NullBufferObj;
 181    obj->SecondaryColor.BufferObj = ctx->Array.NullBufferObj;
 182    obj->FogCoord.BufferObj = ctx->Array.NullBufferObj;
 183    obj->Index.BufferObj = ctx->Array.NullBufferObj;
 184    for (i = 0; i < MAX_TEXTURE_UNITS; i++) {
 185       obj->TexCoord[i].BufferObj = ctx->Array.NullBufferObj;
 186    }
 187    obj->EdgeFlag.BufferObj = ctx->Array.NullBufferObj;
 188    for (i = 0; i < VERT_ATTRIB_MAX; i++) {
 189       obj->VertexAttrib[i].BufferObj = ctx->Array.NullBufferObj;
 190    }
 191 #endif
 192 }
 193
 194
 195 /**
 196  * Add the given array object to the array object pool.
 197  */
 198 void
 199 _mesa_save_array_object( GLcontext *ctx, struct gl_array_object *obj )
 200 {
 201    if (obj->Name > 0) {
 202       /* insert into hash table */
 203       _mesa_HashInsert(ctx->Shared->ArrayObjects, obj->Name, obj);
 204    }
 205 }
 206
 207
 208 /**
 209  * Remove the given array object from the array object pool.
 210  * Do not deallocate the array object though.
 211  */
 212 void
 213 _mesa_remove_array_object( GLcontext *ctx, struct gl_array_object *obj )
 214 {
 215    if (obj->Name > 0) {
 216       /* remove from hash table */
 217       _mesa_HashRemove(ctx->Shared->ArrayObjects, obj->Name);
 218    }
 219 }
 220
 221
 222 /**********************************************************************/
 223 /* API Functions                                                      */
 224 /**********************************************************************/
 225
 226 /**
 227  * Bind a new array.
 228  *
 229  * \todo
 230  * The binding could be done more efficiently by comparing the non-NULL
 231  * pointers in the old and new objects.  The only arrays that are "dirty" are
 232  * the ones that are non-NULL in either object.
 233  */
 234 void GLAPIENTRY
 235 _mesa_BindVertexArrayAPPLE( GLuint id )
 236 {
 237    GET_CURRENT_CONTEXT(ctx);
 238    struct gl_array_object * const oldObj = ctx->Array.ArrayObj;
 239    struct gl_array_object *newObj = NULL;
 240    ASSERT_OUTSIDE_BEGIN_END(ctx);
 241
 242    ASSERT(oldObj != NULL);
 243
 244    if ( oldObj->Name == id )
 245       return;   /* rebinding the same array object- no change */
 246
 247    /*
 248     * Get pointer to new array object (newBufObj)
 249     */
 250    if (id == 0) {
 251       /* The spec says there is no array object named 0, but we use
 252        * one internally because it simplifies things.
 253        */
 254       newObj = ctx->Array.DefaultArrayObj;
 255    }
 256    else {
 257       /* non-default array object */
 258       newObj = lookup_arrayobj(ctx, id);
 259       if (!newObj) {
 260          /* If this is a new array object id, allocate an array object now.
 261           */
 262
 263          newObj = (*ctx->Driver.NewArrayObject)(ctx, id);
 264          if (!newObj) {
 265             _mesa_error(ctx, GL_OUT_OF_MEMORY, "glBindVertexArrayAPPLE");
 266             return;
 267          }
 268          _mesa_save_array_object(ctx, newObj);
 269       }
 270    }
 271
 272
 273    ctx->NewState |= _NEW_ARRAY;
 274    ctx->Array.NewState |= _NEW_ARRAY_ALL;
 275    ctx->Array.ArrayObj = newObj;
 276
 277
 278    /* Pass BindVertexArray call to device driver */
 279    if (ctx->Driver.BindArrayObject && newObj)
 280       (*ctx->Driver.BindArrayObject)( ctx, newObj );
 281 }
 282
 283
 284 /**
 285  * Delete a set of array objects.
 286  *
 287  * \param n      Number of array objects to delete.
 288  * \param ids    Array of \c n array object IDs.
 289  */
 290 void GLAPIENTRY
 291 _mesa_DeleteVertexArraysAPPLE(GLsizei n, const GLuint *ids)
 292 {
 293    GET_CURRENT_CONTEXT(ctx);
 294    GLsizei i;
 295    ASSERT_OUTSIDE_BEGIN_END(ctx);
 296
 297    if (n < 0) {
 298       _mesa_error(ctx, GL_INVALID_VALUE, "glDeleteVertexArrayAPPLE(n)");
 299       return;
 300    }
 301
 302    _glthread_LOCK_MUTEX(ctx->Shared->Mutex);
 303
 304    for (i = 0; i < n; i++) {
 305       struct gl_array_object *obj = lookup_arrayobj(ctx, ids[i]);
 306
 307       if ( obj != NULL ) {
 308          ASSERT( obj->Name == ids[i] );
 309
 310
 311          /* If the array object is currently bound, the spec says "the binding
 312           * for that object reverts to zero and the default vertex array
 313           * becomes current."
 314           */
 315          if ( obj == ctx->Array.ArrayObj ) {
 316             CALL_BindVertexArrayAPPLE( ctx->Exec, (0) );
 317          }
 318
 319 #if FEATURE_ARB_vertex_buffer_object
 320          /* Unbind any buffer objects that might be bound to arrays in
 321           * this array object.
 322           */
 323          _mesa_unbind_buffer_object( ctx, obj->Vertex.BufferObj );
 324          _mesa_unbind_buffer_object( ctx, obj->Normal.BufferObj );
 325          _mesa_unbind_buffer_object( ctx, obj->Color.BufferObj );
 326          _mesa_unbind_buffer_object( ctx, obj->SecondaryColor.BufferObj );
 327          _mesa_unbind_buffer_object( ctx, obj->FogCoord.BufferObj );
 328          _mesa_unbind_buffer_object( ctx, obj->Index.BufferObj );
 329          for (i = 0; i < MAX_TEXTURE_UNITS; i++) {
 330             _mesa_unbind_buffer_object( ctx, obj->TexCoord[i].BufferObj );
 331          }
 332          _mesa_unbind_buffer_object( ctx, obj->EdgeFlag.BufferObj );
 333          for (i = 0; i < VERT_ATTRIB_MAX; i++) {
 334             _mesa_unbind_buffer_object( ctx, obj->VertexAttrib[i].BufferObj );
 335          }
 336 #endif
 337
 338          /* The ID is immediately freed for re-use */
 339          _mesa_remove_array_object(ctx, obj);
 340          ctx->Driver.DeleteArrayObject(ctx, obj);
 341       }
 342    }
 343
 344    _glthread_UNLOCK_MUTEX(ctx->Shared->Mutex);
 345 }
 346
 347
 348 /**
 349  * Generate a set of unique array object IDs and store them in \c arrays.
 350  *
 351  * \param n       Number of IDs to generate.
 352  * \param arrays  Array of \c n locations to store the IDs.
 353  */
 354 void GLAPIENTRY
 355 _mesa_GenVertexArraysAPPLE(GLsizei n, GLuint *arrays)
 356 {
 357    GET_CURRENT_CONTEXT(ctx);
 358    GLuint first;
 359    GLint i;
 360    ASSERT_OUTSIDE_BEGIN_END(ctx);
 361
 362    if (n < 0) {
 363       _mesa_error(ctx, GL_INVALID_VALUE, "glGenVertexArraysAPPLE");
 364       return;
 365    }
 366
 367    if (!arrays) {
 368       return;
 369    }
 370
 371    /*
 372     * This must be atomic (generation and allocation of array object IDs)
 373     */
 374    _glthread_LOCK_MUTEX(ctx->Shared->Mutex);
 375
 376    first = _mesa_HashFindFreeKeyBlock(ctx->Shared->ArrayObjects, n);
 377
 378    /* Allocate new, empty array objects and return identifiers */
 379    for (i = 0; i < n; i++) {
 380       struct gl_array_object *obj;
 381       GLuint name = first + i;
 382
 383       obj = (*ctx->Driver.NewArrayObject)( ctx, name );
 384       if (!obj) {
 385          _glthread_UNLOCK_MUTEX(ctx->Shared->Mutex);
 386          _mesa_error(ctx, GL_OUT_OF_MEMORY, "glGenVertexArraysAPPLE");
 387          return;
 388       }
 389       _mesa_save_array_object(ctx, obj);
 390       arrays[i] = first + i;
 391    }
 392
 393    _glthread_UNLOCK_MUTEX(ctx->Shared->Mutex);
 394 }
 395
 396
 397 /**
 398  * Determine if ID is the name of an array object.
 399  *
 400  * \param id  ID of the potential array object.
 401  * \return  \c GL_TRUE if \c id is the name of a array object,
 402  *          \c GL_FALSE otherwise.
 403  */
 404 GLboolean GLAPIENTRY
 405 _mesa_IsVertexArrayAPPLE( GLuint id )
 406 {
 407    struct gl_array_object * obj;
 408    GET_CURRENT_CONTEXT(ctx);
 409    ASSERT_OUTSIDE_BEGIN_END_WITH_RETVAL(ctx, GL_FALSE);
 410
 411    if (id == 0)
 412       return GL_FALSE;
 413
 414    _glthread_LOCK_MUTEX(ctx->Shared->Mutex);
 415    obj = lookup_arrayobj(ctx, id);
 416    _glthread_UNLOCK_MUTEX(ctx->Shared->Mutex);
 417
 418    return (obj != NULL) ? GL_TRUE : GL_FALSE;
 419 }