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 struct gl_client_array;
  39 struct gl_context;
  40 struct gl_transform_feedback_object;
  41
  42 struct _mesa_prim {
  43    GLuint mode:8;    /**< GL_POINTS, GL_LINES, GL_QUAD_STRIP, etc */
  44    GLuint indexed:1;
  45    GLuint begin:1;
  46    GLuint end:1;
  47    GLuint weak:1;
  48    GLuint no_current_update:1;
  49    GLuint is_indirect:1;
  50    GLuint pad:18;
  51
  52    GLuint start;
  53    GLuint count;
  54    GLint basevertex;
  55    GLuint num_instances;
  56    GLuint base_instance;
  57
  58    GLsizeiptr indirect_offset;
  59 };
  60
  61 /* Would like to call this a "vbo_index_buffer", but this would be
  62  * confusing as the indices are not neccessarily yet in a non-null
  63  * buffer object.
  64  */
  65 struct _mesa_index_buffer {
  66    GLuint count;
  67    GLenum type;
  68    struct gl_buffer_object *obj;
  69    const void *ptr;
  70 };
  71
  72
  73
  74 GLboolean _vbo_CreateContext( struct gl_context *ctx );
  75 void _vbo_DestroyContext( struct gl_context *ctx );
  76 void _vbo_InvalidateState( struct gl_context *ctx, GLuint new_state );
  77
  78
  79 void
  80 vbo_initialize_exec_dispatch(const struct gl_context *ctx,
  81                              struct _glapi_table *exec);
  82
  83 void
  84 vbo_initialize_save_dispatch(const struct gl_context *ctx,
  85                              struct _glapi_table *exec);
  86
  87
  88 typedef void (*vbo_draw_func)( struct gl_context *ctx,
  89                                const struct _mesa_prim *prims,
  90                                GLuint nr_prims,
  91                                const struct _mesa_index_buffer *ib,
  92                                GLboolean index_bounds_valid,
  93                                GLuint min_index,
  94                                GLuint max_index,
  95                                struct gl_transform_feedback_object *tfb_vertcount,
  96                                struct gl_buffer_object *indirect );
  97
  98
  99
 100
 101 /* Utility function to cope with various constraints on tnl modules or
 102  * hardware.  This can be used to split an incoming set of arrays and
 103  * primitives against the following constraints:
 104  *    - Maximum number of indices in index buffer.
 105  *    - Maximum number of vertices referenced by index buffer.
 106  *    - Maximum hardware vertex buffer size.
 107  */
 108 struct split_limits {
 109    GLuint max_verts;
 110    GLuint max_indices;
 111    GLuint max_vb_size;          /* bytes */
 112 };
 113
 114
 115 void vbo_split_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                       const struct split_limits *limits );
 124
 125
 126 /* Helpers for dealing translating away non-zero min_index.
 127  */
 128 GLboolean vbo_all_varyings_in_vbos( const struct gl_client_array *arrays[] );
 129 GLboolean vbo_any_varyings_in_vbos( const struct gl_client_array *arrays[] );
 130
 131 void vbo_rebase_prims( struct gl_context *ctx,
 132                        const struct gl_client_array *arrays[],
 133                        const struct _mesa_prim *prim,
 134                        GLuint nr_prims,
 135                        const struct _mesa_index_buffer *ib,
 136                        GLuint min_index,
 137                        GLuint max_index,
 138                        vbo_draw_func draw );
 139
 140 static inline int
 141 vbo_sizeof_ib_type(GLenum type)
 142 {
 143    switch (type) {
 144    case GL_UNSIGNED_INT:
 145       return sizeof(GLuint);
 146    case GL_UNSIGNED_SHORT:
 147       return sizeof(GLushort);
 148    case GL_UNSIGNED_BYTE:
 149       return sizeof(GLubyte);
 150    default:
 151       assert(!"unsupported index data type");
 152       /* In case assert is turned off */
 153       return 0;
 154    }
 155 }
 156
 157 void
 158 vbo_get_minmax_indices(struct gl_context *ctx, const struct _mesa_prim *prim,
 159                        const struct _mesa_index_buffer *ib,
 160                        GLuint *min_index, GLuint *max_index, GLuint nr_prims);
 161
 162 void vbo_use_buffer_objects(struct gl_context *ctx);
 163
 164 void vbo_always_unmap_buffers(struct gl_context *ctx);
 165
 166 void vbo_set_draw_func(struct gl_context *ctx, vbo_draw_func func);
 167
 168 void vbo_check_buffers_are_unmapped(struct gl_context *ctx);
 169
 170 void vbo_bind_arrays(struct gl_context *ctx);
 171
 172 size_t
 173 vbo_count_tessellated_primitives(GLenum mode, GLuint count,
 174                                  GLuint num_instances);
 175
 176 void
 177 vbo_try_prim_conversion(struct _mesa_prim *p);
 178
 179 bool
 180 vbo_can_merge_prims(const struct _mesa_prim *p0, const struct _mesa_prim *p1);
 181
 182 void
 183 vbo_merge_prims(struct _mesa_prim *p0, const struct _mesa_prim *p1);
 184
 185 void
 186 vbo_sw_primitive_restart(struct gl_context *ctx,
 187                          const struct _mesa_prim *prim,
 188                          GLuint nr_prims,
 189                          const struct _mesa_index_buffer *ib,
 190                          struct gl_buffer_object *indirect);
 191
 192 void GLAPIENTRY
 193 _es_Color4f(GLfloat r, GLfloat g, GLfloat b, GLfloat a);
 194
 195 void GLAPIENTRY
 196 _es_Normal3f(GLfloat x, GLfloat y, GLfloat z);
 197
 198 void GLAPIENTRY
 199 _es_MultiTexCoord4f(GLenum target, GLfloat s, GLfloat t, GLfloat r, GLfloat q);
 200
 201 void GLAPIENTRY
 202 _es_Materialfv(GLenum face, GLenum pname, const GLfloat *params);
 203
 204 void GLAPIENTRY
 205 _es_Materialf(GLenum face, GLenum pname, GLfloat param);
 206
 207 void GLAPIENTRY
 208 _es_VertexAttrib4f(GLuint index, GLfloat x, GLfloat y, GLfloat z, GLfloat w);
 209
 210 void GLAPIENTRY
 211 _es_VertexAttrib1f(GLuint indx, GLfloat x);
 212
 213 void GLAPIENTRY
 214 _es_VertexAttrib1fv(GLuint indx, const GLfloat* values);
 215
 216 void GLAPIENTRY
 217 _es_VertexAttrib2f(GLuint indx, GLfloat x, GLfloat y);
 218
 219 void GLAPIENTRY
 220 _es_VertexAttrib2fv(GLuint indx, const GLfloat* values);
 221
 222 void GLAPIENTRY
 223 _es_VertexAttrib3f(GLuint indx, GLfloat x, GLfloat y, GLfloat z);
 224
 225 void GLAPIENTRY
 226 _es_VertexAttrib3fv(GLuint indx, const GLfloat* values);
 227
 228 void GLAPIENTRY
 229 _es_VertexAttrib4fv(GLuint indx, const GLfloat* values);
 230
 231 #endif