Merge commit 'origin/master' into gallium-0.2
[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 };
48
49 /* Would like to call this a "vbo_index_buffer", but this would be
50 * confusing as the indices are not neccessarily yet in a non-null
51 * buffer object.
52 */
53 struct _mesa_index_buffer {
54 GLuint count;
55 GLenum type;
56 struct gl_buffer_object *obj;
57 const void *ptr;
58 };
59
60
61
62 GLboolean _vbo_CreateContext( GLcontext *ctx );
63 void _vbo_DestroyContext( GLcontext *ctx );
64 void _vbo_InvalidateState( GLcontext *ctx, GLuint new_state );
65
66
67 typedef void (*vbo_draw_func)( GLcontext *ctx,
68 const struct gl_client_array **arrays,
69 const struct _mesa_prim *prims,
70 GLuint nr_prims,
71 const struct _mesa_index_buffer *ib,
72 GLuint min_index,
73 GLuint max_index );
74
75
76
77
78 /* Utility function to cope with various constraints on tnl modules or
79 * hardware. This can be used to split an incoming set of arrays and
80 * primitives against the following constraints:
81 * - Maximum number of indices in index buffer.
82 * - Maximum number of vertices referenced by index buffer.
83 * - Maximum hardware vertex buffer size.
84 */
85 struct split_limits {
86 GLuint max_verts;
87 GLuint max_indices;
88 GLuint max_vb_size; /* bytes */
89 };
90
91
92 void vbo_split_prims( GLcontext *ctx,
93 const struct gl_client_array *arrays[],
94 const struct _mesa_prim *prim,
95 GLuint nr_prims,
96 const struct _mesa_index_buffer *ib,
97 GLuint min_index,
98 GLuint max_index,
99 vbo_draw_func draw,
100 const struct split_limits *limits );
101
102
103 /* Helpers for dealing translating away non-zero min_index.
104 */
105 GLboolean vbo_all_varyings_in_vbos( const struct gl_client_array *arrays[] );
106
107 void vbo_rebase_prims( GLcontext *ctx,
108 const struct gl_client_array *arrays[],
109 const struct _mesa_prim *prim,
110 GLuint nr_prims,
111 const struct _mesa_index_buffer *ib,
112 GLuint min_index,
113 GLuint max_index,
114 vbo_draw_func draw );
115
116
117 void vbo_use_buffer_objects(GLcontext *ctx);
118
119
120 void vbo_set_draw_func(GLcontext *ctx, vbo_draw_func func);
121
122
123 void GLAPIENTRY
124 _vbo_Color4f(GLfloat r, GLfloat g, GLfloat b, GLfloat a);
125
126 void GLAPIENTRY
127 _vbo_Normal3f(GLfloat x, GLfloat y, GLfloat z);
128
129 void GLAPIENTRY
130 _vbo_MultiTexCoord4f(GLenum target, GLfloat s, GLfloat t, GLfloat r, GLfloat q);
131
132 void GLAPIENTRY
133 _vbo_Materialfv(GLenum face, GLenum pname, const GLfloat *params);
134
135 void GLAPIENTRY
136 _vbo_VertexAttrib4f(GLuint index, GLfloat x, GLfloat y, GLfloat z, GLfloat w);
137
138 #endif