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