src/mesa/main/arrayobj.h

   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_delete_vao(struct gl_context *ctx, struct gl_vertex_array_object *obj);
  61
  62 extern void
  63 _mesa_reference_vao_(struct gl_context *ctx,
  64                      struct gl_vertex_array_object **ptr,
  65                      struct gl_vertex_array_object *vao);
  66
  67 static inline void
  68 _mesa_reference_vao(struct gl_context *ctx,
  69                     struct gl_vertex_array_object **ptr,
  70                     struct gl_vertex_array_object *vao)
  71 {
  72    if (*ptr != vao)
  73       _mesa_reference_vao_(ctx, ptr, vao);
  74 }
  75
  76
  77 extern void
  78 _mesa_initialize_vao(struct gl_context *ctx,
  79                      struct gl_vertex_array_object *obj, GLuint name);
  80
  81
  82 extern void
  83 _mesa_update_vao_derived_arrays(struct gl_context *ctx,
  84                                 struct gl_vertex_array_object *vao);
  85
  86
  87 /**
  88  * Mark the vao as shared and immutable, do remaining updates.
  89  */
  90 extern void
  91 _mesa_set_vao_immutable(struct gl_context *ctx,
  92                         struct gl_vertex_array_object *vao);
  93
  94
  95 /* Returns true if all varying arrays reside in vbos */
  96 extern bool
  97 _mesa_all_varyings_in_vbos(const struct gl_vertex_array_object *vao);
  98
  99 /* Returns true if all vbos are unmapped */
 100 extern bool
 101 _mesa_all_buffers_are_unmapped(const struct gl_vertex_array_object *vao);
 102
 103
 104 extern void
 105 _mesa_vao_map_arrays(struct gl_context *ctx, struct gl_vertex_array_object *vao,
 106                      GLbitfield access);
 107
 108 extern void
 109 _mesa_vao_map(struct gl_context *ctx, struct gl_vertex_array_object *vao,
 110               GLbitfield access);
 111
 112
 113 extern void
 114 _mesa_vao_unmap_arrays(struct gl_context *ctx,
 115                        struct gl_vertex_array_object *vao);
 116
 117 extern void
 118 _mesa_vao_unmap(struct gl_context *ctx,
 119                 struct gl_vertex_array_object *vao);
 120
 121
 122 /**
 123  * Array to apply the position/generic0 aliasing map to
 124  * an attribute value used in vertex processing inputs to an attribute
 125  * as they appear in the vao.
 126  */
 127 extern const GLubyte
 128 _mesa_vao_attribute_map[ATTRIBUTE_MAP_MODE_MAX][VERT_ATTRIB_MAX];
 129
 130
 131 /**
 132  * Apply the position/generic0 aliasing map to a bitfield from the vao.
 133  * Use for example to convert gl_vertex_array_object::Enabled
 134  * or gl_vertex_buffer_binding::_VertexBinding from the vao numbering to
 135  * the numbering used with vertex processing inputs.
 136  */
 137 static inline GLbitfield
 138 _mesa_vao_enable_to_vp_inputs(gl_attribute_map_mode mode, GLbitfield enabled)
 139 {
 140    switch (mode) {
 141    case ATTRIBUTE_MAP_MODE_IDENTITY:
 142       return enabled;
 143    case ATTRIBUTE_MAP_MODE_POSITION:
 144       /* Copy VERT_ATTRIB_POS enable bit into GENERIC0 position */
 145       return (enabled & ~VERT_BIT_GENERIC0)
 146          | ((enabled & VERT_BIT_POS) << VERT_ATTRIB_GENERIC0);
 147    case ATTRIBUTE_MAP_MODE_GENERIC0:
 148       /* Copy VERT_ATTRIB_GENERIC0 enable bit into POS position */
 149       return (enabled & ~VERT_BIT_POS)
 150          | ((enabled & VERT_BIT_GENERIC0) >> VERT_ATTRIB_GENERIC0);
 151    default:
 152       return 0;
 153    }
 154 }
 155
 156
 157 /**
 158  * Return the vp_inputs enabled bitmask after application of
 159  * the position/generic0 aliasing map.
 160  */
 161 static inline GLbitfield
 162 _mesa_get_vao_vp_inputs(const struct gl_vertex_array_object *vao)
 163 {
 164    const gl_attribute_map_mode mode = vao->_AttributeMapMode;
 165    return _mesa_vao_enable_to_vp_inputs(mode, vao->Enabled);
 166 }
 167
 168
 169 /**
 170  * Helper functions for consuming backends to walk the
 171  * ctx->Array._DrawVAO for driver side array setup.
 172  * Note that mesa provides preprocessed minimal binding information
 173  * in the VAO. See _mesa_update_vao_derived_arrays for documentation.
 174  */
 175
 176 /**
 177  * Return enabled vertex attribute bits for draw.
 178  */
 179 static inline GLbitfield
 180 _mesa_draw_array_bits(const struct gl_context *ctx)
 181 {
 182    return ctx->Array._DrawVAOEnabledAttribs;
 183 }
 184
 185
 186 /**
 187  * Return enabled buffer object vertex attribute bits for draw.
 188  *
 189  * Needs the a fully updated VAO ready for draw.
 190  */
 191 static inline GLbitfield
 192 _mesa_draw_vbo_array_bits(const struct gl_context *ctx)
 193 {
 194    const struct gl_vertex_array_object *const vao = ctx->Array._DrawVAO;
 195    assert(vao->NewArrays == 0);
 196    return vao->_EffEnabledVBO & ctx->Array._DrawVAOEnabledAttribs;
 197 }
 198
 199
 200 /**
 201  * Return enabled user space vertex attribute bits for draw.
 202  *
 203  * Needs the a fully updated VAO ready for draw.
 204  */
 205 static inline GLbitfield
 206 _mesa_draw_user_array_bits(const struct gl_context *ctx)
 207 {
 208    const struct gl_vertex_array_object *const vao = ctx->Array._DrawVAO;
 209    assert(vao->NewArrays == 0);
 210    return ~vao->_EffEnabledVBO & ctx->Array._DrawVAOEnabledAttribs;
 211 }
 212
 213
 214 /**
 215  * Return which enabled vertex attributes have a non-zero instance divisor.
 216  *
 217  * Needs the a fully updated VAO ready for draw.
 218  */
 219 static inline GLbitfield
 220 _mesa_draw_nonzero_divisor_bits(const struct gl_context *ctx)
 221 {
 222    const struct gl_vertex_array_object *const vao = ctx->Array._DrawVAO;
 223    assert(vao->NewArrays == 0);
 224    return vao->_EffEnabledNonZeroDivisor & ctx->Array._DrawVAOEnabledAttribs;
 225 }
 226
 227
 228 /**
 229  * Return enabled current values attribute bits for draw.
 230  */
 231 static inline GLbitfield
 232 _mesa_draw_current_bits(const struct gl_context *ctx)
 233 {
 234    return ~ctx->Array._DrawVAOEnabledAttribs & VERT_BIT_ALL;
 235 }
 236
 237
 238 /**
 239  * Return vertex buffer binding provided the attribute struct.
 240  *
 241  * Needs the a fully updated VAO ready for draw.
 242  */
 243 static inline const struct gl_vertex_buffer_binding*
 244 _mesa_draw_buffer_binding_from_attrib(const struct gl_vertex_array_object *vao,
 245                                       const struct gl_array_attributes *attrib)
 246 {
 247    assert(vao->NewArrays == 0);
 248    return &vao->BufferBinding[attrib->_EffBufferBindingIndex];
 249 }
 250
 251
 252 /**
 253  * Return vertex array attribute provided the attribute number.
 254  */
 255 static inline const struct gl_array_attributes*
 256 _mesa_draw_array_attrib(const struct gl_vertex_array_object *vao,
 257                         gl_vert_attrib attr)
 258 {
 259    assert(vao->NewArrays == 0);
 260    const gl_attribute_map_mode map_mode = vao->_AttributeMapMode;
 261    return &vao->VertexAttrib[_mesa_vao_attribute_map[map_mode][attr]];
 262 }
 263
 264
 265 /**
 266  * Return a vertex array vertex format provided the attribute number.
 267  */
 268 static inline const struct gl_vertex_format *
 269 _mesa_draw_array_format(const struct gl_vertex_array_object *vao,
 270                         gl_vert_attrib attr)
 271 {
 272    return &_mesa_draw_array_attrib(vao, attr)->Format;
 273 }
 274
 275
 276 /**
 277  * Return vertex buffer binding provided an attribute number.
 278  */
 279 static inline const struct gl_vertex_buffer_binding*
 280 _mesa_draw_buffer_binding(const struct gl_vertex_array_object *vao,
 281                           gl_vert_attrib attr)
 282 {
 283    const struct gl_array_attributes *const attrib
 284       = _mesa_draw_array_attrib(vao, attr);
 285    return _mesa_draw_buffer_binding_from_attrib(vao, attrib);
 286 }
 287
 288
 289 /**
 290  * Return vertex attribute bits bound at the provided binding.
 291  *
 292  * Needs the a fully updated VAO ready for draw.
 293  */
 294 static inline GLbitfield
 295 _mesa_draw_bound_attrib_bits(const struct gl_vertex_buffer_binding *binding)
 296 {
 297    return binding->_EffBoundArrays;
 298 }
 299
 300
 301 /**
 302  * Return the vertex offset bound at the provided binding.
 303  *
 304  * Needs the a fully updated VAO ready for draw.
 305  */
 306 static inline GLintptr
 307 _mesa_draw_binding_offset(const struct gl_vertex_buffer_binding *binding)
 308 {
 309    return binding->_EffOffset;
 310 }
 311
 312
 313 /**
 314  * Return the relative offset of the provided attrib.
 315  *
 316  * Needs the a fully updated VAO ready for draw.
 317  */
 318 static inline GLushort
 319 _mesa_draw_attributes_relative_offset(const struct gl_array_attributes *attrib)
 320 {
 321    return attrib->_EffRelativeOffset;
 322 }
 323
 324
 325 /**
 326  * Return a current value vertex array attribute provided the attribute number.
 327  */
 328 static inline const struct gl_array_attributes*
 329 _mesa_draw_current_attrib(const struct gl_context *ctx, gl_vert_attrib attr)
 330 {
 331    return _vbo_current_attrib(ctx, attr);
 332 }
 333
 334
 335 /**
 336  * Return a current value vertex format provided the attribute number.
 337  */
 338 static inline const struct gl_vertex_format *
 339 _mesa_draw_current_format(const struct gl_context *ctx, gl_vert_attrib attr)
 340 {
 341    return &_vbo_current_attrib(ctx, attr)->Format;
 342 }
 343
 344
 345 /**
 346  * Return true if we have the VERT_ATTRIB_EDGEFLAG array enabled.
 347  */
 348 static inline bool
 349 _mesa_draw_edge_flag_array_enabled(const struct gl_context *ctx)
 350 {
 351    return ctx->Array._DrawVAOEnabledAttribs & VERT_BIT_EDGEFLAG;
 352 }
 353
 354
 355 /*
 356  * API functions
 357  */
 358
 359
 360 void GLAPIENTRY
 361 _mesa_BindVertexArray_no_error(GLuint id);
 362
 363 void GLAPIENTRY _mesa_BindVertexArray( GLuint id );
 364
 365 void GLAPIENTRY
 366 _mesa_DeleteVertexArrays_no_error(GLsizei n, const GLuint *ids);
 367
 368 void GLAPIENTRY _mesa_DeleteVertexArrays(GLsizei n, const GLuint *ids);
 369
 370 void GLAPIENTRY
 371 _mesa_GenVertexArrays_no_error(GLsizei n, GLuint *arrays);
 372
 373 void GLAPIENTRY _mesa_GenVertexArrays(GLsizei n, GLuint *arrays);
 374
 375 void GLAPIENTRY
 376 _mesa_CreateVertexArrays_no_error(GLsizei n, GLuint *arrays);
 377
 378 void GLAPIENTRY _mesa_CreateVertexArrays(GLsizei n, GLuint *arrays);
 379
 380 GLboolean GLAPIENTRY _mesa_IsVertexArray( GLuint id );
 381
 382 void GLAPIENTRY
 383 _mesa_VertexArrayElementBuffer_no_error(GLuint vaobj, GLuint buffer);
 384
 385 void GLAPIENTRY _mesa_VertexArrayElementBuffer(GLuint vaobj, GLuint buffer);
 386
 387 void GLAPIENTRY _mesa_GetVertexArrayiv(GLuint vaobj, GLenum pname, GLint *param);
 388
 389 #endif /* ARRAYOBJ_H */