src/mesa/vbo/vbo_context.h

   1 /*
   2  * mesa 3-D graphics library
   3  *
   4  * Copyright (C) 1999-2006  Brian Paul   All Rights Reserved.
   5  *
   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:
  12  *
  13  * The above copyright notice and this permission notice shall be included
  14  * in all copies or substantial portions of the Software.
  15  *
  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.
  23  */
  24
  25 /**
  26  * \file vbo_context.h
  27  * \brief VBO builder module datatypes and definitions.
  28  * \author Keith Whitwell
  29  */
  30
  31
  32 /**
  33  * \mainpage The VBO builder module
  34  *
  35  * This module hooks into the GL dispatch table and catches all vertex
  36  * building and drawing commands, such as glVertex3f, glBegin and
  37  * glDrawArrays.  The module stores all incoming vertex data as arrays
  38  * in GL vertex buffer objects (VBOs), and translates all drawing
  39  * commands into calls to a driver supplied DrawPrimitives() callback.
  40  *
  41  * The module captures both immediate mode and display list drawing,
  42  * and manages the allocation, reference counting and deallocation of
  43  * vertex buffer objects itself.
  44  *
  45  * The DrawPrimitives() callback can be either implemented by the
  46  * driver itself or hooked to the tnl module's _tnl_draw_primitives()
  47  * function for hardware without tnl capablilties or during fallbacks.
  48  */
  49
  50
  51 #ifndef _VBO_CONTEXT_H
  52 #define _VBO_CONTEXT_H
  53
  54 #include "vbo.h"
  55 #include "vbo_attrib.h"
  56 #include "vbo_exec.h"
  57 #include "vbo_save.h"
  58
  59 #include "main/macros.h"
  60
  61 #ifdef __cplusplus
  62 extern "C" {
  63 #endif
  64
  65 struct vbo_context {
  66    struct gl_client_array currval[VBO_ATTRIB_MAX];
  67
  68    /** Map VERT_ATTRIB_x to VBO_ATTRIB_y */
  69    GLuint map_vp_none[VERT_ATTRIB_MAX];
  70    GLuint map_vp_arb[VERT_ATTRIB_MAX];
  71
  72    struct vbo_exec_context exec;
  73    struct vbo_save_context save;
  74
  75    /* Callback into the driver.  This must always succeed, the driver
  76     * is responsible for initiating any fallback actions required:
  77     */
  78    vbo_draw_func draw_prims;
  79 };
  80
  81
  82 static inline struct vbo_context *vbo_context(struct gl_context *ctx)
  83 {
  84    return ctx->vbo_context;
  85 }
  86
  87
  88 /**
  89  * Return VP_x token to indicate whether we're running fixed-function
  90  * vertex transformation, an NV vertex program or ARB vertex program/shader.
  91  */
  92 static inline enum vp_mode
  93 get_program_mode( struct gl_context *ctx )
  94 {
  95    if (!ctx->VertexProgram._Current)
  96       return VP_NONE;
  97    else if (ctx->VertexProgram._Current == ctx->VertexProgram._TnlProgram)
  98       return VP_NONE;
  99    else
 100       return VP_ARB;
 101 }
 102
 103
 104 /**
 105  * This is called by glBegin, glDrawArrays and glDrawElements (and
 106  * variations of those calls).  When we transition from immediate mode
 107  * drawing to array drawing we need to invalidate the array state.
 108  *
 109  * glBegin/End builds vertex arrays.  Those arrays may look identical
 110  * to glDrawArrays arrays except that the position of the elements may
 111  * be different.  For example, arrays of (position3v, normal3f) vs. arrays
 112  * of (normal3f, position3f).  So we need to make sure we notify drivers
 113  * that arrays may be changing.
 114  */
 115 static inline void
 116 vbo_draw_method(struct vbo_context *vbo, gl_draw_method method)
 117 {
 118    struct gl_context *ctx = vbo->exec.ctx;
 119
 120    if (ctx->Array.DrawMethod != method) {
 121       switch (method) {
 122       case DRAW_ARRAYS:
 123          ctx->Array._DrawArrays = vbo->exec.array.inputs;
 124          break;
 125       case DRAW_BEGIN_END:
 126          ctx->Array._DrawArrays = vbo->exec.vtx.inputs;
 127          break;
 128       case DRAW_DISPLAY_LIST:
 129          ctx->Array._DrawArrays = vbo->save.inputs;
 130          break;
 131       default:
 132          assert(0);
 133       }
 134
 135       ctx->NewDriverState |= ctx->DriverFlags.NewArray;
 136       ctx->Array.DrawMethod = method;
 137    }
 138 }
 139
 140 /**
 141  * Return if format is integer. The immediate mode commands only emit floats
 142  * for non-integer types, thus everything else is integer.
 143  */
 144 static inline GLboolean
 145 vbo_attrtype_to_integer_flag(GLenum format)
 146 {
 147    switch (format) {
 148    case GL_FLOAT:
 149    case GL_DOUBLE:
 150       return GL_FALSE;
 151    case GL_INT:
 152    case GL_UNSIGNED_INT:
 153       return GL_TRUE;
 154    default:
 155       assert(0);
 156       return GL_FALSE;
 157    }
 158 }
 159
 160 static inline GLboolean
 161 vbo_attrtype_to_double_flag(GLenum format)
 162 {
 163    switch (format) {
 164    case GL_FLOAT:
 165    case GL_INT:
 166    case GL_UNSIGNED_INT:
 167       return GL_FALSE;
 168    case GL_DOUBLE:
 169       return GL_TRUE;
 170    default:
 171       assert(0);
 172       return GL_FALSE;
 173    }
 174 }
 175
 176 /**
 177  * Return default component values for the given format.
 178  * The return type is an array of fi_types, because that's how we declare
 179  * the vertex storage : floats , integers or unsigned integers.
 180  */
 181 static inline const fi_type *
 182 vbo_get_default_vals_as_union(GLenum format)
 183 {
 184    static const GLfloat default_float[4] = { 0, 0, 0, 1 };
 185    static const GLint default_int[4] = { 0, 0, 0, 1 };
 186
 187    switch (format) {
 188    case GL_FLOAT:
 189       return (fi_type *)default_float;
 190    case GL_INT:
 191    case GL_UNSIGNED_INT:
 192       return (fi_type *)default_int;
 193    default:
 194       assert(0);
 195       return NULL;
 196    }
 197 }
 198
 199
 200 /**
 201  * Compute the max number of vertices which can be stored in
 202  * a vertex buffer, given the current vertex size, and the amount
 203  * of space already used.
 204  */
 205 static inline unsigned
 206 vbo_compute_max_verts(const struct vbo_exec_context *exec)
 207 {
 208    return (VBO_VERT_BUFFER_SIZE - exec->vtx.buffer_used) /
 209           (exec->vtx.vertex_size * sizeof(GLfloat));
 210 }
 211
 212
 213 #ifdef __cplusplus
 214 } // extern "C"
 215 #endif
 216
 217 #endif