src/mesa/vbo/vbo.h

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