Home | History | Annotate | Download | only in vbo
      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_vertex_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    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    GLuint count;
     72    GLenum type;
     73    struct gl_buffer_object *obj;
     74    const void *ptr;
     75 };
     76 
     77 
     78 
     79 GLboolean _vbo_CreateContext( struct gl_context *ctx );
     80 void _vbo_DestroyContext( struct gl_context *ctx );
     81 void _vbo_InvalidateState( struct gl_context *ctx, GLbitfield new_state );
     82 
     83 
     84 void
     85 vbo_initialize_exec_dispatch(const struct gl_context *ctx,
     86                              struct _glapi_table *exec);
     87 
     88 void
     89 vbo_initialize_save_dispatch(const struct gl_context *ctx,
     90                              struct _glapi_table *exec);
     91 
     92 void vbo_exec_FlushVertices(struct gl_context *ctx, GLuint flags);
     93 void vbo_save_SaveFlushVertices(struct gl_context *ctx);
     94 GLboolean vbo_save_NotifyBegin(struct gl_context *ctx, GLenum mode);
     95 void vbo_save_NewList(struct gl_context *ctx, GLuint list, GLenum mode);
     96 void vbo_save_EndList(struct gl_context *ctx);
     97 void vbo_save_BeginCallList(struct gl_context *ctx, struct gl_display_list *list);
     98 void vbo_save_EndCallList(struct gl_context *ctx);
     99 
    100 
    101 typedef void (*vbo_draw_func)( struct gl_context *ctx,
    102 			       const struct _mesa_prim *prims,
    103 			       GLuint nr_prims,
    104 			       const struct _mesa_index_buffer *ib,
    105 			       GLboolean index_bounds_valid,
    106 			       GLuint min_index,
    107 			       GLuint max_index,
    108 			       struct gl_transform_feedback_object *tfb_vertcount,
    109                                unsigned stream,
    110 			       struct gl_buffer_object *indirect);
    111 
    112 
    113 typedef void (*vbo_indirect_draw_func)(
    114    struct gl_context *ctx,
    115    GLuint mode,
    116    struct gl_buffer_object *indirect_data,
    117    GLsizeiptr indirect_offset,
    118    unsigned draw_count,
    119    unsigned stride,
    120    struct gl_buffer_object *indirect_params,
    121    GLsizeiptr indirect_params_offset,
    122    const struct _mesa_index_buffer *ib);
    123 
    124 
    125 
    126 
    127 /* Utility function to cope with various constraints on tnl modules or
    128  * hardware.  This can be used to split an incoming set of arrays and
    129  * primitives against the following constraints:
    130  *    - Maximum number of indices in index buffer.
    131  *    - Maximum number of vertices referenced by index buffer.
    132  *    - Maximum hardware vertex buffer size.
    133  */
    134 struct split_limits {
    135    GLuint max_verts;
    136    GLuint max_indices;
    137    GLuint max_vb_size;		/* bytes */
    138 };
    139 
    140 
    141 void vbo_split_prims( struct gl_context *ctx,
    142 		      const struct gl_vertex_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 		      const struct split_limits *limits );
    150 
    151 
    152 /* Helpers for dealing translating away non-zero min_index.
    153  */
    154 GLboolean vbo_all_varyings_in_vbos( const struct gl_vertex_array *arrays[] );
    155 GLboolean vbo_any_varyings_in_vbos( const struct gl_vertex_array *arrays[] );
    156 
    157 void vbo_rebase_prims( struct gl_context *ctx,
    158 		       const struct gl_vertex_array *arrays[],
    159 		       const struct _mesa_prim *prim,
    160 		       GLuint nr_prims,
    161 		       const struct _mesa_index_buffer *ib,
    162 		       GLuint min_index,
    163 		       GLuint max_index,
    164 		       vbo_draw_func draw );
    165 
    166 static inline int
    167 vbo_sizeof_ib_type(GLenum type)
    168 {
    169    switch (type) {
    170    case GL_UNSIGNED_INT:
    171       return sizeof(GLuint);
    172    case GL_UNSIGNED_SHORT:
    173       return sizeof(GLushort);
    174    case GL_UNSIGNED_BYTE:
    175       return sizeof(GLubyte);
    176    default:
    177       assert(!"unsupported index data type");
    178       /* In case assert is turned off */
    179       return 0;
    180    }
    181 }
    182 
    183 void
    184 vbo_delete_minmax_cache(struct gl_buffer_object *bufferObj);
    185 
    186 void
    187 vbo_get_minmax_indices(struct gl_context *ctx, const struct _mesa_prim *prim,
    188                        const struct _mesa_index_buffer *ib,
    189                        GLuint *min_index, GLuint *max_index, GLuint nr_prims);
    190 
    191 void vbo_use_buffer_objects(struct gl_context *ctx);
    192 
    193 void vbo_always_unmap_buffers(struct gl_context *ctx);
    194 
    195 void vbo_set_draw_func(struct gl_context *ctx, vbo_draw_func func);
    196 
    197 void vbo_set_indirect_draw_func(struct gl_context *ctx,
    198                                 vbo_indirect_draw_func func);
    199 
    200 void vbo_bind_arrays(struct gl_context *ctx);
    201 
    202 size_t
    203 vbo_count_tessellated_primitives(GLenum mode, GLuint count,
    204                                  GLuint num_instances);
    205 
    206 void
    207 vbo_try_prim_conversion(struct _mesa_prim *p);
    208 
    209 bool
    210 vbo_can_merge_prims(const struct _mesa_prim *p0, const struct _mesa_prim *p1);
    211 
    212 void
    213 vbo_merge_prims(struct _mesa_prim *p0, const struct _mesa_prim *p1);
    214 
    215 void
    216 vbo_sw_primitive_restart(struct gl_context *ctx,
    217                          const struct _mesa_prim *prim,
    218                          GLuint nr_prims,
    219                          const struct _mesa_index_buffer *ib,
    220                          struct gl_buffer_object *indirect);
    221 
    222 void GLAPIENTRY
    223 _es_Color4f(GLfloat r, GLfloat g, GLfloat b, GLfloat a);
    224 
    225 void GLAPIENTRY
    226 _es_Normal3f(GLfloat x, GLfloat y, GLfloat z);
    227 
    228 void GLAPIENTRY
    229 _es_MultiTexCoord4f(GLenum target, GLfloat s, GLfloat t, GLfloat r, GLfloat q);
    230 
    231 void GLAPIENTRY
    232 _es_Materialfv(GLenum face, GLenum pname, const GLfloat *params);
    233 
    234 void GLAPIENTRY
    235 _es_Materialf(GLenum face, GLenum pname, GLfloat param);
    236 
    237 void GLAPIENTRY
    238 _es_VertexAttrib4f(GLuint index, GLfloat x, GLfloat y, GLfloat z, GLfloat w);
    239 
    240 void GLAPIENTRY
    241 _es_VertexAttrib1f(GLuint indx, GLfloat x);
    242 
    243 void GLAPIENTRY
    244 _es_VertexAttrib1fv(GLuint indx, const GLfloat* values);
    245 
    246 void GLAPIENTRY
    247 _es_VertexAttrib2f(GLuint indx, GLfloat x, GLfloat y);
    248 
    249 void GLAPIENTRY
    250 _es_VertexAttrib2fv(GLuint indx, const GLfloat* values);
    251 
    252 void GLAPIENTRY
    253 _es_VertexAttrib3f(GLuint indx, GLfloat x, GLfloat y, GLfloat z);
    254 
    255 void GLAPIENTRY
    256 _es_VertexAttrib3fv(GLuint indx, const GLfloat* values);
    257 
    258 void GLAPIENTRY
    259 _es_VertexAttrib4fv(GLuint indx, const GLfloat* values);
    260 
    261 #ifdef __cplusplus
    262 } // extern "C"
    263 #endif
    264 
    265 #endif
    266