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 {
  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    GLuint draw_id;
  62
  63    GLsizeiptr indirect_offset;
  64 };
  65
  66 /* Would like to call this a "vbo_index_buffer", but this would be
  67  * confusing as the indices are not neccessarily yet in a non-null
  68  * buffer object.
  69  */
  70 struct _mesa_index_buffer
  71 {
  72    GLuint count;
  73    unsigned index_size;
  74    struct gl_buffer_object *obj;
  75    const void *ptr;
  76 };
  77
  78
  79
  80 GLboolean
  81 _vbo_CreateContext(struct gl_context *ctx);
  82
  83 void
  84 _vbo_DestroyContext(struct gl_context *ctx);
  85
  86 void
  87 vbo_exec_invalidate_state(struct gl_context *ctx);
  88
  89 void
  90 _vbo_install_exec_vtxfmt(struct gl_context *ctx);
  91
  92 void
  93 vbo_initialize_exec_dispatch(const struct gl_context *ctx,
  94                              struct _glapi_table *exec);
  95
  96 void
  97 vbo_initialize_save_dispatch(const struct gl_context *ctx,
  98                              struct _glapi_table *exec);
  99
 100 void
 101 vbo_exec_FlushVertices(struct gl_context *ctx, GLuint flags);
 102
 103 void
 104 vbo_save_SaveFlushVertices(struct gl_context *ctx);
 105
 106 void
 107 vbo_save_NotifyBegin(struct gl_context *ctx, GLenum mode);
 108
 109 void
 110 vbo_save_NewList(struct gl_context *ctx, GLuint list, GLenum mode);
 111
 112 void
 113 vbo_save_EndList(struct gl_context *ctx);
 114
 115 void
 116 vbo_save_BeginCallList(struct gl_context *ctx, struct gl_display_list *list);
 117
 118 void
 119 vbo_save_EndCallList(struct gl_context *ctx);
 120
 121
 122 /**
 123  * For indirect array drawing:
 124  *
 125  *    typedef struct {
 126  *       GLuint count;
 127  *       GLuint primCount;
 128  *       GLuint first;
 129  *       GLuint baseInstance; // in GL 4.2 and later, must be zero otherwise
 130  *    } DrawArraysIndirectCommand;
 131  *
 132  * For indirect indexed drawing:
 133  *
 134  *    typedef struct {
 135  *       GLuint count;
 136  *       GLuint primCount;
 137  *       GLuint firstIndex;
 138  *       GLint  baseVertex;
 139  *       GLuint baseInstance; // in GL 4.2 and later, must be zero otherwise
 140  *    } DrawElementsIndirectCommand;
 141  */
 142
 143
 144 /**
 145  * Draw a number of primitives.
 146  * \param prims  array [nr_prims] describing what to draw (prim type,
 147  *               vertex count, first index, instance count, etc).
 148  * \param ib  index buffer for indexed drawing, NULL for array drawing
 149  * \param index_bounds_valid  are min_index and max_index valid?
 150  * \param min_index  lowest vertex index used
 151  * \param max_index  highest vertex index used
 152  * \param tfb_vertcount  describes TFB output, or NULL
 153  * \param stream  If called via DrawTransformFeedback, specifies the vertex
 154  *                stream buffer from which to get the vertex count
 155  * \param indirect  If any prims are indirect, this specifies the buffer
 156  *                  to find the "DrawArrays/ElementsIndirectCommand" data.
 157  *                  This may be deprecated in the future
 158  */
 159 typedef void (*vbo_draw_func)(struct gl_context *ctx,
 160                               const struct _mesa_prim *prims,
 161                               GLuint nr_prims,
 162                               const struct _mesa_index_buffer *ib,
 163                               GLboolean index_bounds_valid,
 164                               GLuint min_index,
 165                               GLuint max_index,
 166                               struct gl_transform_feedback_object *tfb_vertcount,
 167                               unsigned stream,
 168                               struct gl_buffer_object *indirect);
 169
 170
 171 /**
 172  * Draw a primitive, getting the vertex count, instance count, start
 173  * vertex, etc. from a buffer object.
 174  * \param mode  GL_POINTS, GL_LINES, GL_TRIANGLE_STRIP, etc.
 175  * \param indirect_data  buffer to get "DrawArrays/ElementsIndirectCommand" data
 176  * \param indirect_offset  offset of first primitive in indrect_data buffer
 177  * \param draw_count  number of primitives to draw
 178  * \param stride  stride, in bytes, between "DrawArrays/ElementsIndirectCommand"
 179  *                objects
 180  * \param indirect_draw_count_buffer  if non-NULL specifies a buffer to get the
 181  *                                    real draw_count value.  Used for
 182  *                                    GL_ARB_indirect_parameters.
 183  * \param indirect_draw_count_offset  offset to the draw_count value in
 184  *                                    indirect_draw_count_buffer
 185  * \param ib  index buffer for indexed drawing, NULL otherwise.
 186  */
 187 typedef void (*vbo_indirect_draw_func)(
 188    struct gl_context *ctx,
 189    GLuint mode,
 190    struct gl_buffer_object *indirect_data,
 191    GLsizeiptr indirect_offset,
 192    unsigned draw_count,
 193    unsigned stride,
 194    struct gl_buffer_object *indirect_draw_count_buffer,
 195    GLsizeiptr indirect_draw_count_offset,
 196    const struct _mesa_index_buffer *ib);
 197
 198
 199
 200
 201 /* Utility function to cope with various constraints on tnl modules or
 202  * hardware.  This can be used to split an incoming set of arrays and
 203  * primitives against the following constraints:
 204  *    - Maximum number of indices in index buffer.
 205  *    - Maximum number of vertices referenced by index buffer.
 206  *    - Maximum hardware vertex buffer size.
 207  */
 208 struct split_limits
 209 {
 210    GLuint max_verts;
 211    GLuint max_indices;
 212    GLuint max_vb_size;          /* bytes */
 213 };
 214
 215
 216 void
 217 vbo_split_prims(struct gl_context *ctx,
 218                 const struct gl_vertex_array *arrays[],
 219                 const struct _mesa_prim *prim,
 220                 GLuint nr_prims,
 221                 const struct _mesa_index_buffer *ib,
 222                 GLuint min_index,
 223                 GLuint max_index,
 224                 vbo_draw_func draw,
 225                 const struct split_limits *limits);
 226
 227
 228 void
 229 vbo_rebase_prims(struct gl_context *ctx,
 230                  const struct gl_vertex_array *arrays[],
 231                  const struct _mesa_prim *prim,
 232                  GLuint nr_prims,
 233                  const struct _mesa_index_buffer *ib,
 234                  GLuint min_index,
 235                  GLuint max_index,
 236                  vbo_draw_func draw);
 237
 238
 239 void
 240 vbo_delete_minmax_cache(struct gl_buffer_object *bufferObj);
 241
 242 void
 243 vbo_get_minmax_indices(struct gl_context *ctx, const struct _mesa_prim *prim,
 244                        const struct _mesa_index_buffer *ib,
 245                        GLuint *min_index, GLuint *max_index, GLuint nr_prims);
 246
 247 void
 248 vbo_use_buffer_objects(struct gl_context *ctx);
 249
 250 void
 251 vbo_always_unmap_buffers(struct gl_context *ctx);
 252
 253 void
 254 vbo_set_draw_func(struct gl_context *ctx, vbo_draw_func func);
 255
 256 void
 257 vbo_set_indirect_draw_func(struct gl_context *ctx,
 258                            vbo_indirect_draw_func func);
 259
 260 void
 261 vbo_sw_primitive_restart(struct gl_context *ctx,
 262                          const struct _mesa_prim *prim,
 263                          GLuint nr_prims,
 264                          const struct _mesa_index_buffer *ib,
 265                          struct gl_buffer_object *indirect);
 266
 267 void GLAPIENTRY
 268 _es_Color4f(GLfloat r, GLfloat g, GLfloat b, GLfloat a);
 269
 270 void GLAPIENTRY
 271 _es_Normal3f(GLfloat x, GLfloat y, GLfloat z);
 272
 273 void GLAPIENTRY
 274 _es_MultiTexCoord4f(GLenum target, GLfloat s, GLfloat t, GLfloat r, GLfloat q);
 275
 276 void GLAPIENTRY
 277 _es_Materialfv(GLenum face, GLenum pname, const GLfloat *params);
 278
 279 void GLAPIENTRY
 280 _es_Materialf(GLenum face, GLenum pname, GLfloat param);
 281
 282 void GLAPIENTRY
 283 _es_VertexAttrib4f(GLuint index, GLfloat x, GLfloat y, GLfloat z, GLfloat w);
 284
 285 void GLAPIENTRY
 286 _es_VertexAttrib1f(GLuint indx, GLfloat x);
 287
 288 void GLAPIENTRY
 289 _es_VertexAttrib1fv(GLuint indx, const GLfloat* values);
 290
 291 void GLAPIENTRY
 292 _es_VertexAttrib2f(GLuint indx, GLfloat x, GLfloat y);
 293
 294 void GLAPIENTRY
 295 _es_VertexAttrib2fv(GLuint indx, const GLfloat* values);
 296
 297 void GLAPIENTRY
 298 _es_VertexAttrib3f(GLuint indx, GLfloat x, GLfloat y, GLfloat z);
 299
 300 void GLAPIENTRY
 301 _es_VertexAttrib3fv(GLuint indx, const GLfloat* values);
 302
 303 void GLAPIENTRY
 304 _es_VertexAttrib4fv(GLuint indx, const GLfloat* values);
 305
 306 #ifdef __cplusplus
 307 } // extern "C"
 308 #endif
 309
 310 #endif