1 /*
2 * Mesa 3-D graphics library
3 *
4 * Copyright (C) 1999-2004 Brian Paul All Rights Reserved.
5 * (C) Copyright IBM Corporation 2006
6 * Copyright (C) 2009 VMware, Inc. All Rights Reserved.
7 *
8 * Permission is hereby granted, free of charge, to any person obtaining a
9 * copy of this software and associated documentation files (the "Software"),
10 * to deal in the Software without restriction, including without limitation
11 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
12 * and/or sell copies of the Software, and to permit persons to whom the
13 * Software is furnished to do so, subject to the following conditions:
14 *
15 * The above copyright notice and this permission notice shall be included
16 * in all copies or substantial portions of the Software.
17 *
18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
19 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
21 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
22 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
23 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
24 * OTHER DEALINGS IN THE SOFTWARE.
25 */
26
27 #ifndef ARRAYOBJ_H
28 #define ARRAYOBJ_H
29
30 #include "glheader.h"
31 #include "mtypes.h"
32 #include "glformats.h"
33 #include "vbo/vbo.h"
34
35 struct gl_context;
36
37 /**
38 * \file arrayobj.h
39 * Functions for the GL_ARB_vertex_array_object extension.
40 *
41 * \author Ian Romanick <idr@us.ibm.com>
42 * \author Brian Paul
43 */
44
45 /*
46 * Internal functions
47 */
48
49 extern struct gl_vertex_array_object *
50 _mesa_lookup_vao(struct gl_context *ctx, GLuint id);
51
52 extern struct gl_vertex_array_object *
53 _mesa_lookup_vao_err(struct gl_context *ctx, GLuint id,
54 bool is_ext_dsa, const char *caller);
55
56 extern struct gl_vertex_array_object *
57 _mesa_new_vao(struct gl_context *ctx, GLuint name);
58
59 extern void
60 _mesa_unbind_array_object_vbos(struct gl_context *ctx,
61 struct gl_vertex_array_object *obj);
62
63 extern void
64 _mesa_delete_vao(struct gl_context *ctx, struct gl_vertex_array_object *obj);
65
66 extern void
67 _mesa_reference_vao_(struct gl_context *ctx,
68 struct gl_vertex_array_object **ptr,
69 struct gl_vertex_array_object *vao);
70
71 static inline void
_mesa_reference_vao(struct gl_context * ctx,struct gl_vertex_array_object ** ptr,struct gl_vertex_array_object * vao)72 _mesa_reference_vao(struct gl_context *ctx,
73 struct gl_vertex_array_object **ptr,
74 struct gl_vertex_array_object *vao)
75 {
76 if (*ptr != vao)
77 _mesa_reference_vao_(ctx, ptr, vao);
78 }
79
80
81 extern void
82 _mesa_initialize_vao(struct gl_context *ctx,
83 struct gl_vertex_array_object *obj, GLuint name);
84
85
86 extern void
87 _mesa_update_vao_derived_arrays(struct gl_context *ctx,
88 struct gl_vertex_array_object *vao);
89
90
91 /**
92 * Mark the vao as shared and immutable, do remaining updates.
93 */
94 extern void
95 _mesa_set_vao_immutable(struct gl_context *ctx,
96 struct gl_vertex_array_object *vao);
97
98
99 /* Returns true if all varying arrays reside in vbos */
100 extern bool
101 _mesa_all_varyings_in_vbos(const struct gl_vertex_array_object *vao);
102
103 /* Returns true if all vbos are unmapped */
104 extern bool
105 _mesa_all_buffers_are_unmapped(const struct gl_vertex_array_object *vao);
106
107
108 extern void
109 _mesa_vao_map_arrays(struct gl_context *ctx, struct gl_vertex_array_object *vao,
110 GLbitfield access);
111
112 extern void
113 _mesa_vao_map(struct gl_context *ctx, struct gl_vertex_array_object *vao,
114 GLbitfield access);
115
116
117 extern void
118 _mesa_vao_unmap_arrays(struct gl_context *ctx,
119 struct gl_vertex_array_object *vao);
120
121 extern void
122 _mesa_vao_unmap(struct gl_context *ctx,
123 struct gl_vertex_array_object *vao);
124
125
126 /**
127 * Array to apply the position/generic0 aliasing map to
128 * an attribute value used in vertex processing inputs to an attribute
129 * as they appear in the vao.
130 */
131 extern const GLubyte
132 _mesa_vao_attribute_map[ATTRIBUTE_MAP_MODE_MAX][VERT_ATTRIB_MAX];
133
134
135 /**
136 * Apply the position/generic0 aliasing map to a bitfield from the vao.
137 * Use for example to convert gl_vertex_array_object::Enabled
138 * or gl_vertex_buffer_binding::_VertexBinding from the vao numbering to
139 * the numbering used with vertex processing inputs.
140 */
141 static inline GLbitfield
_mesa_vao_enable_to_vp_inputs(gl_attribute_map_mode mode,GLbitfield enabled)142 _mesa_vao_enable_to_vp_inputs(gl_attribute_map_mode mode, GLbitfield enabled)
143 {
144 switch (mode) {
145 case ATTRIBUTE_MAP_MODE_IDENTITY:
146 return enabled;
147 case ATTRIBUTE_MAP_MODE_POSITION:
148 /* Copy VERT_ATTRIB_POS enable bit into GENERIC0 position */
149 return (enabled & ~VERT_BIT_GENERIC0)
150 | ((enabled & VERT_BIT_POS) << VERT_ATTRIB_GENERIC0);
151 case ATTRIBUTE_MAP_MODE_GENERIC0:
152 /* Copy VERT_ATTRIB_GENERIC0 enable bit into POS position */
153 return (enabled & ~VERT_BIT_POS)
154 | ((enabled & VERT_BIT_GENERIC0) >> VERT_ATTRIB_GENERIC0);
155 default:
156 return 0;
157 }
158 }
159
160
161 /**
162 * Return the vp_inputs enabled bitmask after application of
163 * the position/generic0 aliasing map.
164 */
165 static inline GLbitfield
_mesa_get_vao_vp_inputs(const struct gl_vertex_array_object * vao)166 _mesa_get_vao_vp_inputs(const struct gl_vertex_array_object *vao)
167 {
168 const gl_attribute_map_mode mode = vao->_AttributeMapMode;
169 return _mesa_vao_enable_to_vp_inputs(mode, vao->Enabled);
170 }
171
172
173 /**
174 * Helper functions for consuming backends to walk the
175 * ctx->Array._DrawVAO for driver side array setup.
176 * Note that mesa provides preprocessed minimal binding information
177 * in the VAO. See _mesa_update_vao_derived_arrays for documentation.
178 */
179
180 /**
181 * Return enabled vertex attribute bits for draw.
182 */
183 static inline GLbitfield
_mesa_draw_array_bits(const struct gl_context * ctx)184 _mesa_draw_array_bits(const struct gl_context *ctx)
185 {
186 return ctx->Array._DrawVAOEnabledAttribs;
187 }
188
189
190 /**
191 * Return enabled buffer object vertex attribute bits for draw.
192 *
193 * Needs the a fully updated VAO ready for draw.
194 */
195 static inline GLbitfield
_mesa_draw_vbo_array_bits(const struct gl_context * ctx)196 _mesa_draw_vbo_array_bits(const struct gl_context *ctx)
197 {
198 const struct gl_vertex_array_object *const vao = ctx->Array._DrawVAO;
199 assert(vao->NewArrays == 0);
200 return vao->_EffEnabledVBO & ctx->Array._DrawVAOEnabledAttribs;
201 }
202
203
204 /**
205 * Return enabled user space vertex attribute bits for draw.
206 *
207 * Needs the a fully updated VAO ready for draw.
208 */
209 static inline GLbitfield
_mesa_draw_user_array_bits(const struct gl_context * ctx)210 _mesa_draw_user_array_bits(const struct gl_context *ctx)
211 {
212 const struct gl_vertex_array_object *const vao = ctx->Array._DrawVAO;
213 assert(vao->NewArrays == 0);
214 return ~vao->_EffEnabledVBO & ctx->Array._DrawVAOEnabledAttribs;
215 }
216
217
218 /**
219 * Return which enabled vertex attributes have a non-zero instance divisor.
220 *
221 * Needs the a fully updated VAO ready for draw.
222 */
223 static inline GLbitfield
_mesa_draw_nonzero_divisor_bits(const struct gl_context * ctx)224 _mesa_draw_nonzero_divisor_bits(const struct gl_context *ctx)
225 {
226 const struct gl_vertex_array_object *const vao = ctx->Array._DrawVAO;
227 assert(vao->NewArrays == 0);
228 return vao->_EffEnabledNonZeroDivisor & ctx->Array._DrawVAOEnabledAttribs;
229 }
230
231
232 /**
233 * Return enabled current values attribute bits for draw.
234 */
235 static inline GLbitfield
_mesa_draw_current_bits(const struct gl_context * ctx)236 _mesa_draw_current_bits(const struct gl_context *ctx)
237 {
238 return ~ctx->Array._DrawVAOEnabledAttribs & VERT_BIT_ALL;
239 }
240
241
242 /**
243 * Return vertex buffer binding provided the attribute struct.
244 *
245 * Needs the a fully updated VAO ready for draw.
246 */
247 static inline const struct gl_vertex_buffer_binding*
_mesa_draw_buffer_binding_from_attrib(const struct gl_vertex_array_object * vao,const struct gl_array_attributes * attrib)248 _mesa_draw_buffer_binding_from_attrib(const struct gl_vertex_array_object *vao,
249 const struct gl_array_attributes *attrib)
250 {
251 assert(vao->NewArrays == 0);
252 return &vao->BufferBinding[attrib->_EffBufferBindingIndex];
253 }
254
255
256 /**
257 * Return vertex array attribute provided the attribute number.
258 */
259 static inline const struct gl_array_attributes*
_mesa_draw_array_attrib(const struct gl_vertex_array_object * vao,gl_vert_attrib attr)260 _mesa_draw_array_attrib(const struct gl_vertex_array_object *vao,
261 gl_vert_attrib attr)
262 {
263 assert(vao->NewArrays == 0);
264 const gl_attribute_map_mode map_mode = vao->_AttributeMapMode;
265 return &vao->VertexAttrib[_mesa_vao_attribute_map[map_mode][attr]];
266 }
267
268
269 /**
270 * Return a vertex array vertex format provided the attribute number.
271 */
272 static inline const struct gl_vertex_format *
_mesa_draw_array_format(const struct gl_vertex_array_object * vao,gl_vert_attrib attr)273 _mesa_draw_array_format(const struct gl_vertex_array_object *vao,
274 gl_vert_attrib attr)
275 {
276 return &_mesa_draw_array_attrib(vao, attr)->Format;
277 }
278
279
280 /**
281 * Return vertex buffer binding provided an attribute number.
282 */
283 static inline const struct gl_vertex_buffer_binding*
_mesa_draw_buffer_binding(const struct gl_vertex_array_object * vao,gl_vert_attrib attr)284 _mesa_draw_buffer_binding(const struct gl_vertex_array_object *vao,
285 gl_vert_attrib attr)
286 {
287 const struct gl_array_attributes *const attrib
288 = _mesa_draw_array_attrib(vao, attr);
289 return _mesa_draw_buffer_binding_from_attrib(vao, attrib);
290 }
291
292
293 /**
294 * Return vertex attribute bits bound at the provided binding.
295 *
296 * Needs the a fully updated VAO ready for draw.
297 */
298 static inline GLbitfield
_mesa_draw_bound_attrib_bits(const struct gl_vertex_buffer_binding * binding)299 _mesa_draw_bound_attrib_bits(const struct gl_vertex_buffer_binding *binding)
300 {
301 return binding->_EffBoundArrays;
302 }
303
304
305 /**
306 * Return the vertex offset bound at the provided binding.
307 *
308 * Needs the a fully updated VAO ready for draw.
309 */
310 static inline GLintptr
_mesa_draw_binding_offset(const struct gl_vertex_buffer_binding * binding)311 _mesa_draw_binding_offset(const struct gl_vertex_buffer_binding *binding)
312 {
313 return binding->_EffOffset;
314 }
315
316
317 /**
318 * Return the relative offset of the provided attrib.
319 *
320 * Needs the a fully updated VAO ready for draw.
321 */
322 static inline GLushort
_mesa_draw_attributes_relative_offset(const struct gl_array_attributes * attrib)323 _mesa_draw_attributes_relative_offset(const struct gl_array_attributes *attrib)
324 {
325 return attrib->_EffRelativeOffset;
326 }
327
328
329 /**
330 * Return a current value vertex array attribute provided the attribute number.
331 */
332 static inline const struct gl_array_attributes*
_mesa_draw_current_attrib(const struct gl_context * ctx,gl_vert_attrib attr)333 _mesa_draw_current_attrib(const struct gl_context *ctx, gl_vert_attrib attr)
334 {
335 return _vbo_current_attrib(ctx, attr);
336 }
337
338
339 /**
340 * Return a current value vertex format provided the attribute number.
341 */
342 static inline const struct gl_vertex_format *
_mesa_draw_current_format(const struct gl_context * ctx,gl_vert_attrib attr)343 _mesa_draw_current_format(const struct gl_context *ctx, gl_vert_attrib attr)
344 {
345 return &_vbo_current_attrib(ctx, attr)->Format;
346 }
347
348
349 /**
350 * Return true if we have the VERT_ATTRIB_EDGEFLAG array enabled.
351 */
352 static inline bool
_mesa_draw_edge_flag_array_enabled(const struct gl_context * ctx)353 _mesa_draw_edge_flag_array_enabled(const struct gl_context *ctx)
354 {
355 return ctx->Array._DrawVAOEnabledAttribs & VERT_BIT_EDGEFLAG;
356 }
357
358
359 /*
360 * API functions
361 */
362
363
364 void GLAPIENTRY
365 _mesa_BindVertexArray_no_error(GLuint id);
366
367 void GLAPIENTRY _mesa_BindVertexArray( GLuint id );
368
369 void GLAPIENTRY
370 _mesa_DeleteVertexArrays_no_error(GLsizei n, const GLuint *ids);
371
372 void GLAPIENTRY _mesa_DeleteVertexArrays(GLsizei n, const GLuint *ids);
373
374 void GLAPIENTRY
375 _mesa_GenVertexArrays_no_error(GLsizei n, GLuint *arrays);
376
377 void GLAPIENTRY _mesa_GenVertexArrays(GLsizei n, GLuint *arrays);
378
379 void GLAPIENTRY
380 _mesa_CreateVertexArrays_no_error(GLsizei n, GLuint *arrays);
381
382 void GLAPIENTRY _mesa_CreateVertexArrays(GLsizei n, GLuint *arrays);
383
384 GLboolean GLAPIENTRY _mesa_IsVertexArray( GLuint id );
385
386 void GLAPIENTRY
387 _mesa_VertexArrayElementBuffer_no_error(GLuint vaobj, GLuint buffer);
388
389 void GLAPIENTRY _mesa_VertexArrayElementBuffer(GLuint vaobj, GLuint buffer);
390
391 void GLAPIENTRY _mesa_GetVertexArrayiv(GLuint vaobj, GLenum pname, GLint *param);
392
393 #endif /* ARRAYOBJ_H */
394