Merge branch 'mesa_7_6_branch'
[mesa.git] / src / mesa / vbo / vbo.h
1 /*
2 * mesa 3-D graphics library
3 * Version: 6.5
4 *
5 * Copyright (C) 1999-2006 Brian Paul All Rights Reserved.
6 *
7 * Permission is hereby granted, free of charge, to any person obtaining a
8 * copy of this software and associated documentation files (the "Software"),
9 * to deal in the Software without restriction, including without limitation
10 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
11 * and/or sell copies of the Software, and to permit persons to whom the
12 * Software is furnished to do so, subject to the following conditions:
13 *
14 * The above copyright notice and this permission notice shall be included
15 * in all copies or substantial portions of the Software.
16 *
17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
18 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
20 * BRIAN PAUL BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
21 * AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
22 * CONNECTION WITH THE SOFTWARE OR THE USE OR 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 "main/mtypes.h"
36
37 struct _mesa_prim {
38 GLuint mode:8;
39 GLuint indexed:1;
40 GLuint begin:1;
41 GLuint end:1;
42 GLuint weak:1;
43 GLuint pad:20;
44
45 GLuint start;
46 GLuint count;
47 GLint basevertex;
48 };
49
50 /* Would like to call this a "vbo_index_buffer", but this would be
51 * confusing as the indices are not neccessarily yet in a non-null
52 * buffer object.
53 */
54 struct _mesa_index_buffer {
55 GLuint count;
56 GLenum type;
57 struct gl_buffer_object *obj;
58 const void *ptr;
59 };
60
61
62
63 GLboolean _vbo_CreateContext( GLcontext *ctx );
64 void _vbo_DestroyContext( GLcontext *ctx );
65 void _vbo_InvalidateState( GLcontext *ctx, GLuint new_state );
66
67
68 typedef void (*vbo_draw_func)( GLcontext *ctx,
69 const struct gl_client_array **arrays,
70 const struct _mesa_prim *prims,
71 GLuint nr_prims,
72 const struct _mesa_index_buffer *ib,
73 GLboolean index_bounds_valid,
74 GLuint min_index,
75 GLuint max_index );
76
77
78
79
80 /* Utility function to cope with various constraints on tnl modules or
81 * hardware. This can be used to split an incoming set of arrays and
82 * primitives against the following constraints:
83 * - Maximum number of indices in index buffer.
84 * - Maximum number of vertices referenced by index buffer.
85 * - Maximum hardware vertex buffer size.
86 */
87 struct split_limits {
88 GLuint max_verts;
89 GLuint max_indices;
90 GLuint max_vb_size; /* bytes */
91 };
92
93
94 void vbo_split_prims( GLcontext *ctx,
95 const struct gl_client_array *arrays[],
96 const struct _mesa_prim *prim,
97 GLuint nr_prims,
98 const struct _mesa_index_buffer *ib,
99 GLuint min_index,
100 GLuint max_index,
101 vbo_draw_func draw,
102 const struct split_limits *limits );
103
104
105 /* Helpers for dealing translating away non-zero min_index.
106 */
107 GLboolean vbo_all_varyings_in_vbos( const struct gl_client_array *arrays[] );
108
109 void vbo_rebase_prims( GLcontext *ctx,
110 const struct gl_client_array *arrays[],
111 const struct _mesa_prim *prim,
112 GLuint nr_prims,
113 const struct _mesa_index_buffer *ib,
114 GLuint min_index,
115 GLuint max_index,
116 vbo_draw_func draw );
117 void
118 vbo_get_minmax_index(GLcontext *ctx, const struct _mesa_prim *prim,
119 const struct _mesa_index_buffer *ib,
120 GLuint *min_index, GLuint *max_index);
121
122 void vbo_use_buffer_objects(GLcontext *ctx);
123
124
125 void vbo_set_draw_func(GLcontext *ctx, vbo_draw_func func);
126
127
128 void GLAPIENTRY
129 _vbo_Color4f(GLfloat r, GLfloat g, GLfloat b, GLfloat a);
130
131 void GLAPIENTRY
132 _vbo_Normal3f(GLfloat x, GLfloat y, GLfloat z);
133
134 void GLAPIENTRY
135 _vbo_MultiTexCoord4f(GLenum target, GLfloat s, GLfloat t, GLfloat r, GLfloat q);
136
137 void GLAPIENTRY
138 _vbo_Materialfv(GLenum face, GLenum pname, const GLfloat *params);
139
140 void GLAPIENTRY
141 _vbo_VertexAttrib4f(GLuint index, GLfloat x, GLfloat y, GLfloat z, GLfloat w);
142
143 #endif