2 * mesa 3-D graphics library
4 * Copyright (C) 1999-2006 Brian Paul All Rights Reserved.
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:
13 * The above copyright notice and this permission notice shall be included
14 * in all copies or substantial portions of the Software.
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.
26 * \brief Public interface to the VBO module
27 * \author Keith Whitwell
35 #include "main/glheader.h"
41 struct gl_vertex_array
;
43 struct gl_transform_feedback_object
;
47 GLuint mode
:8; /**< GL_POINTS, GL_LINES, GL_QUAD_STRIP, etc */
52 GLuint no_current_update
:1;
63 GLsizeiptr indirect_offset
;
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
70 struct _mesa_index_buffer
74 struct gl_buffer_object
*obj
;
81 _vbo_CreateContext(struct gl_context
*ctx
);
84 _vbo_DestroyContext(struct gl_context
*ctx
);
87 vbo_exec_invalidate_state(struct gl_context
*ctx
);
90 _vbo_install_exec_vtxfmt(struct gl_context
*ctx
);
93 vbo_initialize_exec_dispatch(const struct gl_context
*ctx
,
94 struct _glapi_table
*exec
);
97 vbo_initialize_save_dispatch(const struct gl_context
*ctx
,
98 struct _glapi_table
*exec
);
101 vbo_exec_FlushVertices(struct gl_context
*ctx
, GLuint flags
);
104 vbo_save_SaveFlushVertices(struct gl_context
*ctx
);
107 vbo_save_NotifyBegin(struct gl_context
*ctx
, GLenum mode
);
110 vbo_save_NewList(struct gl_context
*ctx
, GLuint list
, GLenum mode
);
113 vbo_save_EndList(struct gl_context
*ctx
);
116 vbo_save_BeginCallList(struct gl_context
*ctx
, struct gl_display_list
*list
);
119 vbo_save_EndCallList(struct gl_context
*ctx
);
123 * For indirect array drawing:
129 * GLuint baseInstance; // in GL 4.2 and later, must be zero otherwise
130 * } DrawArraysIndirectCommand;
132 * For indirect indexed drawing:
139 * GLuint baseInstance; // in GL 4.2 and later, must be zero otherwise
140 * } DrawElementsIndirectCommand;
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 if non-null, indicates which transform feedback
153 * object has the vertex count.
154 * \param tfb_stream If called via DrawTransformFeedbackStream, specifies the
155 * vertex stream buffer from which to get the vertex count.
156 * \param indirect If any prims are indirect, this specifies the buffer
157 * to find the "DrawArrays/ElementsIndirectCommand" data.
158 * This may be deprecated in the future
160 typedef void (*vbo_draw_func
)(struct gl_context
*ctx
,
161 const struct _mesa_prim
*prims
,
163 const struct _mesa_index_buffer
*ib
,
164 GLboolean index_bounds_valid
,
167 struct gl_transform_feedback_object
*tfb_vertcount
,
169 struct gl_buffer_object
*indirect
);
173 * Draw a primitive, getting the vertex count, instance count, start
174 * vertex, etc. from a buffer object.
175 * \param mode GL_POINTS, GL_LINES, GL_TRIANGLE_STRIP, etc.
176 * \param indirect_data buffer to get "DrawArrays/ElementsIndirectCommand" data
177 * \param indirect_offset offset of first primitive in indrect_data buffer
178 * \param draw_count number of primitives to draw
179 * \param stride stride, in bytes, between "DrawArrays/ElementsIndirectCommand"
181 * \param indirect_draw_count_buffer if non-NULL specifies a buffer to get the
182 * real draw_count value. Used for
183 * GL_ARB_indirect_parameters.
184 * \param indirect_draw_count_offset offset to the draw_count value in
185 * indirect_draw_count_buffer
186 * \param ib index buffer for indexed drawing, NULL otherwise.
188 typedef void (*vbo_indirect_draw_func
)(
189 struct gl_context
*ctx
,
191 struct gl_buffer_object
*indirect_data
,
192 GLsizeiptr indirect_offset
,
195 struct gl_buffer_object
*indirect_draw_count_buffer
,
196 GLsizeiptr indirect_draw_count_offset
,
197 const struct _mesa_index_buffer
*ib
);
202 /* Utility function to cope with various constraints on tnl modules or
203 * hardware. This can be used to split an incoming set of arrays and
204 * primitives against the following constraints:
205 * - Maximum number of indices in index buffer.
206 * - Maximum number of vertices referenced by index buffer.
207 * - Maximum hardware vertex buffer size.
213 GLuint max_vb_size
; /* bytes */
218 _vbo_draw(struct gl_context
*ctx
, const struct _mesa_prim
*prims
,
219 GLuint nr_prims
, const struct _mesa_index_buffer
*ib
,
220 GLboolean index_bounds_valid
, GLuint min_index
, GLuint max_index
,
221 struct gl_transform_feedback_object
*tfb_vertcount
,
222 unsigned tfb_stream
, struct gl_buffer_object
*indirect
);
226 _vbo_draw_indirect(struct gl_context
*ctx
, GLuint mode
,
227 struct gl_buffer_object
*indirect_data
,
228 GLsizeiptr indirect_offset
, unsigned draw_count
,
230 struct gl_buffer_object
*indirect_draw_count_buffer
,
231 GLsizeiptr indirect_draw_count_offset
,
232 const struct _mesa_index_buffer
*ib
);
236 vbo_split_prims(struct gl_context
*ctx
,
237 const struct gl_vertex_array
*arrays
,
238 const struct _mesa_prim
*prim
,
240 const struct _mesa_index_buffer
*ib
,
244 const struct split_limits
*limits
);
248 vbo_delete_minmax_cache(struct gl_buffer_object
*bufferObj
);
251 vbo_get_minmax_indices(struct gl_context
*ctx
, const struct _mesa_prim
*prim
,
252 const struct _mesa_index_buffer
*ib
,
253 GLuint
*min_index
, GLuint
*max_index
, GLuint nr_prims
);
256 vbo_use_buffer_objects(struct gl_context
*ctx
);
259 vbo_always_unmap_buffers(struct gl_context
*ctx
);
262 vbo_set_draw_func(struct gl_context
*ctx
, vbo_draw_func func
);
265 vbo_set_indirect_draw_func(struct gl_context
*ctx
,
266 vbo_indirect_draw_func func
);
269 vbo_sw_primitive_restart(struct gl_context
*ctx
,
270 const struct _mesa_prim
*prim
,
272 const struct _mesa_index_buffer
*ib
,
273 struct gl_buffer_object
*indirect
);
277 * Utility that tracks and updates the current array entries.
282 * Array of inputs to be set to the _DrawArrays pointer.
283 * The array contains pointers into the _DrawVAO and to the vbo modules
284 * current values. The array of pointers is updated incrementally
285 * based on the current and vertex_processing_mode values below.
287 struct gl_vertex_array inputs
[VERT_ATTRIB_MAX
];
288 /** Those VERT_BIT_'s where the inputs array point to current values. */
290 /** Store which aliasing current values - generics or materials - are set. */
291 gl_vertex_processing_mode vertex_processing_mode
;
299 _vbo_init_inputs(struct vbo_inputs
*inputs
);
303 * Update the gl_vertex_array array inside the vbo_inputs structure
304 * provided the current _VPMode, the provided vao and
305 * the vao's enabled arrays filtered by the filter bitmask.
308 _vbo_update_inputs(struct gl_context
*ctx
, struct vbo_inputs
*inputs
);
312 _es_Color4f(GLfloat r
, GLfloat g
, GLfloat b
, GLfloat a
);
315 _es_Normal3f(GLfloat x
, GLfloat y
, GLfloat z
);
318 _es_MultiTexCoord4f(GLenum target
, GLfloat s
, GLfloat t
, GLfloat r
, GLfloat q
);
321 _es_Materialfv(GLenum face
, GLenum pname
, const GLfloat
*params
);
324 _es_Materialf(GLenum face
, GLenum pname
, GLfloat param
);
327 _es_VertexAttrib4f(GLuint index
, GLfloat x
, GLfloat y
, GLfloat z
, GLfloat w
);
330 _es_VertexAttrib1f(GLuint indx
, GLfloat x
);
333 _es_VertexAttrib1fv(GLuint indx
, const GLfloat
* values
);
336 _es_VertexAttrib2f(GLuint indx
, GLfloat x
, GLfloat y
);
339 _es_VertexAttrib2fv(GLuint indx
, const GLfloat
* values
);
342 _es_VertexAttrib3f(GLuint indx
, GLfloat x
, GLfloat y
, GLfloat z
);
345 _es_VertexAttrib3fv(GLuint indx
, const GLfloat
* values
);
348 _es_VertexAttrib4fv(GLuint indx
, const GLfloat
* values
);