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    GLuint base_instance;
  55 };
  56
  57 /* Would like to call this a "vbo_index_buffer", but this would be
  58  * confusing as the indices are not neccessarily yet in a non-null
  59  * buffer object.
  60  */
  61 struct _mesa_index_buffer {
  62    GLuint count;
  63    GLenum type;
  64    struct gl_buffer_object *obj;
  65    const void *ptr;
  66 };
  67
  68
  69
  70 GLboolean _vbo_CreateContext( struct gl_context *ctx );
  71 void _vbo_DestroyContext( struct gl_context *ctx );
  72 void _vbo_InvalidateState( struct gl_context *ctx, GLuint new_state );
  73
  74
  75 typedef void (*vbo_draw_func)( struct gl_context *ctx,
  76                                const struct _mesa_prim *prims,
  77                                GLuint nr_prims,
  78                                const struct _mesa_index_buffer *ib,
  79                                GLboolean index_bounds_valid,
  80                                GLuint min_index,
  81                                GLuint max_index,
  82                                struct gl_transform_feedback_object *tfb_vertcount );
  83
  84
  85
  86
  87 /* Utility function to cope with various constraints on tnl modules or
  88  * hardware.  This can be used to split an incoming set of arrays and
  89  * primitives against the following constraints:
  90  *    - Maximum number of indices in index buffer.
  91  *    - Maximum number of vertices referenced by index buffer.
  92  *    - Maximum hardware vertex buffer size.
  93  */
  94 struct split_limits {
  95    GLuint max_verts;
  96    GLuint max_indices;
  97    GLuint max_vb_size;          /* bytes */
  98 };
  99
 100
 101 void vbo_split_prims( struct gl_context *ctx,
 102                       const struct gl_client_array *arrays[],
 103                       const struct _mesa_prim *prim,
 104                       GLuint nr_prims,
 105                       const struct _mesa_index_buffer *ib,
 106                       GLuint min_index,
 107                       GLuint max_index,
 108                       vbo_draw_func draw,
 109                       const struct split_limits *limits );
 110
 111
 112 /* Helpers for dealing translating away non-zero min_index.
 113  */
 114 GLboolean vbo_all_varyings_in_vbos( const struct gl_client_array *arrays[] );
 115 GLboolean vbo_any_varyings_in_vbos( const struct gl_client_array *arrays[] );
 116
 117 void vbo_rebase_prims( struct gl_context *ctx,
 118                        const struct gl_client_array *arrays[],
 119                        const struct _mesa_prim *prim,
 120                        GLuint nr_prims,
 121                        const struct _mesa_index_buffer *ib,
 122                        GLuint min_index,
 123                        GLuint max_index,
 124                        vbo_draw_func draw );
 125
 126 static inline int
 127 vbo_sizeof_ib_type(GLenum type)
 128 {
 129    switch (type) {
 130    case GL_UNSIGNED_INT:
 131       return sizeof(GLuint);
 132    case GL_UNSIGNED_SHORT:
 133       return sizeof(GLushort);
 134    case GL_UNSIGNED_BYTE:
 135       return sizeof(GLubyte);
 136    default:
 137       assert(!"unsupported index data type");
 138       /* In case assert is turned off */
 139       return 0;
 140    }
 141 }
 142
 143 void
 144 vbo_get_minmax_indices(struct gl_context *ctx, const struct _mesa_prim *prim,
 145                        const struct _mesa_index_buffer *ib,
 146                        GLuint *min_index, GLuint *max_index, GLuint nr_prims);
 147
 148 void vbo_use_buffer_objects(struct gl_context *ctx);
 149
 150 void vbo_always_unmap_buffers(struct gl_context *ctx);
 151
 152 void vbo_set_draw_func(struct gl_context *ctx, vbo_draw_func func);
 153
 154 void vbo_check_buffers_are_unmapped(struct gl_context *ctx);
 155
 156 void vbo_bind_arrays(struct gl_context *ctx);
 157
 158 size_t
 159 count_tessellated_primitives(const struct _mesa_prim *prim);
 160
 161 void
 162 vbo_sw_primitive_restart(struct gl_context *ctx,
 163                          const struct _mesa_prim *prim,
 164                          GLuint nr_prims,
 165                          const struct _mesa_index_buffer *ib);
 166
 167 void GLAPIENTRY
 168 _es_Color4f(GLfloat r, GLfloat g, GLfloat b, GLfloat a);
 169
 170 void GLAPIENTRY
 171 _es_Normal3f(GLfloat x, GLfloat y, GLfloat z);
 172
 173 void GLAPIENTRY
 174 _es_MultiTexCoord4f(GLenum target, GLfloat s, GLfloat t, GLfloat r, GLfloat q);
 175
 176 void GLAPIENTRY
 177 _es_Materialfv(GLenum face, GLenum pname, const GLfloat *params);
 178
 179 void GLAPIENTRY
 180 _es_Materialf(GLenum face, GLenum pname, GLfloat param);
 181
 182 void GLAPIENTRY
 183 _es_VertexAttrib4f(GLuint index, GLfloat x, GLfloat y, GLfloat z, GLfloat w);
 184
 185 void GLAPIENTRY
 186 _es_VertexAttrib1f(GLuint indx, GLfloat x);
 187
 188 void GLAPIENTRY
 189 _es_VertexAttrib1fv(GLuint indx, const GLfloat* values);
 190
 191 void GLAPIENTRY
 192 _es_VertexAttrib2f(GLuint indx, GLfloat x, GLfloat y);
 193
 194 void GLAPIENTRY
 195 _es_VertexAttrib2fv(GLuint indx, const GLfloat* values);
 196
 197 void GLAPIENTRY
 198 _es_VertexAttrib3f(GLuint indx, GLfloat x, GLfloat y, GLfloat z);
 199
 200 void GLAPIENTRY
 201 _es_VertexAttrib3fv(GLuint indx, const GLfloat* values);
 202
 203 void GLAPIENTRY
 204 _es_VertexAttrib4fv(GLuint indx, const GLfloat* values);
 205
 206 #endif