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
  96
  97 typedef void (*vbo_draw_func)( struct gl_context *ctx,
  98                                const struct _mesa_prim *prims,
  99                                GLuint nr_prims,
 100                                const struct _mesa_index_buffer *ib,
 101                                GLboolean index_bounds_valid,
 102                                GLuint min_index,
 103                                GLuint max_index,
 104                                struct gl_transform_feedback_object *tfb_vertcount,
 105                                unsigned stream,
 106                                struct gl_buffer_object *indirect);
 107
 108
 109
 110
 111 /* Utility function to cope with various constraints on tnl modules or
 112  * hardware.  This can be used to split an incoming set of arrays and
 113  * primitives against the following constraints:
 114  *    - Maximum number of indices in index buffer.
 115  *    - Maximum number of vertices referenced by index buffer.
 116  *    - Maximum hardware vertex buffer size.
 117  */
 118 struct split_limits {
 119    GLuint max_verts;
 120    GLuint max_indices;
 121    GLuint max_vb_size;          /* bytes */
 122 };
 123
 124
 125 void vbo_split_prims( struct gl_context *ctx,
 126                       const struct gl_client_array *arrays[],
 127                       const struct _mesa_prim *prim,
 128                       GLuint nr_prims,
 129                       const struct _mesa_index_buffer *ib,
 130                       GLuint min_index,
 131                       GLuint max_index,
 132                       vbo_draw_func draw,
 133                       const struct split_limits *limits );
 134
 135
 136 /* Helpers for dealing translating away non-zero min_index.
 137  */
 138 GLboolean vbo_all_varyings_in_vbos( const struct gl_client_array *arrays[] );
 139 GLboolean vbo_any_varyings_in_vbos( const struct gl_client_array *arrays[] );
 140
 141 void vbo_rebase_prims( struct gl_context *ctx,
 142                        const struct gl_client_array *arrays[],
 143                        const struct _mesa_prim *prim,
 144                        GLuint nr_prims,
 145                        const struct _mesa_index_buffer *ib,
 146                        GLuint min_index,
 147                        GLuint max_index,
 148                        vbo_draw_func draw );
 149
 150 static inline int
 151 vbo_sizeof_ib_type(GLenum type)
 152 {
 153    switch (type) {
 154    case GL_UNSIGNED_INT:
 155       return sizeof(GLuint);
 156    case GL_UNSIGNED_SHORT:
 157       return sizeof(GLushort);
 158    case GL_UNSIGNED_BYTE:
 159       return sizeof(GLubyte);
 160    default:
 161       assert(!"unsupported index data type");
 162       /* In case assert is turned off */
 163       return 0;
 164    }
 165 }
 166
 167 void
 168 vbo_get_minmax_indices(struct gl_context *ctx, const struct _mesa_prim *prim,
 169                        const struct _mesa_index_buffer *ib,
 170                        GLuint *min_index, GLuint *max_index, GLuint nr_prims);
 171
 172 void vbo_use_buffer_objects(struct gl_context *ctx);
 173
 174 void vbo_always_unmap_buffers(struct gl_context *ctx);
 175
 176 void vbo_set_draw_func(struct gl_context *ctx, vbo_draw_func func);
 177
 178 void vbo_check_buffers_are_unmapped(struct gl_context *ctx);
 179
 180 void vbo_bind_arrays(struct gl_context *ctx);
 181
 182 size_t
 183 vbo_count_tessellated_primitives(GLenum mode, GLuint count,
 184                                  GLuint num_instances);
 185
 186 void
 187 vbo_try_prim_conversion(struct _mesa_prim *p);
 188
 189 bool
 190 vbo_can_merge_prims(const struct _mesa_prim *p0, const struct _mesa_prim *p1);
 191
 192 void
 193 vbo_merge_prims(struct _mesa_prim *p0, const struct _mesa_prim *p1);
 194
 195 void
 196 vbo_sw_primitive_restart(struct gl_context *ctx,
 197                          const struct _mesa_prim *prim,
 198                          GLuint nr_prims,
 199                          const struct _mesa_index_buffer *ib,
 200                          struct gl_buffer_object *indirect);
 201
 202 void GLAPIENTRY
 203 _es_Color4f(GLfloat r, GLfloat g, GLfloat b, GLfloat a);
 204
 205 void GLAPIENTRY
 206 _es_Normal3f(GLfloat x, GLfloat y, GLfloat z);
 207
 208 void GLAPIENTRY
 209 _es_MultiTexCoord4f(GLenum target, GLfloat s, GLfloat t, GLfloat r, GLfloat q);
 210
 211 void GLAPIENTRY
 212 _es_Materialfv(GLenum face, GLenum pname, const GLfloat *params);
 213
 214 void GLAPIENTRY
 215 _es_Materialf(GLenum face, GLenum pname, GLfloat param);
 216
 217 void GLAPIENTRY
 218 _es_VertexAttrib4f(GLuint index, GLfloat x, GLfloat y, GLfloat z, GLfloat w);
 219
 220 void GLAPIENTRY
 221 _es_VertexAttrib1f(GLuint indx, GLfloat x);
 222
 223 void GLAPIENTRY
 224 _es_VertexAttrib1fv(GLuint indx, const GLfloat* values);
 225
 226 void GLAPIENTRY
 227 _es_VertexAttrib2f(GLuint indx, GLfloat x, GLfloat y);
 228
 229 void GLAPIENTRY
 230 _es_VertexAttrib2fv(GLuint indx, const GLfloat* values);
 231
 232 void GLAPIENTRY
 233 _es_VertexAttrib3f(GLuint indx, GLfloat x, GLfloat y, GLfloat z);
 234
 235 void GLAPIENTRY
 236 _es_VertexAttrib3fv(GLuint indx, const GLfloat* values);
 237
 238 void GLAPIENTRY
 239 _es_VertexAttrib4fv(GLuint indx, const GLfloat* values);
 240
 241 #ifdef __cplusplus
 242 } // extern "C"
 243 #endif
 244
 245 #endif