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  * \brief Public interface to the VBO module
  27  * \author Keith Whitwell
  28  */
  29
  30
  31 #ifndef _VBO_H
  32 #define _VBO_H
  33
  34 #include <stdbool.h>
  35 #include "main/glheader.h"
  36
  37 #ifdef __cplusplus
  38 extern "C" {
  39 #endif
  40
  41 struct gl_vertex_array;
  42 struct gl_context;
  43 struct gl_transform_feedback_object;
  44
  45 struct _mesa_prim {
  46    GLuint mode:8;    /**< GL_POINTS, GL_LINES, GL_QUAD_STRIP, etc */
  47    GLuint indexed:1;
  48    GLuint begin:1;
  49    GLuint end:1;
  50    GLuint weak:1;
  51    GLuint no_current_update:1;
  52    GLuint is_indirect:1;
  53    GLuint pad:18;
  54
  55    GLuint start;
  56    GLuint count;
  57    GLint basevertex;
  58    GLuint num_instances;
  59    GLuint base_instance;
  60    GLuint draw_id;
  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    unsigned index_size;
  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
  81
  82 void
  83 vbo_exec_invalidate_state(struct gl_context *ctx);
  84
  85 void
  86 _vbo_install_exec_vtxfmt(struct gl_context *ctx);
  87
  88 void
  89 vbo_initialize_exec_dispatch(const struct gl_context *ctx,
  90                              struct _glapi_table *exec);
  91
  92 void
  93 vbo_initialize_save_dispatch(const struct gl_context *ctx,
  94                              struct _glapi_table *exec);
  95
  96 void vbo_exec_FlushVertices(struct gl_context *ctx, GLuint flags);
  97 void vbo_save_SaveFlushVertices(struct gl_context *ctx);
  98 void vbo_save_NotifyBegin(struct gl_context *ctx, GLenum mode);
  99 void vbo_save_NewList(struct gl_context *ctx, GLuint list, GLenum mode);
 100 void vbo_save_EndList(struct gl_context *ctx);
 101 void vbo_save_BeginCallList(struct gl_context *ctx, struct gl_display_list *list);
 102 void vbo_save_EndCallList(struct gl_context *ctx);
 103
 104
 105 typedef void (*vbo_draw_func)( struct gl_context *ctx,
 106                                const struct _mesa_prim *prims,
 107                                GLuint nr_prims,
 108                                const struct _mesa_index_buffer *ib,
 109                                GLboolean index_bounds_valid,
 110                                GLuint min_index,
 111                                GLuint max_index,
 112                                struct gl_transform_feedback_object *tfb_vertcount,
 113                                unsigned stream,
 114                                struct gl_buffer_object *indirect);
 115
 116
 117 typedef void (*vbo_indirect_draw_func)(
 118    struct gl_context *ctx,
 119    GLuint mode,
 120    struct gl_buffer_object *indirect_data,
 121    GLsizeiptr indirect_offset,
 122    unsigned draw_count,
 123    unsigned stride,
 124    struct gl_buffer_object *indirect_params,
 125    GLsizeiptr indirect_params_offset,
 126    const struct _mesa_index_buffer *ib);
 127
 128
 129
 130
 131 /* Utility function to cope with various constraints on tnl modules or
 132  * hardware.  This can be used to split an incoming set of arrays and
 133  * primitives against the following constraints:
 134  *    - Maximum number of indices in index buffer.
 135  *    - Maximum number of vertices referenced by index buffer.
 136  *    - Maximum hardware vertex buffer size.
 137  */
 138 struct split_limits {
 139    GLuint max_verts;
 140    GLuint max_indices;
 141    GLuint max_vb_size;          /* bytes */
 142 };
 143
 144
 145 void vbo_split_prims( struct gl_context *ctx,
 146                       const struct gl_vertex_array *arrays[],
 147                       const struct _mesa_prim *prim,
 148                       GLuint nr_prims,
 149                       const struct _mesa_index_buffer *ib,
 150                       GLuint min_index,
 151                       GLuint max_index,
 152                       vbo_draw_func draw,
 153                       const struct split_limits *limits );
 154
 155
 156 GLboolean vbo_all_varyings_in_vbos( const struct gl_vertex_array *arrays[] );
 157
 158 void vbo_rebase_prims( struct gl_context *ctx,
 159                        const struct gl_vertex_array *arrays[],
 160                        const struct _mesa_prim *prim,
 161                        GLuint nr_prims,
 162                        const struct _mesa_index_buffer *ib,
 163                        GLuint min_index,
 164                        GLuint max_index,
 165                        vbo_draw_func draw );
 166
 167
 168 void
 169 vbo_delete_minmax_cache(struct gl_buffer_object *bufferObj);
 170
 171 void
 172 vbo_get_minmax_indices(struct gl_context *ctx, const struct _mesa_prim *prim,
 173                        const struct _mesa_index_buffer *ib,
 174                        GLuint *min_index, GLuint *max_index, GLuint nr_prims);
 175
 176 void vbo_use_buffer_objects(struct gl_context *ctx);
 177
 178 void vbo_always_unmap_buffers(struct gl_context *ctx);
 179
 180 void vbo_set_draw_func(struct gl_context *ctx, vbo_draw_func func);
 181
 182 void vbo_set_indirect_draw_func(struct gl_context *ctx,
 183                                 vbo_indirect_draw_func func);
 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 #ifdef __cplusplus
 232 } // extern "C"
 233 #endif
 234
 235 #endif