mesa: Rename ElementArrayBufferObj to IndexBufferObj.
authorKenneth Graunke <kenneth@whitecape.org>
Sun, 2 Feb 2014 03:46:45 +0000 (19:46 -0800)
committerKenneth Graunke <kenneth@whitecape.org>
Mon, 3 Feb 2014 08:53:11 +0000 (00:53 -0800)
DirectX and most hardware documentation use the term "Index Buffer" to
refer to a buffer containing indexes into arrays of vertex data, which
allows random access to vertex data, rather than sequential access.

OpenGL uses a different term for this concept: "Element Array Buffer".
However, "Index Buffer" has become much more widespread.  A quick
Google search shows 29,300 hits for "Element Array Buffer" vs.
82,300 hits for "Index Buffer."

Arguably, "Index Buffer" is clearer: an "element of an array" (or list)
usually refers to an actual item stored in the array, not the index used
to refer to it.

The terminology is also already used in Mesa: some VBO module code for
dealing with ElementArrayBufferObj names local variables "ib".

Completely generated by:
$ find . -type f -print0 | xargs -0 sed -i \
  's/ElementArrayBufferObj/IndexBufferObj/g'

Signed-off-by: Kenneth Graunke <kenneth@whitecape.org>
Reviewed-by: Jordan Justen <jordan.l.justen@intel.com>
Reviewed-by: Ian Romanick <ian.d.romanick@intel.com>
Reviewed-by: Brian Paul <brianp@vmware.com>
src/mesa/main/api_arrayelt.c
src/mesa/main/api_validate.c
src/mesa/main/arrayobj.c
src/mesa/main/attrib.c
src/mesa/main/bufferobj.c
src/mesa/main/get.c
src/mesa/main/mtypes.h
src/mesa/vbo/vbo_exec_array.c
src/mesa/vbo/vbo_save_api.c

index fdda1dc46c943327c212dc8e79b52fe8f80cd9ff..29a57c8e51d08227daa2ea9b35a7247d1ff291d8 100644 (file)
@@ -1600,7 +1600,7 @@ _ae_update_state(struct gl_context *ctx)
       aa++;
    }
 
-   check_vbo(actx, vao->ElementArrayBufferObj);
+   check_vbo(actx, vao->IndexBufferObj);
 
    ASSERT(at - actx->attribs <= VERT_ATTRIB_MAX);
    ASSERT(aa - actx->arrays < 32);
index 41dfc3806e58b5a99603fcce34943eecfd0e95cd..af469e046fce66c982b669df370e44b7eb4f3603 100644 (file)
@@ -180,7 +180,7 @@ check_index_bounds(struct gl_context *ctx, GLsizei count, GLenum type,
    memset(&ib, 0, sizeof(ib));
    ib.type = type;
    ib.ptr = indices;
-   ib.obj = ctx->Array.VAO->ElementArrayBufferObj;
+   ib.obj = ctx->Array.VAO->IndexBufferObj;
 
    vbo_get_minmax_indices(ctx, &prim, &ib, &min, &max, 1);
 
@@ -435,10 +435,10 @@ _mesa_validate_DrawElements(struct gl_context *ctx,
       return GL_FALSE;
 
    /* Vertex buffer object tests */
-   if (_mesa_is_bufferobj(ctx->Array.VAO->ElementArrayBufferObj)) {
+   if (_mesa_is_bufferobj(ctx->Array.VAO->IndexBufferObj)) {
       /* use indices in the buffer object */
       /* make sure count doesn't go outside buffer bounds */
-      if (index_bytes(type, count) > ctx->Array.VAO->ElementArrayBufferObj->Size) {
+      if (index_bytes(type, count) > ctx->Array.VAO->IndexBufferObj->Size) {
          _mesa_warning(ctx, "glDrawElements index out of buffer bounds");
          return GL_FALSE;
       }
@@ -493,12 +493,12 @@ _mesa_validate_MultiDrawElements(struct gl_context *ctx,
       return GL_FALSE;
 
    /* Vertex buffer object tests */
-   if (_mesa_is_bufferobj(ctx->Array.VAO->ElementArrayBufferObj)) {
+   if (_mesa_is_bufferobj(ctx->Array.VAO->IndexBufferObj)) {
       /* use indices in the buffer object */
       /* make sure count doesn't go outside buffer bounds */
       for (i = 0; i < primcount; i++) {
          if (index_bytes(type, count[i]) >
-             ctx->Array.VAO->ElementArrayBufferObj->Size) {
+             ctx->Array.VAO->IndexBufferObj->Size) {
             _mesa_warning(ctx,
                           "glMultiDrawElements index out of buffer bounds");
             return GL_FALSE;
@@ -570,10 +570,10 @@ _mesa_validate_DrawRangeElements(struct gl_context *ctx, GLenum mode,
       return GL_FALSE;
 
    /* Vertex buffer object tests */
-   if (_mesa_is_bufferobj(ctx->Array.VAO->ElementArrayBufferObj)) {
+   if (_mesa_is_bufferobj(ctx->Array.VAO->IndexBufferObj)) {
       /* use indices in the buffer object */
       /* make sure count doesn't go outside buffer bounds */
-      if (index_bytes(type, count) > ctx->Array.VAO->ElementArrayBufferObj->Size) {
+      if (index_bytes(type, count) > ctx->Array.VAO->IndexBufferObj->Size) {
          _mesa_warning(ctx, "glDrawRangeElements index out of buffer bounds");
          return GL_FALSE;
       }
@@ -769,10 +769,10 @@ _mesa_validate_DrawElementsInstanced(struct gl_context *ctx,
       return GL_FALSE;
 
    /* Vertex buffer object tests */
-   if (_mesa_is_bufferobj(ctx->Array.VAO->ElementArrayBufferObj)) {
+   if (_mesa_is_bufferobj(ctx->Array.VAO->IndexBufferObj)) {
       /* use indices in the buffer object */
       /* make sure count doesn't go outside buffer bounds */
-      if (index_bytes(type, count) > ctx->Array.VAO->ElementArrayBufferObj->Size) {
+      if (index_bytes(type, count) > ctx->Array.VAO->IndexBufferObj->Size) {
          _mesa_warning(ctx,
                        "glDrawElementsInstanced index out of buffer bounds");
          return GL_FALSE;
@@ -901,7 +901,7 @@ valid_draw_indirect_elements(struct gl_context *ctx,
     * If no element array buffer is bound, an INVALID_OPERATION error is
     * generated.
     */
-   if (!_mesa_is_bufferobj(ctx->Array.VAO->ElementArrayBufferObj)) {
+   if (!_mesa_is_bufferobj(ctx->Array.VAO->IndexBufferObj)) {
       _mesa_error(ctx, GL_INVALID_OPERATION,
                   "%s(no buffer bound to GL_ELEMENT_ARRAY_BUFFER)", name);
       return GL_FALSE;
index 0caae43a35b8042d159291b6d1cd8e260de7a2e4..46ccbdc085c360db4c66dae4d035dec0a2cd71dc 100644 (file)
@@ -116,7 +116,7 @@ _mesa_delete_vao(struct gl_context *ctx, struct gl_vertex_array_object *obj)
 {
    (void) ctx;
    unbind_array_object_vbos(ctx, obj);
-   _mesa_reference_buffer_object(ctx, &obj->ElementArrayBufferObj, NULL);
+   _mesa_reference_buffer_object(ctx, &obj->IndexBufferObj, NULL);
    _glthread_DESTROY_MUTEX(obj->Mutex);
    free(obj->Label);
    free(obj);
@@ -257,7 +257,7 @@ _mesa_initialize_vao(struct gl_context *ctx,
       }
    }
 
-   _mesa_reference_buffer_object(ctx, &obj->ElementArrayBufferObj,
+   _mesa_reference_buffer_object(ctx, &obj->IndexBufferObj,
                                  ctx->Shared->NullBufferObj);
 }
 
index 5b5c48dbdab532bf10ffb70d9c4b0099b5415596..0045280446817445fd64912ad116d8dc8a10889d 100644 (file)
@@ -1486,7 +1486,7 @@ copy_array_attrib(struct gl_context *ctx,
       copy_array_object(ctx, dest->VAO, src->VAO);
 
    /* skip ArrayBufferObj */
-   /* skip ElementArrayBufferObj */
+   /* skip IndexBufferObj */
 }
 
 /**
@@ -1506,8 +1506,8 @@ save_array_attrib(struct gl_context *ctx,
    /* Just reference them here */
    _mesa_reference_buffer_object(ctx, &dest->ArrayBufferObj,
                                  src->ArrayBufferObj);
-   _mesa_reference_buffer_object(ctx, &dest->VAO->ElementArrayBufferObj,
-                                 src->VAO->ElementArrayBufferObj);
+   _mesa_reference_buffer_object(ctx, &dest->VAO->IndexBufferObj,
+                                 src->VAO->IndexBufferObj);
 }
 
 /**
@@ -1552,10 +1552,10 @@ restore_array_attrib(struct gl_context *ctx,
    }
 
    if (!arb_vao
-       || src->VAO->ElementArrayBufferObj->Name == 0
-       || _mesa_IsBuffer(src->VAO->ElementArrayBufferObj->Name))
+       || src->VAO->IndexBufferObj->Name == 0
+       || _mesa_IsBuffer(src->VAO->IndexBufferObj->Name))
       _mesa_BindBuffer(GL_ELEMENT_ARRAY_BUFFER_ARB,
-                         src->VAO->ElementArrayBufferObj->Name);
+                         src->VAO->IndexBufferObj->Name);
 }
 
 /**
index 7c966a7e0bd88d7769407e50b68c0f70ee495738..ca55ef9693f7b8a5b9f922321c6d6ce9c39e9386 100644 (file)
@@ -80,7 +80,7 @@ get_buffer_target(struct gl_context *ctx, GLenum target)
    case GL_ARRAY_BUFFER_ARB:
       return &ctx->Array.ArrayBufferObj;
    case GL_ELEMENT_ARRAY_BUFFER_ARB:
-      return &ctx->Array.VAO->ElementArrayBufferObj;
+      return &ctx->Array.VAO->IndexBufferObj;
    case GL_PIXEL_PACK_BUFFER_EXT:
       return &ctx->Pack.BufferObj;
    case GL_PIXEL_UNPACK_BUFFER_EXT:
@@ -451,7 +451,7 @@ _mesa_reference_buffer_object_(struct gl_context *ctx,
 #if 0
          /* unfortunately, these tests are invalid during context tear-down */
         ASSERT(ctx->Array.ArrayBufferObj != bufObj);
-        ASSERT(ctx->Array.VAO->ElementArrayBufferObj != bufObj);
+        ASSERT(ctx->Array.VAO->IndexBufferObj != bufObj);
         ASSERT(ctx->Array.VAO->Vertex.BufferObj != bufObj);
 #endif
 
@@ -1102,7 +1102,7 @@ _mesa_DeleteBuffers(GLsizei n, const GLuint *ids)
          if (ctx->Array.ArrayBufferObj == bufObj) {
             _mesa_BindBuffer( GL_ARRAY_BUFFER_ARB, 0 );
          }
-         if (vao->ElementArrayBufferObj == bufObj) {
+         if (vao->IndexBufferObj == bufObj) {
             _mesa_BindBuffer( GL_ELEMENT_ARRAY_BUFFER_ARB, 0 );
          }
 
index 4464e7d493cd493e8838c086f74f72b4d23c0bf7..f22acff0b36babf803c9afc5bd40225f14997f03 100644 (file)
@@ -839,7 +839,7 @@ find_custom_value(struct gl_context *ctx, const struct value_desc *d, union valu
         ctx->Array.VAO->VertexBinding[VERT_ATTRIB_TEX(ctx->Array.ActiveTexture)].BufferObj->Name;
       break;
    case GL_ELEMENT_ARRAY_BUFFER_BINDING_ARB:
-      v->value_int = ctx->Array.VAO->ElementArrayBufferObj->Name;
+      v->value_int = ctx->Array.VAO->IndexBufferObj->Name;
       break;
 
    /* ARB_copy_buffer */
index c9b954bcf013cb6d5ff5d960488c207c8ba9f5e9..609c63f3617bef850b0e09c8a4a21d1765b6faba 100644 (file)
@@ -1605,7 +1605,7 @@ struct gl_vertex_array_object
     */
    GLuint _MaxElement;
 
-   struct gl_buffer_object *ElementArrayBufferObj;
+   struct gl_buffer_object *IndexBufferObj;
 };
 
 
index 43ac03bf7f1796f8be19454c2bdfa24057753829..b316f097ddf36bce4c66515d75cbb8b50adc6f2a 100644 (file)
@@ -291,11 +291,11 @@ check_draw_elements_data(struct gl_context *ctx, GLsizei count, GLenum elemType,
    const void *elemMap;
    GLint i, k;
 
-   if (_mesa_is_bufferobj(ctx->Array.VAO->ElementArrayBufferObj)) {
+   if (_mesa_is_bufferobj(ctx->Array.VAO->IndexBufferObj)) {
       elemMap = ctx->Driver.MapBufferRange(ctx, 0,
-                                          ctx->Array.VAO->ElementArrayBufferObj->Size,
+                                          ctx->Array.VAO->IndexBufferObj->Size,
                                           GL_MAP_READ_BIT,
-                                          ctx->Array.VAO->ElementArrayBufferObj);
+                                          ctx->Array.VAO->IndexBufferObj);
       elements = ADD_POINTERS(elements, elemMap);
    }
 
@@ -323,8 +323,8 @@ check_draw_elements_data(struct gl_context *ctx, GLsizei count, GLenum elemType,
       }
    }
 
-   if (_mesa_is_bufferobj(vao->ElementArrayBufferObj)) {
-      ctx->Driver.UnmapBuffer(ctx, ctx->Array.VAO->ElementArrayBufferObj);
+   if (_mesa_is_bufferobj(vao->IndexBufferObj)) {
+      ctx->Driver.UnmapBuffer(ctx, ctx->Array.VAO->IndexBufferObj);
    }
 
    for (k = 0; k < Elements(vao->_VertexAttrib); k++) {
@@ -883,15 +883,15 @@ dump_element_buffer(struct gl_context *ctx, GLenum type)
 {
    const GLvoid *map =
       ctx->Driver.MapBufferRange(ctx, 0,
-                                ctx->Array.VAO->ElementArrayBufferObj->Size,
+                                ctx->Array.VAO->IndexBufferObj->Size,
                                 GL_MAP_READ_BIT,
-                                ctx->Array.VAO->ElementArrayBufferObj);
+                                ctx->Array.VAO->IndexBufferObj);
    switch (type) {
    case GL_UNSIGNED_BYTE:
       {
          const GLubyte *us = (const GLubyte *) map;
          GLint i;
-         for (i = 0; i < ctx->Array.VAO->ElementArrayBufferObj->Size; i++) {
+         for (i = 0; i < ctx->Array.VAO->IndexBufferObj->Size; i++) {
             printf("%02x ", us[i]);
             if (i % 32 == 31)
                printf("\n");
@@ -903,7 +903,7 @@ dump_element_buffer(struct gl_context *ctx, GLenum type)
       {
          const GLushort *us = (const GLushort *) map;
          GLint i;
-         for (i = 0; i < ctx->Array.VAO->ElementArrayBufferObj->Size / 2; i++) {
+         for (i = 0; i < ctx->Array.VAO->IndexBufferObj->Size / 2; i++) {
             printf("%04x ", us[i]);
             if (i % 16 == 15)
                printf("\n");
@@ -915,7 +915,7 @@ dump_element_buffer(struct gl_context *ctx, GLenum type)
       {
          const GLuint *us = (const GLuint *) map;
          GLint i;
-         for (i = 0; i < ctx->Array.VAO->ElementArrayBufferObj->Size / 4; i++) {
+         for (i = 0; i < ctx->Array.VAO->IndexBufferObj->Size / 4; i++) {
             printf("%08x ", us[i]);
             if (i % 8 == 7)
                printf("\n");
@@ -927,7 +927,7 @@ dump_element_buffer(struct gl_context *ctx, GLenum type)
       ;
    }
 
-   ctx->Driver.UnmapBuffer(ctx, ctx->Array.VAO->ElementArrayBufferObj);
+   ctx->Driver.UnmapBuffer(ctx, ctx->Array.VAO->IndexBufferObj);
 }
 #endif
 
@@ -955,7 +955,7 @@ vbo_validated_drawrangeelements(struct gl_context *ctx, GLenum mode,
 
    ib.count = count;
    ib.type = type;
-   ib.obj = ctx->Array.VAO->ElementArrayBufferObj;
+   ib.obj = ctx->Array.VAO->IndexBufferObj;
    ib.ptr = indices;
 
    prim[0].begin = 1;
@@ -1097,7 +1097,7 @@ vbo_exec_DrawRangeElementsBaseVertex(GLenum mode,
             "(start %u, end %u, type 0x%x, count %d) ElemBuf %u, "
             "base %d\n",
             start, end, type, count,
-            ctx->Array.VAO->ElementArrayBufferObj->Name,
+            ctx->Array.VAO->IndexBufferObj->Name,
             basevertex);
    }
 
@@ -1350,13 +1350,13 @@ vbo_validated_multidrawelements(struct gl_context *ctx, GLenum mode,
     * subranges of the index buffer as one large index buffer may lead to
     * us reading unmapped memory.
     */
-   if (!_mesa_is_bufferobj(ctx->Array.VAO->ElementArrayBufferObj))
+   if (!_mesa_is_bufferobj(ctx->Array.VAO->IndexBufferObj))
       fallback = GL_TRUE;
 
    if (!fallback) {
       ib.count = (max_index_ptr - min_index_ptr) / index_type_size;
       ib.type = type;
-      ib.obj = ctx->Array.VAO->ElementArrayBufferObj;
+      ib.obj = ctx->Array.VAO->IndexBufferObj;
       ib.ptr = (void *)min_index_ptr;
 
       for (i = 0; i < primcount; i++) {
@@ -1387,7 +1387,7 @@ vbo_validated_multidrawelements(struct gl_context *ctx, GLenum mode,
            continue;
         ib.count = count[i];
         ib.type = type;
-        ib.obj = ctx->Array.VAO->ElementArrayBufferObj;
+        ib.obj = ctx->Array.VAO->IndexBufferObj;
         ib.ptr = indices[i];
 
         prim[0].begin = 1;
@@ -1657,7 +1657,7 @@ vbo_validated_drawelementsindirect(struct gl_context *ctx,
 
    ib.count = 0; /* unknown */
    ib.type = type;
-   ib.obj = ctx->Array.VAO->ElementArrayBufferObj;
+   ib.obj = ctx->Array.VAO->IndexBufferObj;
    ib.ptr = NULL;
 
    memset(prim, 0, sizeof(prim));
@@ -1701,11 +1701,11 @@ vbo_validated_multidrawelementsindirect(struct gl_context *ctx,
 
    vbo_bind_arrays(ctx);
 
-   /* NOTE: ElementArrayBufferObj is guaranteed to be a VBO. */
+   /* NOTE: IndexBufferObj is guaranteed to be a VBO. */
 
    ib.count = 0; /* unknown */
    ib.type = type;
-   ib.obj = ctx->Array.VAO->ElementArrayBufferObj;
+   ib.obj = ctx->Array.VAO->IndexBufferObj;
    ib.ptr = NULL;
 
    prim[0].begin = 1;
index 01c4c0e7c6c2ed81cf4687156693f00ec8bebd28..98ab68623b4b2db2bc44cd9e22258206100f17f5 100644 (file)
@@ -1138,9 +1138,9 @@ _save_OBE_DrawElements(GLenum mode, GLsizei count, GLenum type,
 
    _ae_map_vbos(ctx);
 
-   if (_mesa_is_bufferobj(ctx->Array.VAO->ElementArrayBufferObj))
+   if (_mesa_is_bufferobj(ctx->Array.VAO->IndexBufferObj))
       indices =
-         ADD_POINTERS(ctx->Array.VAO->ElementArrayBufferObj->Pointer, indices);
+         ADD_POINTERS(ctx->Array.VAO->IndexBufferObj->Pointer, indices);
 
    vbo_save_NotifyBegin(ctx, (mode | VBO_SAVE_PRIM_WEAK |
                               VBO_SAVE_PRIM_NO_CURRENT_UPDATE));