src/mesa/vbo/vbo.h

   1 /*
   2  * mesa 3-D graphics library
   3  * Version:  6.5
   4  *
   5  * Copyright (C) 1999-2006  Brian Paul   All Rights Reserved.
   6  *
   7  * Permission is hereby granted, free of charge, to any person obtaining a
   8  * copy of this software and associated documentation files (the "Software"),
   9  * to deal in the Software without restriction, including without limitation
  10  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
  11  * and/or sell copies of the Software, and to permit persons to whom the
  12  * Software is furnished to do so, subject to the following conditions:
  13  *
  14  * The above copyright notice and this permission notice shall be included
  15  * in all copies or substantial portions of the Software.
  16  *
  17  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
  18  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  19  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  20  * BRIAN PAUL BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
  21  * AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  22  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  23  */
  24
  25 /**
  26  * \file vbo_context.h
  27  * \brief VBO builder module datatypes and definitions.
  28  * \author Keith Whitwell
  29  */
  30
  31
  32 #ifndef _VBO_H
  33 #define _VBO_H
  34
  35 #include "main/glheader.h"
  36
  37 struct gl_client_array;
  38 struct gl_context;
  39 struct gl_transform_feedback_object;
  40
  41 struct _mesa_prim {
  42    GLuint mode:8;    /**< GL_POINTS, GL_LINES, GL_QUAD_STRIP, etc */
  43    GLuint indexed:1;
  44    GLuint begin:1;
  45    GLuint end:1;
  46    GLuint weak:1;
  47    GLuint no_current_update:1;
  48    GLuint pad:19;
  49
  50    GLuint start;
  51    GLuint count;
  52    GLint basevertex;
  53    GLsizei num_instances;
  54 };
  55
  56 /* Would like to call this a "vbo_index_buffer", but this would be
  57  * confusing as the indices are not neccessarily yet in a non-null
  58  * buffer object.
  59  */
  60 struct _mesa_index_buffer {
  61    GLuint count;
  62    GLenum type;
  63    struct gl_buffer_object *obj;
  64    const void *ptr;
  65 };
  66
  67
  68
  69 GLboolean _vbo_CreateContext( struct gl_context *ctx );
  70 void _vbo_DestroyContext( struct gl_context *ctx );
  71 void _vbo_InvalidateState( struct gl_context *ctx, GLuint new_state );
  72
  73
  74 typedef void (*vbo_draw_func)( struct gl_context *ctx,
  75                                const struct _mesa_prim *prims,
  76                                GLuint nr_prims,
  77                                const struct _mesa_index_buffer *ib,
  78                                GLboolean index_bounds_valid,
  79                                GLuint min_index,
  80                                GLuint max_index,
  81                                struct gl_transform_feedback_object *tfb_vertcount );
  82
  83
  84
  85
  86 /* Utility function to cope with various constraints on tnl modules or
  87  * hardware.  This can be used to split an incoming set of arrays and
  88  * primitives against the following constraints:
  89  *    - Maximum number of indices in index buffer.
  90  *    - Maximum number of vertices referenced by index buffer.
  91  *    - Maximum hardware vertex buffer size.
  92  */
  93 struct split_limits {
  94    GLuint max_verts;
  95    GLuint max_indices;
  96    GLuint max_vb_size;          /* bytes */
  97 };
  98
  99
 100 void vbo_split_prims( struct gl_context *ctx,
 101                       const struct gl_client_array *arrays[],
 102                       const struct _mesa_prim *prim,
 103                       GLuint nr_prims,
 104                       const struct _mesa_index_buffer *ib,
 105                       GLuint min_index,
 106                       GLuint max_index,
 107                       vbo_draw_func draw,
 108                       const struct split_limits *limits );
 109
 110
 111 /* Helpers for dealing translating away non-zero min_index.
 112  */
 113 GLboolean vbo_all_varyings_in_vbos( const struct gl_client_array *arrays[] );
 114 GLboolean vbo_any_varyings_in_vbos( const struct gl_client_array *arrays[] );
 115
 116 void vbo_rebase_prims( struct gl_context *ctx,
 117                        const struct gl_client_array *arrays[],
 118                        const struct _mesa_prim *prim,
 119                        GLuint nr_prims,
 120                        const struct _mesa_index_buffer *ib,
 121                        GLuint min_index,
 122                        GLuint max_index,
 123                        vbo_draw_func draw );
 124
 125 static inline int
 126 vbo_sizeof_ib_type(GLenum type)
 127 {
 128    switch (type) {
 129    case GL_UNSIGNED_INT:
 130       return sizeof(GLuint);
 131    case GL_UNSIGNED_SHORT:
 132       return sizeof(GLushort);
 133    case GL_UNSIGNED_BYTE:
 134       return sizeof(GLubyte);
 135    default:
 136       assert(!"unsupported index data type");
 137       /* In case assert is turned off */
 138       return 0;
 139    }
 140 }
 141
 142 void
 143 vbo_get_minmax_indices(struct gl_context *ctx, const struct _mesa_prim *prim,
 144                        const struct _mesa_index_buffer *ib,
 145                        GLuint *min_index, GLuint *max_index, GLuint nr_prims);
 146
 147 void vbo_use_buffer_objects(struct gl_context *ctx);
 148
 149 void vbo_always_unmap_buffers(struct gl_context *ctx);
 150
 151 void vbo_set_draw_func(struct gl_context *ctx, vbo_draw_func func);
 152
 153 void vbo_check_buffers_are_unmapped(struct gl_context *ctx);
 154
 155 void vbo_bind_arrays(struct gl_context *ctx);
 156
 157 size_t
 158 count_tessellated_primitives(const struct _mesa_prim *prim);
 159
 160 void
 161 vbo_sw_primitive_restart(struct gl_context *ctx,
 162                          const struct _mesa_prim *prim,
 163                          GLuint nr_prims,
 164                          const struct _mesa_index_buffer *ib);
 165
 166 void GLAPIENTRY
 167 _es_Color4f(GLfloat r, GLfloat g, GLfloat b, GLfloat a);
 168
 169 void GLAPIENTRY
 170 _es_Normal3f(GLfloat x, GLfloat y, GLfloat z);
 171
 172 void GLAPIENTRY
 173 _es_MultiTexCoord4f(GLenum target, GLfloat s, GLfloat t, GLfloat r, GLfloat q);
 174
 175 void GLAPIENTRY
 176 _es_Materialfv(GLenum face, GLenum pname, const GLfloat *params);
 177
 178 void GLAPIENTRY
 179 _es_Materialf(GLenum face, GLenum pname, GLfloat param);
 180
 181 void GLAPIENTRY
 182 _es_VertexAttrib4f(GLuint index, GLfloat x, GLfloat y, GLfloat z, GLfloat w);
 183
 184 void GLAPIENTRY
 185 _es_VertexAttrib1f(GLuint indx, GLfloat x);
 186
 187 void GLAPIENTRY
 188 _es_VertexAttrib1fv(GLuint indx, const GLfloat* values);
 189
 190 void GLAPIENTRY
 191 _es_VertexAttrib2f(GLuint indx, GLfloat x, GLfloat y);
 192
 193 void GLAPIENTRY
 194 _es_VertexAttrib2fv(GLuint indx, const GLfloat* values);
 195
 196 void GLAPIENTRY
 197 _es_VertexAttrib3f(GLuint indx, GLfloat x, GLfloat y, GLfloat z);
 198
 199 void GLAPIENTRY
 200 _es_VertexAttrib3fv(GLuint indx, const GLfloat* values);
 201
 202 void GLAPIENTRY
 203 _es_VertexAttrib4fv(GLuint indx, const GLfloat* values);
 204
 205 #endif