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
  40 struct _mesa_prim {
  41    GLuint mode:8;    /**< GL_POINTS, GL_LINES, GL_QUAD_STRIP, etc */
  42    GLuint indexed:1;
  43    GLuint begin:1;
  44    GLuint end:1;
  45    GLuint weak:1;
  46    GLuint no_current_update:1;
  47    GLuint pad:19;
  48
  49    GLuint start;
  50    GLuint count;
  51    GLint basevertex;
  52    GLsizei num_instances;
  53 };
  54
  55 /* Would like to call this a "vbo_index_buffer", but this would be
  56  * confusing as the indices are not neccessarily yet in a non-null
  57  * buffer object.
  58  */
  59 struct _mesa_index_buffer {
  60    GLuint count;
  61    GLenum type;
  62    struct gl_buffer_object *obj;
  63    const void *ptr;
  64 };
  65
  66
  67
  68 GLboolean _vbo_CreateContext( struct gl_context *ctx );
  69 void _vbo_DestroyContext( struct gl_context *ctx );
  70 void _vbo_InvalidateState( struct gl_context *ctx, GLuint new_state );
  71
  72
  73 typedef void (*vbo_draw_func)( struct gl_context *ctx,
  74                                const struct gl_client_array **arrays,
  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
  82
  83
  84
  85 /* Utility function to cope with various constraints on tnl modules or
  86  * hardware.  This can be used to split an incoming set of arrays and
  87  * primitives against the following constraints:
  88  *    - Maximum number of indices in index buffer.
  89  *    - Maximum number of vertices referenced by index buffer.
  90  *    - Maximum hardware vertex buffer size.
  91  */
  92 struct split_limits {
  93    GLuint max_verts;
  94    GLuint max_indices;
  95    GLuint max_vb_size;          /* bytes */
  96 };
  97
  98
  99 void vbo_split_prims( struct gl_context *ctx,
 100                       const struct gl_client_array *arrays[],
 101                       const struct _mesa_prim *prim,
 102                       GLuint nr_prims,
 103                       const struct _mesa_index_buffer *ib,
 104                       GLuint min_index,
 105                       GLuint max_index,
 106                       vbo_draw_func draw,
 107                       const struct split_limits *limits );
 108
 109
 110 /* Helpers for dealing translating away non-zero min_index.
 111  */
 112 GLboolean vbo_all_varyings_in_vbos( const struct gl_client_array *arrays[] );
 113 GLboolean vbo_any_varyings_in_vbos( const struct gl_client_array *arrays[] );
 114
 115 void vbo_rebase_prims( struct gl_context *ctx,
 116                        const struct gl_client_array *arrays[],
 117                        const struct _mesa_prim *prim,
 118                        GLuint nr_prims,
 119                        const struct _mesa_index_buffer *ib,
 120                        GLuint min_index,
 121                        GLuint max_index,
 122                        vbo_draw_func draw );
 123 void
 124 vbo_get_minmax_index(struct gl_context *ctx, const struct _mesa_prim *prim,
 125                      const struct _mesa_index_buffer *ib,
 126                      GLuint *min_index, GLuint *max_index);
 127
 128 void vbo_use_buffer_objects(struct gl_context *ctx);
 129
 130 void vbo_always_unmap_buffers(struct gl_context *ctx);
 131
 132 void vbo_set_draw_func(struct gl_context *ctx, vbo_draw_func func);
 133
 134 void vbo_check_buffers_are_unmapped(struct gl_context *ctx);
 135
 136
 137 void GLAPIENTRY
 138 _es_Color4f(GLfloat r, GLfloat g, GLfloat b, GLfloat a);
 139
 140 void GLAPIENTRY
 141 _es_Normal3f(GLfloat x, GLfloat y, GLfloat z);
 142
 143 void GLAPIENTRY
 144 _es_MultiTexCoord4f(GLenum target, GLfloat s, GLfloat t, GLfloat r, GLfloat q);
 145
 146 void GLAPIENTRY
 147 _es_Materialfv(GLenum face, GLenum pname, const GLfloat *params);
 148
 149 void GLAPIENTRY
 150 _es_Materialf(GLenum face, GLenum pname, GLfloat param);
 151
 152 void GLAPIENTRY
 153 _es_VertexAttrib4f(GLuint index, GLfloat x, GLfloat y, GLfloat z, GLfloat w);
 154
 155 void GLAPIENTRY
 156 _es_VertexAttrib1f(GLuint indx, GLfloat x);
 157
 158 void GLAPIENTRY
 159 _es_VertexAttrib1fv(GLuint indx, const GLfloat* values);
 160
 161 void GLAPIENTRY
 162 _es_VertexAttrib2f(GLuint indx, GLfloat x, GLfloat y);
 163
 164 void GLAPIENTRY
 165 _es_VertexAttrib2fv(GLuint indx, const GLfloat* values);
 166
 167 void GLAPIENTRY
 168 _es_VertexAttrib3f(GLuint indx, GLfloat x, GLfloat y, GLfloat z);
 169
 170 void GLAPIENTRY
 171 _es_VertexAttrib3fv(GLuint indx, const GLfloat* values);
 172
 173 void GLAPIENTRY
 174 _es_VertexAttrib4fv(GLuint indx, const GLfloat* values);
 175
 176 #endif