src/mesa/main/mtypes.h

   1 /**
   2  * \file mtypes.h
   3  * Main Mesa data structures.
   4  *
   5  * Please try to mark derived values with a leading underscore ('_').
   6  */
   7
   8 /*
   9  * Mesa 3-D graphics library
  10  * Version:  6.5.3
  11  *
  12  * Copyright (C) 1999-2007  Brian Paul   All Rights Reserved.
  13  *
  14  * Permission is hereby granted, free of charge, to any person obtaining a
  15  * copy of this software and associated documentation files (the "Software"),
  16  * to deal in the Software without restriction, including without limitation
  17  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
  18  * and/or sell copies of the Software, and to permit persons to whom the
  19  * Software is furnished to do so, subject to the following conditions:
  20  *
  21  * The above copyright notice and this permission notice shall be included
  22  * in all copies or substantial portions of the Software.
  23  *
  24  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
  25  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  26  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  27  * BRIAN PAUL BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
  28  * AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  29  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  30  */
  31
  32
  33
  34 #ifndef TYPES_H
  35 #define TYPES_H
  36
  37
  38 #include "glheader.h"
  39 #include <GL/internal/glcore.h> /* GLimports/GLexports/GLcontextModes */
  40 #include "config.h"             /* Hardwired parameters */
  41 #include "glapitable.h"
  42 #include "glthread.h"
  43 #include "math/m_matrix.h"      /* GLmatrix */
  44 #include "bitset.h"
  45
  46
  47 /**
  48  * Special, internal token
  49  */
  50 #define GL_SHADER_PROGRAM 0x9999
  51
  52
  53 /**
  54  * Color channel data type.
  55  */
  56 #if CHAN_BITS == 8
  57    typedef GLubyte GLchan;
  58 #define CHAN_MAX 255
  59 #define CHAN_MAXF 255.0F
  60 #define CHAN_TYPE GL_UNSIGNED_BYTE
  61 #elif CHAN_BITS == 16
  62    typedef GLushort GLchan;
  63 #define CHAN_MAX 65535
  64 #define CHAN_MAXF 65535.0F
  65 #define CHAN_TYPE GL_UNSIGNED_SHORT
  66 #elif CHAN_BITS == 32
  67    typedef GLfloat GLchan;
  68 #define CHAN_MAX 1.0
  69 #define CHAN_MAXF 1.0F
  70 #define CHAN_TYPE GL_FLOAT
  71 #else
  72 #error "illegal number of color channel bits"
  73 #endif
  74
  75
  76 /**
  77  * Stencil buffer data type.
  78  */
  79 #if STENCIL_BITS==8
  80    typedef GLubyte GLstencil;
  81 #elif STENCIL_BITS==16
  82    typedef GLushort GLstencil;
  83 #else
  84 #  error "illegal number of stencil bits"
  85 #endif
  86
  87
  88 /**
  89  * Fixed point data type.
  90  */
  91 typedef int GLfixed;
  92 /*
  93  * Fixed point arithmetic macros
  94  */
  95 #ifndef FIXED_FRAC_BITS
  96 #define FIXED_FRAC_BITS 11
  97 #endif
  98
  99 #define FIXED_SHIFT     FIXED_FRAC_BITS
 100 #define FIXED_ONE       (1 << FIXED_SHIFT)
 101 #define FIXED_HALF      (1 << (FIXED_SHIFT-1))
 102 #define FIXED_FRAC_MASK (FIXED_ONE - 1)
 103 #define FIXED_INT_MASK  (~FIXED_FRAC_MASK)
 104 #define FIXED_EPSILON   1
 105 #define FIXED_SCALE     ((float) FIXED_ONE)
 106 #define FIXED_DBL_SCALE ((double) FIXED_ONE)
 107 #define FloatToFixed(X) (IROUND((X) * FIXED_SCALE))
 108 #define FixedToDouble(X) ((X) * (1.0 / FIXED_DBL_SCALE))
 109 #define IntToFixed(I)   ((I) << FIXED_SHIFT)
 110 #define FixedToInt(X)   ((X) >> FIXED_SHIFT)
 111 #define FixedToUns(X)   (((unsigned int)(X)) >> FIXED_SHIFT)
 112 #define FixedCeil(X)    (((X) + FIXED_ONE - FIXED_EPSILON) & FIXED_INT_MASK)
 113 #define FixedFloor(X)   ((X) & FIXED_INT_MASK)
 114 #define FixedToFloat(X) ((X) * (1.0F / FIXED_SCALE))
 115 #define PosFloatToFixed(X)      FloatToFixed(X)
 116 #define SignedFloatToFixed(X)   FloatToFixed(X)
 117
 118
 119
 120 /**
 121  * \name Some forward type declarations
 122  */
 123 /*@{*/
 124 struct _mesa_HashTable;
 125 struct gl_pixelstore_attrib;
 126 struct gl_texture_format;
 127 struct gl_texture_image;
 128 struct gl_texture_object;
 129 typedef struct __GLcontextRec GLcontext;
 130 typedef struct __GLcontextModesRec GLvisual;
 131 typedef struct gl_framebuffer GLframebuffer;
 132 /*@}*/
 133
 134
 135
 136 /**
 137  * Indexes for vertex program attributes.
 138  * GL_NV_vertex_program aliases generic attributes over the conventional
 139  * attributes.  In GL_ARB_vertex_program shader the aliasing is optional.
 140  * In GL_ARB_vertex_shader / OpenGL 2.0 the aliasing is disallowed (the
 141  * generic attributes are distinct/separate).
 142  */
 143 enum
 144 {
 145    VERT_ATTRIB_POS = 0,
 146    VERT_ATTRIB_WEIGHT = 1,
 147    VERT_ATTRIB_NORMAL = 2,
 148    VERT_ATTRIB_COLOR0 = 3,
 149    VERT_ATTRIB_COLOR1 = 4,
 150    VERT_ATTRIB_FOG = 5,
 151    VERT_ATTRIB_COLOR_INDEX = 6,
 152    VERT_ATTRIB_EDGEFLAG = 7,
 153    VERT_ATTRIB_TEX0 = 8,
 154    VERT_ATTRIB_TEX1 = 9,
 155    VERT_ATTRIB_TEX2 = 10,
 156    VERT_ATTRIB_TEX3 = 11,
 157    VERT_ATTRIB_TEX4 = 12,
 158    VERT_ATTRIB_TEX5 = 13,
 159    VERT_ATTRIB_TEX6 = 14,
 160    VERT_ATTRIB_TEX7 = 15,
 161    VERT_ATTRIB_GENERIC0 = 16,
 162    VERT_ATTRIB_GENERIC1 = 17,
 163    VERT_ATTRIB_GENERIC2 = 18,
 164    VERT_ATTRIB_GENERIC3 = 19,
 165    VERT_ATTRIB_GENERIC4 = 20,
 166    VERT_ATTRIB_GENERIC5 = 21,
 167    VERT_ATTRIB_GENERIC6 = 22,
 168    VERT_ATTRIB_GENERIC7 = 23,
 169    VERT_ATTRIB_GENERIC8 = 24,
 170    VERT_ATTRIB_GENERIC9 = 25,
 171    VERT_ATTRIB_GENERIC10 = 26,
 172    VERT_ATTRIB_GENERIC11 = 27,
 173    VERT_ATTRIB_GENERIC12 = 28,
 174    VERT_ATTRIB_GENERIC13 = 29,
 175    VERT_ATTRIB_GENERIC14 = 30,
 176    VERT_ATTRIB_GENERIC15 = 31,
 177    VERT_ATTRIB_MAX = 32
 178 };
 179
 180 /**
 181  * Bitflags for vertex attributes.
 182  * These are used in bitfields in many places.
 183  */
 184 /*@{*/
 185 #define VERT_BIT_POS         (1 << VERT_ATTRIB_POS)
 186 #define VERT_BIT_WEIGHT      (1 << VERT_ATTRIB_WEIGHT)
 187 #define VERT_BIT_NORMAL      (1 << VERT_ATTRIB_NORMAL)
 188 #define VERT_BIT_COLOR0      (1 << VERT_ATTRIB_COLOR0)
 189 #define VERT_BIT_COLOR1      (1 << VERT_ATTRIB_COLOR1)
 190 #define VERT_BIT_FOG         (1 << VERT_ATTRIB_FOG)
 191 #define VERT_BIT_COLOR_INDEX (1 << VERT_ATTRIB_COLOR_INDEX)
 192 #define VERT_BIT_EDGEFLAG    (1 << VERT_ATTRIB_EDGEFLAG)
 193 #define VERT_BIT_TEX0        (1 << VERT_ATTRIB_TEX0)
 194 #define VERT_BIT_TEX1        (1 << VERT_ATTRIB_TEX1)
 195 #define VERT_BIT_TEX2        (1 << VERT_ATTRIB_TEX2)
 196 #define VERT_BIT_TEX3        (1 << VERT_ATTRIB_TEX3)
 197 #define VERT_BIT_TEX4        (1 << VERT_ATTRIB_TEX4)
 198 #define VERT_BIT_TEX5        (1 << VERT_ATTRIB_TEX5)
 199 #define VERT_BIT_TEX6        (1 << VERT_ATTRIB_TEX6)
 200 #define VERT_BIT_TEX7        (1 << VERT_ATTRIB_TEX7)
 201 #define VERT_BIT_GENERIC0    (1 << VERT_ATTRIB_GENERIC0)
 202 #define VERT_BIT_GENERIC1    (1 << VERT_ATTRIB_GENERIC1)
 203 #define VERT_BIT_GENERIC2    (1 << VERT_ATTRIB_GENERIC2)
 204 #define VERT_BIT_GENERIC3    (1 << VERT_ATTRIB_GENERIC3)
 205 #define VERT_BIT_GENERIC4    (1 << VERT_ATTRIB_GENERIC4)
 206 #define VERT_BIT_GENERIC5    (1 << VERT_ATTRIB_GENERIC5)
 207 #define VERT_BIT_GENERIC6    (1 << VERT_ATTRIB_GENERIC6)
 208 #define VERT_BIT_GENERIC7    (1 << VERT_ATTRIB_GENERIC7)
 209 #define VERT_BIT_GENERIC8    (1 << VERT_ATTRIB_GENERIC8)
 210 #define VERT_BIT_GENERIC9    (1 << VERT_ATTRIB_GENERIC9)
 211 #define VERT_BIT_GENERIC10   (1 << VERT_ATTRIB_GENERIC10)
 212 #define VERT_BIT_GENERIC11   (1 << VERT_ATTRIB_GENERIC11)
 213 #define VERT_BIT_GENERIC12   (1 << VERT_ATTRIB_GENERIC12)
 214 #define VERT_BIT_GENERIC13   (1 << VERT_ATTRIB_GENERIC13)
 215 #define VERT_BIT_GENERIC14   (1 << VERT_ATTRIB_GENERIC14)
 216 #define VERT_BIT_GENERIC15   (1 << VERT_ATTRIB_GENERIC15)
 217
 218 #define VERT_BIT_TEX(u)  (1 << (VERT_ATTRIB_TEX0 + (u)))
 219 #define VERT_BIT_GENERIC(g)  (1 << (VERT_ATTRIB_GENERIC0 + (g)))
 220 /*@}*/
 221
 222
 223 /**
 224  * Indexes for vertex program result attributes
 225  */
 226 /*@{*/
 227 #define VERT_RESULT_HPOS 0
 228 #define VERT_RESULT_COL0 1
 229 #define VERT_RESULT_COL1 2
 230 #define VERT_RESULT_FOGC 3
 231 #define VERT_RESULT_TEX0 4
 232 #define VERT_RESULT_TEX1 5
 233 #define VERT_RESULT_TEX2 6
 234 #define VERT_RESULT_TEX3 7
 235 #define VERT_RESULT_TEX4 8
 236 #define VERT_RESULT_TEX5 9
 237 #define VERT_RESULT_TEX6 10
 238 #define VERT_RESULT_TEX7 11
 239 #define VERT_RESULT_PSIZ 12
 240 #define VERT_RESULT_BFC0 13
 241 #define VERT_RESULT_BFC1 14
 242 #define VERT_RESULT_EDGE 15
 243 #define VERT_RESULT_VAR0 16  /**< shader varying */
 244 #define VERT_RESULT_MAX  (VERT_RESULT_VAR0 + MAX_VARYING)
 245 /*@}*/
 246
 247
 248 /**
 249  * Indexes for fragment program input attributes.
 250  */
 251 enum
 252 {
 253    FRAG_ATTRIB_WPOS = 0,
 254    FRAG_ATTRIB_COL0 = 1,
 255    FRAG_ATTRIB_COL1 = 2,
 256    FRAG_ATTRIB_FOGC = 3,
 257    FRAG_ATTRIB_TEX0 = 4,
 258    FRAG_ATTRIB_TEX1 = 5,
 259    FRAG_ATTRIB_TEX2 = 6,
 260    FRAG_ATTRIB_TEX3 = 7,
 261    FRAG_ATTRIB_TEX4 = 8,
 262    FRAG_ATTRIB_TEX5 = 9,
 263    FRAG_ATTRIB_TEX6 = 10,
 264    FRAG_ATTRIB_TEX7 = 11,
 265    FRAG_ATTRIB_VAR0 = 12,  /**< shader varying */
 266    FRAG_ATTRIB_MAX = (FRAG_ATTRIB_VAR0 + MAX_VARYING)
 267 };
 268
 269 /**
 270  * Bitflags for fragment program input attributes.
 271  */
 272 /*@{*/
 273 #define FRAG_BIT_WPOS  (1 << FRAG_ATTRIB_WPOS)
 274 #define FRAG_BIT_COL0  (1 << FRAG_ATTRIB_COL0)
 275 #define FRAG_BIT_COL1  (1 << FRAG_ATTRIB_COL1)
 276 #define FRAG_BIT_FOGC  (1 << FRAG_ATTRIB_FOGC)
 277 #define FRAG_BIT_TEX0  (1 << FRAG_ATTRIB_TEX0)
 278 #define FRAG_BIT_TEX1  (1 << FRAG_ATTRIB_TEX1)
 279 #define FRAG_BIT_TEX2  (1 << FRAG_ATTRIB_TEX2)
 280 #define FRAG_BIT_TEX3  (1 << FRAG_ATTRIB_TEX3)
 281 #define FRAG_BIT_TEX4  (1 << FRAG_ATTRIB_TEX4)
 282 #define FRAG_BIT_TEX5  (1 << FRAG_ATTRIB_TEX5)
 283 #define FRAG_BIT_TEX6  (1 << FRAG_ATTRIB_TEX6)
 284 #define FRAG_BIT_TEX7  (1 << FRAG_ATTRIB_TEX7)
 285 #define FRAG_BIT_VAR0  (1 << FRAG_ATTRIB_VAR0)
 286
 287 #define FRAG_BIT_TEX(U)  (FRAG_BIT_TEX0 << (U))
 288 #define FRAG_BIT_VAR(V)  (FRAG_BIT_VAR0 << (V))
 289
 290 #define FRAG_BITS_TEX_ANY (FRAG_BIT_TEX0|       \
 291                            FRAG_BIT_TEX1|       \
 292                            FRAG_BIT_TEX2|       \
 293                            FRAG_BIT_TEX3|       \
 294                            FRAG_BIT_TEX4|       \
 295                            FRAG_BIT_TEX5|       \
 296                            FRAG_BIT_TEX6|       \
 297                            FRAG_BIT_TEX7)
 298 /*@}*/
 299
 300
 301 /**
 302  * Fragment program results
 303  */
 304 enum
 305 {
 306    FRAG_RESULT_COLR = 0,
 307    FRAG_RESULT_COLH = 1,
 308    FRAG_RESULT_DEPR = 2,
 309    FRAG_RESULT_DATA0 = 3,
 310    FRAG_RESULT_MAX = (FRAG_RESULT_DATA0 + MAX_DRAW_BUFFERS)
 311 };
 312
 313
 314 /**
 315  * Indexes for all renderbuffers
 316  */
 317 enum {
 318    BUFFER_FRONT_LEFT  = 0,  /* the four standard color buffers */
 319    BUFFER_BACK_LEFT   = 1,
 320    BUFFER_FRONT_RIGHT = 2,
 321    BUFFER_BACK_RIGHT  = 3,
 322    BUFFER_AUX0        = 4,  /* optional aux buffer */
 323    BUFFER_AUX1        = 5,
 324    BUFFER_AUX2        = 6,
 325    BUFFER_AUX3        = 7,
 326    BUFFER_DEPTH       = 8,
 327    BUFFER_STENCIL     = 9,
 328    BUFFER_ACCUM       = 10,
 329    BUFFER_COLOR0      = 11, /* generic renderbuffers */
 330    BUFFER_COLOR1      = 12,
 331    BUFFER_COLOR2      = 13,
 332    BUFFER_COLOR3      = 14,
 333    BUFFER_COLOR4      = 15,
 334    BUFFER_COLOR5      = 16,
 335    BUFFER_COLOR6      = 17,
 336    BUFFER_COLOR7      = 18,
 337    BUFFER_COUNT       = 19
 338 };
 339
 340 /**
 341  * Bit flags for all renderbuffers
 342  */
 343 #define BUFFER_BIT_FRONT_LEFT   (1 << BUFFER_FRONT_LEFT)
 344 #define BUFFER_BIT_BACK_LEFT    (1 << BUFFER_BACK_LEFT)
 345 #define BUFFER_BIT_FRONT_RIGHT  (1 << BUFFER_FRONT_RIGHT)
 346 #define BUFFER_BIT_BACK_RIGHT   (1 << BUFFER_BACK_RIGHT)
 347 #define BUFFER_BIT_AUX0         (1 << BUFFER_AUX0)
 348 #define BUFFER_BIT_AUX1         (1 << BUFFER_AUX1)
 349 #define BUFFER_BIT_AUX2         (1 << BUFFER_AUX2)
 350 #define BUFFER_BIT_AUX3         (1 << BUFFER_AUX3)
 351 #define BUFFER_BIT_DEPTH        (1 << BUFFER_DEPTH)
 352 #define BUFFER_BIT_STENCIL      (1 << BUFFER_STENCIL)
 353 #define BUFFER_BIT_ACCUM        (1 << BUFFER_ACCUM)
 354 #define BUFFER_BIT_COLOR0       (1 << BUFFER_COLOR0)
 355 #define BUFFER_BIT_COLOR1       (1 << BUFFER_COLOR1)
 356 #define BUFFER_BIT_COLOR2       (1 << BUFFER_COLOR2)
 357 #define BUFFER_BIT_COLOR3       (1 << BUFFER_COLOR3)
 358 #define BUFFER_BIT_COLOR4       (1 << BUFFER_COLOR4)
 359 #define BUFFER_BIT_COLOR5       (1 << BUFFER_COLOR5)
 360 #define BUFFER_BIT_COLOR6       (1 << BUFFER_COLOR6)
 361 #define BUFFER_BIT_COLOR7       (1 << BUFFER_COLOR7)
 362
 363 /**
 364  * Mask of all the color buffer bits (but not accum).
 365  */
 366 #define BUFFER_BITS_COLOR  (BUFFER_BIT_FRONT_LEFT | \
 367                             BUFFER_BIT_BACK_LEFT | \
 368                             BUFFER_BIT_FRONT_RIGHT | \
 369                             BUFFER_BIT_BACK_RIGHT | \
 370                             BUFFER_BIT_AUX0 | \
 371                             BUFFER_BIT_AUX1 | \
 372                             BUFFER_BIT_AUX2 | \
 373                             BUFFER_BIT_AUX3 | \
 374                             BUFFER_BIT_COLOR0 | \
 375                             BUFFER_BIT_COLOR1 | \
 376                             BUFFER_BIT_COLOR2 | \
 377                             BUFFER_BIT_COLOR3 | \
 378                             BUFFER_BIT_COLOR4 | \
 379                             BUFFER_BIT_COLOR5 | \
 380                             BUFFER_BIT_COLOR6 | \
 381                             BUFFER_BIT_COLOR7)
 382
 383
 384 /** The pixel transfer path has three color tables: */
 385 /*@{*/
 386 #define COLORTABLE_PRECONVOLUTION  0
 387 #define COLORTABLE_POSTCONVOLUTION 1
 388 #define COLORTABLE_POSTCOLORMATRIX 2
 389 #define COLORTABLE_MAX 3
 390 /*@}*/
 391
 392
 393 /**
 394  * Data structure for color tables
 395  */
 396 struct gl_color_table
 397 {
 398    GLenum InternalFormat;      /**< The user-specified format */
 399    GLenum _BaseFormat;         /**< GL_ALPHA, GL_RGBA, GL_RGB, etc */
 400    GLuint Size;                /**< number of entries in table */
 401    GLfloat *TableF;            /**< Color table, floating point values */
 402    GLubyte *TableUB;           /**< Color table, ubyte values */
 403    GLubyte RedSize;
 404    GLubyte GreenSize;
 405    GLubyte BlueSize;
 406    GLubyte AlphaSize;
 407    GLubyte LuminanceSize;
 408    GLubyte IntensitySize;
 409 };
 410
 411
 412 /**
 413  * \name Bit flags used for updating material values.
 414  */
 415 /*@{*/
 416 #define MAT_ATTRIB_FRONT_AMBIENT           0
 417 #define MAT_ATTRIB_BACK_AMBIENT            1
 418 #define MAT_ATTRIB_FRONT_DIFFUSE           2
 419 #define MAT_ATTRIB_BACK_DIFFUSE            3
 420 #define MAT_ATTRIB_FRONT_SPECULAR          4
 421 #define MAT_ATTRIB_BACK_SPECULAR           5
 422 #define MAT_ATTRIB_FRONT_EMISSION          6
 423 #define MAT_ATTRIB_BACK_EMISSION           7
 424 #define MAT_ATTRIB_FRONT_SHININESS         8
 425 #define MAT_ATTRIB_BACK_SHININESS          9
 426 #define MAT_ATTRIB_FRONT_INDEXES           10
 427 #define MAT_ATTRIB_BACK_INDEXES            11
 428 #define MAT_ATTRIB_MAX                     12
 429
 430 #define MAT_ATTRIB_AMBIENT(f)  (MAT_ATTRIB_FRONT_AMBIENT+(f))
 431 #define MAT_ATTRIB_DIFFUSE(f)  (MAT_ATTRIB_FRONT_DIFFUSE+(f))
 432 #define MAT_ATTRIB_SPECULAR(f) (MAT_ATTRIB_FRONT_SPECULAR+(f))
 433 #define MAT_ATTRIB_EMISSION(f) (MAT_ATTRIB_FRONT_EMISSION+(f))
 434 #define MAT_ATTRIB_SHININESS(f)(MAT_ATTRIB_FRONT_SHININESS+(f))
 435 #define MAT_ATTRIB_INDEXES(f)  (MAT_ATTRIB_FRONT_INDEXES+(f))
 436
 437 #define MAT_INDEX_AMBIENT  0
 438 #define MAT_INDEX_DIFFUSE  1
 439 #define MAT_INDEX_SPECULAR 2
 440
 441 #define MAT_BIT_FRONT_AMBIENT         (1<<MAT_ATTRIB_FRONT_AMBIENT)
 442 #define MAT_BIT_BACK_AMBIENT          (1<<MAT_ATTRIB_BACK_AMBIENT)
 443 #define MAT_BIT_FRONT_DIFFUSE         (1<<MAT_ATTRIB_FRONT_DIFFUSE)
 444 #define MAT_BIT_BACK_DIFFUSE          (1<<MAT_ATTRIB_BACK_DIFFUSE)
 445 #define MAT_BIT_FRONT_SPECULAR        (1<<MAT_ATTRIB_FRONT_SPECULAR)
 446 #define MAT_BIT_BACK_SPECULAR         (1<<MAT_ATTRIB_BACK_SPECULAR)
 447 #define MAT_BIT_FRONT_EMISSION        (1<<MAT_ATTRIB_FRONT_EMISSION)
 448 #define MAT_BIT_BACK_EMISSION         (1<<MAT_ATTRIB_BACK_EMISSION)
 449 #define MAT_BIT_FRONT_SHININESS       (1<<MAT_ATTRIB_FRONT_SHININESS)
 450 #define MAT_BIT_BACK_SHININESS        (1<<MAT_ATTRIB_BACK_SHININESS)
 451 #define MAT_BIT_FRONT_INDEXES         (1<<MAT_ATTRIB_FRONT_INDEXES)
 452 #define MAT_BIT_BACK_INDEXES          (1<<MAT_ATTRIB_BACK_INDEXES)
 453
 454
 455 #define FRONT_MATERIAL_BITS     (MAT_BIT_FRONT_EMISSION |       \
 456                                  MAT_BIT_FRONT_AMBIENT |        \
 457                                  MAT_BIT_FRONT_DIFFUSE |        \
 458                                  MAT_BIT_FRONT_SPECULAR |       \
 459                                  MAT_BIT_FRONT_SHININESS |      \
 460                                  MAT_BIT_FRONT_INDEXES)
 461
 462 #define BACK_MATERIAL_BITS      (MAT_BIT_BACK_EMISSION |        \
 463                                  MAT_BIT_BACK_AMBIENT |         \
 464                                  MAT_BIT_BACK_DIFFUSE |         \
 465                                  MAT_BIT_BACK_SPECULAR |        \
 466                                  MAT_BIT_BACK_SHININESS |       \
 467                                  MAT_BIT_BACK_INDEXES)
 468
 469 #define ALL_MATERIAL_BITS       (FRONT_MATERIAL_BITS | BACK_MATERIAL_BITS)
 470 /*@}*/
 471
 472
 473 #define EXP_TABLE_SIZE 512      /**< Specular exponent lookup table sizes */
 474 #define SHINE_TABLE_SIZE 256    /**< Material shininess lookup table sizes */
 475
 476 /**
 477  * Material shininess lookup table.
 478  */
 479 struct gl_shine_tab
 480 {
 481    struct gl_shine_tab *next, *prev;
 482    GLfloat tab[SHINE_TABLE_SIZE+1];
 483    GLfloat shininess;
 484    GLuint refcount;
 485 };
 486
 487
 488 /**
 489  * Light source state.
 490  */
 491 struct gl_light
 492 {
 493    struct gl_light *next;       /**< double linked list with sentinel */
 494    struct gl_light *prev;
 495
 496    GLfloat Ambient[4];          /**< ambient color */
 497    GLfloat Diffuse[4];          /**< diffuse color */
 498    GLfloat Specular[4];         /**< specular color */
 499    GLfloat EyePosition[4];      /**< position in eye coordinates */
 500    GLfloat EyeDirection[4];     /**< spotlight dir in eye coordinates */
 501    GLfloat SpotExponent;
 502    GLfloat SpotCutoff;          /**< in degrees */
 503    GLfloat _CosCutoffNeg;       /**< = cos(SpotCutoff) */
 504    GLfloat _CosCutoff;          /**< = MAX(0, cos(SpotCutoff)) */
 505    GLfloat ConstantAttenuation;
 506    GLfloat LinearAttenuation;
 507    GLfloat QuadraticAttenuation;
 508    GLboolean Enabled;           /**< On/off flag */
 509
 510    /**
 511     * \name Derived fields
 512     */
 513    /*@{*/
 514    GLbitfield _Flags;           /**< State */
 515
 516    GLfloat _Position[4];        /**< position in eye/obj coordinates */
 517    GLfloat _VP_inf_norm[3];     /**< Norm direction to infinite light */
 518    GLfloat _h_inf_norm[3];      /**< Norm( _VP_inf_norm + <0,0,1> ) */
 519    GLfloat _NormDirection[4];   /**< normalized spotlight direction */
 520    GLfloat _VP_inf_spot_attenuation;
 521
 522    GLfloat _SpotExpTable[EXP_TABLE_SIZE][2];  /**< to replace a pow() call */
 523    GLfloat _MatAmbient[2][3];   /**< material ambient * light ambient */
 524    GLfloat _MatDiffuse[2][3];   /**< material diffuse * light diffuse */
 525    GLfloat _MatSpecular[2][3];  /**< material spec * light specular */
 526    GLfloat _dli;                /**< CI diffuse light intensity */
 527    GLfloat _sli;                /**< CI specular light intensity */
 528    /*@}*/
 529 };
 530
 531
 532 /**
 533  * Light model state.
 534  */
 535 struct gl_lightmodel
 536 {
 537    GLfloat Ambient[4];          /**< ambient color */
 538    GLboolean LocalViewer;       /**< Local (or infinite) view point? */
 539    GLboolean TwoSide;           /**< Two (or one) sided lighting? */
 540    GLenum ColorControl;         /**< either GL_SINGLE_COLOR
 541                                  *    or GL_SEPARATE_SPECULAR_COLOR */
 542 };
 543
 544
 545 /**
 546  * Material state.
 547  */
 548 struct gl_material
 549 {
 550    GLfloat Attrib[MAT_ATTRIB_MAX][4];
 551 };
 552
 553
 554 /**
 555  * Accumulation buffer attribute group (GL_ACCUM_BUFFER_BIT)
 556  */
 557 struct gl_accum_attrib
 558 {
 559    GLfloat ClearColor[4];       /**< Accumulation buffer clear color */
 560 };
 561
 562
 563 /**
 564  * Color buffer attribute group (GL_COLOR_BUFFER_BIT).
 565  */
 566 struct gl_colorbuffer_attrib
 567 {
 568    GLuint ClearIndex;                   /**< Index to use for glClear */
 569    GLclampf ClearColor[4];              /**< Color to use for glClear */
 570
 571    GLuint IndexMask;                    /**< Color index write mask */
 572    GLubyte ColorMask[4];                /**< Each flag is 0xff or 0x0 */
 573
 574    GLenum DrawBuffer[MAX_DRAW_BUFFERS]; /**< Which buffer to draw into */
 575
 576    /**
 577     * \name alpha testing
 578     */
 579    /*@{*/
 580    GLboolean AlphaEnabled;              /**< Alpha test enabled flag */
 581    GLenum AlphaFunc;                    /**< Alpha test function */
 582    GLclampf AlphaRef;                   /**< Alpha reference value */
 583    /*@}*/
 584
 585    /**
 586     * \name Blending
 587     */
 588    /*@{*/
 589    GLboolean BlendEnabled;              /**< Blending enabled flag */
 590    GLenum BlendSrcRGB;                  /**< Blending source operator */
 591    GLenum BlendDstRGB;                  /**< Blending destination operator */
 592    GLenum BlendSrcA;                    /**< GL_INGR_blend_func_separate */
 593    GLenum BlendDstA;                    /**< GL_INGR_blend_func_separate */
 594    GLenum BlendEquationRGB;             /**< Blending equation */
 595    GLenum BlendEquationA;               /**< GL_EXT_blend_equation_separate */
 596    GLfloat BlendColor[4];               /**< Blending color */
 597    /*@}*/
 598
 599    /**
 600     * \name Logic op
 601     */
 602    /*@{*/
 603    GLenum LogicOp;                      /**< Logic operator */
 604    GLboolean IndexLogicOpEnabled;       /**< Color index logic op enabled flag */
 605    GLboolean ColorLogicOpEnabled;       /**< RGBA logic op enabled flag */
 606    GLboolean _LogicOpEnabled;           /**< RGBA logic op + EXT_blend_logic_op enabled flag */
 607    /*@}*/
 608
 609    GLboolean DitherFlag;                /**< Dither enable flag */
 610
 611    GLenum ClampFragmentColor; /**< GL_TRUE, GL_FALSE or GL_FIXED_ONLY_ARB */
 612    GLenum ClampReadColor;     /**< GL_TRUE, GL_FALSE or GL_FIXED_ONLY_ARB */
 613 };
 614
 615
 616 /**
 617  * Current attribute group (GL_CURRENT_BIT).
 618  */
 619 struct gl_current_attrib
 620 {
 621    /**
 622     * \name Current vertex attributes.
 623     * \note Values are valid only after FLUSH_VERTICES has been called.
 624     * \note Index and Edgeflag current values are stored as floats in the
 625     * SIX and SEVEN attribute slots.
 626     */
 627    /*@{*/
 628    GLfloat Attrib[VERT_ATTRIB_MAX][4];  /**< Position, color, texcoords, etc */
 629    /*@}*/
 630
 631    /**
 632     * \name Current raster position attributes (always valid).
 633     * \note This set of attributes is very similar to the SWvertex struct.
 634     */
 635    /*@{*/
 636    GLfloat RasterPos[4];
 637    GLfloat RasterDistance;
 638    GLfloat RasterColor[4];
 639    GLfloat RasterSecondaryColor[4];
 640    GLfloat RasterIndex;
 641    GLfloat RasterTexCoords[MAX_TEXTURE_COORD_UNITS][4];
 642    GLboolean RasterPosValid;
 643    /*@}*/
 644 };
 645
 646
 647 /**
 648  * Depth buffer attribute group (GL_DEPTH_BUFFER_BIT).
 649  */
 650 struct gl_depthbuffer_attrib
 651 {
 652    GLenum Func;                 /**< Function for depth buffer compare */
 653    GLclampd Clear;              /**< Value to clear depth buffer to */
 654    GLboolean Test;              /**< Depth buffering enabled flag */
 655    GLboolean Mask;              /**< Depth buffer writable? */
 656    GLboolean BoundsTest;        /**< GL_EXT_depth_bounds_test */
 657    GLfloat BoundsMin, BoundsMax;/**< GL_EXT_depth_bounds_test */
 658 };
 659
 660
 661 /**
 662  * glEnable()/glDisable() attribute group (GL_ENABLE_BIT).
 663  */
 664 struct gl_enable_attrib
 665 {
 666    GLboolean AlphaTest;
 667    GLboolean AutoNormal;
 668    GLboolean Blend;
 669    GLbitfield ClipPlanes;
 670    GLboolean ColorMaterial;
 671    GLboolean ColorTable[COLORTABLE_MAX];
 672    GLboolean Convolution1D;
 673    GLboolean Convolution2D;
 674    GLboolean Separable2D;
 675    GLboolean CullFace;
 676    GLboolean DepthTest;
 677    GLboolean Dither;
 678    GLboolean Fog;
 679    GLboolean Histogram;
 680    GLboolean Light[MAX_LIGHTS];
 681    GLboolean Lighting;
 682    GLboolean LineSmooth;
 683    GLboolean LineStipple;
 684    GLboolean IndexLogicOp;
 685    GLboolean ColorLogicOp;
 686    GLboolean Map1Color4;
 687    GLboolean Map1Index;
 688    GLboolean Map1Normal;
 689    GLboolean Map1TextureCoord1;
 690    GLboolean Map1TextureCoord2;
 691    GLboolean Map1TextureCoord3;
 692    GLboolean Map1TextureCoord4;
 693    GLboolean Map1Vertex3;
 694    GLboolean Map1Vertex4;
 695    GLboolean Map1Attrib[16];  /* GL_NV_vertex_program */
 696    GLboolean Map2Color4;
 697    GLboolean Map2Index;
 698    GLboolean Map2Normal;
 699    GLboolean Map2TextureCoord1;
 700    GLboolean Map2TextureCoord2;
 701    GLboolean Map2TextureCoord3;
 702    GLboolean Map2TextureCoord4;
 703    GLboolean Map2Vertex3;
 704    GLboolean Map2Vertex4;
 705    GLboolean Map2Attrib[16];  /* GL_NV_vertex_program */
 706    GLboolean MinMax;
 707    GLboolean Normalize;
 708    GLboolean PixelTexture;
 709    GLboolean PointSmooth;
 710    GLboolean PolygonOffsetPoint;
 711    GLboolean PolygonOffsetLine;
 712    GLboolean PolygonOffsetFill;
 713    GLboolean PolygonSmooth;
 714    GLboolean PolygonStipple;
 715    GLboolean RescaleNormals;
 716    GLboolean Scissor;
 717    GLboolean Stencil;
 718    GLboolean StencilTwoSide;          /* GL_EXT_stencil_two_side */
 719    GLboolean MultisampleEnabled;      /* GL_ARB_multisample */
 720    GLboolean SampleAlphaToCoverage;   /* GL_ARB_multisample */
 721    GLboolean SampleAlphaToOne;        /* GL_ARB_multisample */
 722    GLboolean SampleCoverage;          /* GL_ARB_multisample */
 723    GLboolean SampleCoverageInvert;    /* GL_ARB_multisample */
 724    GLboolean RasterPositionUnclipped; /* GL_IBM_rasterpos_clip */
 725    GLuint Texture[MAX_TEXTURE_IMAGE_UNITS];
 726    GLuint TexGen[MAX_TEXTURE_COORD_UNITS];
 727    /* SGI_texture_color_table */
 728    GLboolean TextureColorTable[MAX_TEXTURE_IMAGE_UNITS];
 729    /* GL_ARB_vertex_program / GL_NV_vertex_program */
 730    GLboolean VertexProgram;
 731    GLboolean VertexProgramPointSize;
 732    GLboolean VertexProgramTwoSide;
 733    /* GL_ARB_point_sprite / GL_NV_point_sprite */
 734    GLboolean PointSprite;
 735    GLboolean FragmentShaderATI;
 736 };
 737
 738
 739 /**
 740  * Evaluator attribute group (GL_EVAL_BIT).
 741  */
 742 struct gl_eval_attrib
 743 {
 744    /**
 745     * \name Enable bits
 746     */
 747    /*@{*/
 748    GLboolean Map1Color4;
 749    GLboolean Map1Index;
 750    GLboolean Map1Normal;
 751    GLboolean Map1TextureCoord1;
 752    GLboolean Map1TextureCoord2;
 753    GLboolean Map1TextureCoord3;
 754    GLboolean Map1TextureCoord4;
 755    GLboolean Map1Vertex3;
 756    GLboolean Map1Vertex4;
 757    GLboolean Map1Attrib[16];  /* GL_NV_vertex_program */
 758    GLboolean Map2Color4;
 759    GLboolean Map2Index;
 760    GLboolean Map2Normal;
 761    GLboolean Map2TextureCoord1;
 762    GLboolean Map2TextureCoord2;
 763    GLboolean Map2TextureCoord3;
 764    GLboolean Map2TextureCoord4;
 765    GLboolean Map2Vertex3;
 766    GLboolean Map2Vertex4;
 767    GLboolean Map2Attrib[16];  /* GL_NV_vertex_program */
 768    GLboolean AutoNormal;
 769    /*@}*/
 770
 771    /**
 772     * \name Map Grid endpoints and divisions and calculated du values
 773     */
 774    /*@{*/
 775    GLint MapGrid1un;
 776    GLfloat MapGrid1u1, MapGrid1u2, MapGrid1du;
 777    GLint MapGrid2un, MapGrid2vn;
 778    GLfloat MapGrid2u1, MapGrid2u2, MapGrid2du;
 779    GLfloat MapGrid2v1, MapGrid2v2, MapGrid2dv;
 780    /*@}*/
 781 };
 782
 783
 784 /**
 785  * Fog attribute group (GL_FOG_BIT).
 786  */
 787 struct gl_fog_attrib
 788 {
 789    GLboolean Enabled;           /**< Fog enabled flag */
 790    GLfloat Color[4];            /**< Fog color */
 791    GLfloat Density;             /**< Density >= 0.0 */
 792    GLfloat Start;               /**< Start distance in eye coords */
 793    GLfloat End;                 /**< End distance in eye coords */
 794    GLfloat Index;               /**< Fog index */
 795    GLenum Mode;                 /**< Fog mode */
 796    GLboolean ColorSumEnabled;
 797    GLenum FogCoordinateSource;  /**< GL_EXT_fog_coord */
 798    GLfloat _Scale;              /**< (End == Start) ? 1.0 : 1.0 / (End - Start) */
 799 };
 800
 801
 802 /**
 803  * Hint attribute group (GL_HINT_BIT).
 804  *
 805  * Values are always one of GL_FASTEST, GL_NICEST, or GL_DONT_CARE.
 806  */
 807 struct gl_hint_attrib
 808 {
 809    GLenum PerspectiveCorrection;
 810    GLenum PointSmooth;
 811    GLenum LineSmooth;
 812    GLenum PolygonSmooth;
 813    GLenum Fog;
 814    GLenum ClipVolumeClipping;   /**< GL_EXT_clip_volume_hint */
 815    GLenum TextureCompression;   /**< GL_ARB_texture_compression */
 816    GLenum GenerateMipmap;       /**< GL_SGIS_generate_mipmap */
 817    GLenum FragmentShaderDerivative; /**< GL_ARB_fragment_shader */
 818 };
 819
 820
 821 /**
 822  * Histogram attributes.
 823  */
 824 struct gl_histogram_attrib
 825 {
 826    GLuint Width;                                /**< number of table entries */
 827    GLint Format;                                /**< GL_ALPHA, GL_RGB, etc */
 828    GLuint Count[HISTOGRAM_TABLE_SIZE][4];       /**< the histogram */
 829    GLboolean Sink;                              /**< terminate image transfer? */
 830    GLubyte RedSize;                             /**< Bits per counter */
 831    GLubyte GreenSize;
 832    GLubyte BlueSize;
 833    GLubyte AlphaSize;
 834    GLubyte LuminanceSize;
 835 };
 836
 837
 838 /**
 839  * Color Min/max state.
 840  */
 841 struct gl_minmax_attrib
 842 {
 843    GLenum Format;
 844    GLboolean Sink;
 845    GLfloat Min[4], Max[4];   /**< RGBA */
 846 };
 847
 848
 849 /**
 850  * Image convolution state.
 851  */
 852 struct gl_convolution_attrib
 853 {
 854    GLenum Format;
 855    GLenum InternalFormat;
 856    GLuint Width;
 857    GLuint Height;
 858    GLfloat Filter[MAX_CONVOLUTION_WIDTH * MAX_CONVOLUTION_HEIGHT * 4];
 859 };
 860
 861
 862 /**
 863  * Light state flags.
 864  */
 865 /*@{*/
 866 #define LIGHT_SPOT         0x1
 867 #define LIGHT_LOCAL_VIEWER 0x2
 868 #define LIGHT_POSITIONAL   0x4
 869 #define LIGHT_NEED_VERTICES (LIGHT_POSITIONAL|LIGHT_LOCAL_VIEWER)
 870 /*@}*/
 871
 872
 873 /**
 874  * Lighting attribute group (GL_LIGHT_BIT).
 875  */
 876 struct gl_light_attrib
 877 {
 878    struct gl_light Light[MAX_LIGHTS];   /**< Array of light sources */
 879    struct gl_lightmodel Model;          /**< Lighting model */
 880
 881    /**
 882     * Must flush FLUSH_VERTICES before referencing:
 883     */
 884    /*@{*/
 885    struct gl_material Material;         /**< Includes front & back values */
 886    /*@}*/
 887
 888    GLboolean Enabled;                   /**< Lighting enabled flag */
 889    GLenum ShadeModel;                   /**< GL_FLAT or GL_SMOOTH */
 890    GLenum ColorMaterialFace;            /**< GL_FRONT, BACK or FRONT_AND_BACK */
 891    GLenum ColorMaterialMode;            /**< GL_AMBIENT, GL_DIFFUSE, etc */
 892    GLbitfield ColorMaterialBitmask;     /**< bitmask formed from Face and Mode */
 893    GLboolean ColorMaterialEnabled;
 894    GLenum ClampVertexColor;
 895
 896    struct gl_light EnabledList;         /**< List sentinel */
 897
 898    /**
 899     * Derived state for optimizations:
 900     */
 901    /*@{*/
 902    GLboolean _NeedEyeCoords;
 903    GLboolean _NeedVertices;             /**< Use fast shader? */
 904    GLbitfield  _Flags;                  /**< LIGHT_* flags, see above */
 905    GLfloat _BaseColor[2][3];
 906    /*@}*/
 907 };
 908
 909
 910 /**
 911  * Line attribute group (GL_LINE_BIT).
 912  */
 913 struct gl_line_attrib
 914 {
 915    GLboolean SmoothFlag;        /**< GL_LINE_SMOOTH enabled? */
 916    GLboolean StippleFlag;       /**< GL_LINE_STIPPLE enabled? */
 917    GLushort StipplePattern;     /**< Stipple pattern */
 918    GLint StippleFactor;         /**< Stipple repeat factor */
 919    GLfloat Width;               /**< Line width */
 920    GLfloat _Width;              /**< Clamped Line width */
 921 };
 922
 923
 924 /**
 925  * Display list attribute group (GL_LIST_BIT).
 926  */
 927 struct gl_list_attrib
 928 {
 929    GLuint ListBase;
 930 };
 931
 932
 933 /**
 934  * Used by device drivers to hook new commands into display lists.
 935  */
 936 struct gl_list_instruction
 937 {
 938    GLuint Size;
 939    void (*Execute)( GLcontext *ctx, void *data );
 940    void (*Destroy)( GLcontext *ctx, void *data );
 941    void (*Print)( GLcontext *ctx, void *data );
 942 };
 943
 944 #define MAX_DLIST_EXT_OPCODES 16
 945
 946 /**
 947  * Used by device drivers to hook new commands into display lists.
 948  */
 949 struct gl_list_extensions
 950 {
 951    struct gl_list_instruction Opcode[MAX_DLIST_EXT_OPCODES];
 952    GLuint NumOpcodes;
 953 };
 954
 955
 956 /**
 957  * Multisample attribute group (GL_MULTISAMPLE_BIT).
 958  */
 959 struct gl_multisample_attrib
 960 {
 961    GLboolean Enabled;
 962    GLboolean SampleAlphaToCoverage;
 963    GLboolean SampleAlphaToOne;
 964    GLboolean SampleCoverage;
 965    GLfloat SampleCoverageValue;
 966    GLboolean SampleCoverageInvert;
 967 };
 968
 969
 970 /**
 971  * A pixelmap (see glPixelMap)
 972  */
 973 struct gl_pixelmap
 974 {
 975    GLint Size;
 976    GLfloat Map[MAX_PIXEL_MAP_TABLE];
 977    GLubyte Map8[MAX_PIXEL_MAP_TABLE];  /**< converted to 8-bit color */
 978 };
 979
 980
 981 /**
 982  * Collection of all pixelmaps
 983  */
 984 struct gl_pixelmaps
 985 {
 986    struct gl_pixelmap RtoR;  /**< i.e. GL_PIXEL_MAP_R_TO_R */
 987    struct gl_pixelmap GtoG;
 988    struct gl_pixelmap BtoB;
 989    struct gl_pixelmap AtoA;
 990    struct gl_pixelmap ItoR;
 991    struct gl_pixelmap ItoG;
 992    struct gl_pixelmap ItoB;
 993    struct gl_pixelmap ItoA;
 994    struct gl_pixelmap ItoI;
 995    struct gl_pixelmap StoS;
 996 };
 997
 998
 999 /**
1000  * Pixel attribute group (GL_PIXEL_MODE_BIT).
1001  */
1002 struct gl_pixel_attrib
1003 {
1004    GLenum ReadBuffer;           /**< source buffer for glRead/CopyPixels() */
1005
1006    /*--- Begin Pixel Transfer State ---*/
1007    /* Fields are in the order in which they're applied... */
1008
1009    /* Scale & Bias (index shift, offset) */
1010    GLfloat RedBias, RedScale;
1011    GLfloat GreenBias, GreenScale;
1012    GLfloat BlueBias, BlueScale;
1013    GLfloat AlphaBias, AlphaScale;
1014    GLfloat DepthBias, DepthScale;
1015    GLint IndexShift, IndexOffset;
1016
1017    /* Pixel Maps */
1018    /* Note: actual pixel maps are not part of this attrib group */
1019    GLboolean MapColorFlag;
1020    GLboolean MapStencilFlag;
1021
1022    /* There are multiple color table stages: */
1023    GLboolean ColorTableEnabled[COLORTABLE_MAX];
1024    GLfloat ColorTableScale[COLORTABLE_MAX][4];  /**< RGBA */
1025    GLfloat ColorTableBias[COLORTABLE_MAX][4];   /**< RGBA */
1026
1027    /* Convolution (GL_EXT_convolution) */
1028    GLboolean Convolution1DEnabled;
1029    GLboolean Convolution2DEnabled;
1030    GLboolean Separable2DEnabled;
1031    GLfloat ConvolutionBorderColor[3][4];
1032    GLenum ConvolutionBorderMode[3];
1033    GLfloat ConvolutionFilterScale[3][4];  /**< RGBA */
1034    GLfloat ConvolutionFilterBias[3][4];   /**< RGBA */
1035    GLfloat PostConvolutionScale[4];  /**< RGBA */
1036    GLfloat PostConvolutionBias[4];   /**< RGBA */
1037
1038    /* Color matrix (GL_SGI_color_matrix) */
1039    /* Note: the color matrix is not part of this attrib group */
1040    GLfloat PostColorMatrixScale[4];  /**< RGBA */
1041    GLfloat PostColorMatrixBias[4];   /**< RGBA */
1042
1043    /* Histogram & minmax (GL_EXT_histogram) */
1044    /* Note: histogram and minmax data are not part of this attrib group */
1045    GLboolean HistogramEnabled;
1046    GLboolean MinMaxEnabled;
1047
1048    /*--- End Pixel Transfer State ---*/
1049
1050    /* Pixel Zoom */
1051    GLfloat ZoomX, ZoomY;
1052
1053    /** GL_SGI_texture_color_table */
1054    GLfloat TextureColorTableScale[4];
1055    GLfloat TextureColorTableBias[4];
1056 };
1057
1058
1059 /**
1060  * Point attribute group (GL_POINT_BIT).
1061  */
1062 struct gl_point_attrib
1063 {
1064    GLboolean SmoothFlag;        /**< True if GL_POINT_SMOOTH is enabled */
1065    GLfloat Size;                /**< User-specified point size */
1066    GLfloat _Size;               /**< Size clamped to Const.Min/MaxPointSize */
1067    GLfloat Params[3];           /**< GL_EXT_point_parameters */
1068    GLfloat MinSize, MaxSize;    /**< GL_EXT_point_parameters */
1069    GLfloat Threshold;           /**< GL_EXT_point_parameters */
1070    GLboolean _Attenuated;       /**< True if Params != [1, 0, 0] */
1071    GLboolean PointSprite;       /**< GL_NV/ARB_point_sprite */
1072    GLboolean CoordReplace[MAX_TEXTURE_COORD_UNITS]; /**< GL_ARB_point_sprite */
1073    GLenum SpriteRMode;          /**< GL_NV_point_sprite (only!) */
1074    GLenum SpriteOrigin;         /**< GL_ARB_point_sprite */
1075 };
1076
1077
1078 /**
1079  * Polygon attribute group (GL_POLYGON_BIT).
1080  */
1081 struct gl_polygon_attrib
1082 {
1083    GLenum FrontFace;            /**< Either GL_CW or GL_CCW */
1084    GLenum FrontMode;            /**< Either GL_POINT, GL_LINE or GL_FILL */
1085    GLenum BackMode;             /**< Either GL_POINT, GL_LINE or GL_FILL */
1086    GLboolean _FrontBit;         /**< 0=GL_CCW, 1=GL_CW */
1087    GLboolean CullFlag;          /**< Culling on/off flag */
1088    GLboolean SmoothFlag;        /**< True if GL_POLYGON_SMOOTH is enabled */
1089    GLboolean StippleFlag;       /**< True if GL_POLYGON_STIPPLE is enabled */
1090    GLenum CullFaceMode;         /**< Culling mode GL_FRONT or GL_BACK */
1091    GLfloat OffsetFactor;        /**< Polygon offset factor, from user */
1092    GLfloat OffsetUnits;         /**< Polygon offset units, from user */
1093    GLboolean OffsetPoint;       /**< Offset in GL_POINT mode */
1094    GLboolean OffsetLine;        /**< Offset in GL_LINE mode */
1095    GLboolean OffsetFill;        /**< Offset in GL_FILL mode */
1096 };
1097
1098
1099 /**
1100  * Scissor attributes (GL_SCISSOR_BIT).
1101  */
1102 struct gl_scissor_attrib
1103 {
1104    GLboolean Enabled;           /**< Scissor test enabled? */
1105    GLint X, Y;                  /**< Lower left corner of box */
1106    GLsizei Width, Height;       /**< Size of box */
1107 };
1108
1109
1110 /**
1111  * Stencil attribute group (GL_STENCIL_BUFFER_BIT).
1112  */
1113 struct gl_stencil_attrib
1114 {
1115    GLboolean Enabled;           /**< Enabled flag */
1116    GLboolean TestTwoSide;       /**< GL_EXT_stencil_two_side */
1117    GLubyte ActiveFace;          /**< GL_EXT_stencil_two_side (0 or 1) */
1118    GLboolean _TestTwoSide;
1119    GLenum Function[2];          /**< Stencil function */
1120    GLenum FailFunc[2];          /**< Fail function */
1121    GLenum ZPassFunc[2];         /**< Depth buffer pass function */
1122    GLenum ZFailFunc[2];         /**< Depth buffer fail function */
1123    GLint Ref[2];                /**< Reference value */
1124    GLuint ValueMask[2];         /**< Value mask */
1125    GLuint WriteMask[2];         /**< Write mask */
1126    GLuint Clear;                /**< Clear value */
1127 };
1128
1129
1130 #define NUM_TEXTURE_TARGETS 5   /* 1D, 2D, 3D, CUBE and RECT */
1131
1132 /**
1133  * An index for each type of texture object
1134  */
1135 /*@{*/
1136 #define TEXTURE_1D_INDEX    0
1137 #define TEXTURE_2D_INDEX    1
1138 #define TEXTURE_3D_INDEX    2
1139 #define TEXTURE_CUBE_INDEX  3
1140 #define TEXTURE_RECT_INDEX  4
1141 /*@}*/
1142
1143 /**
1144  * Bit flags for each type of texture object
1145  * Used for Texture.Unit[]._ReallyEnabled flags.
1146  */
1147 /*@{*/
1148 #define TEXTURE_1D_BIT   (1 << TEXTURE_1D_INDEX)
1149 #define TEXTURE_2D_BIT   (1 << TEXTURE_2D_INDEX)
1150 #define TEXTURE_3D_BIT   (1 << TEXTURE_3D_INDEX)
1151 #define TEXTURE_CUBE_BIT (1 << TEXTURE_CUBE_INDEX)
1152 #define TEXTURE_RECT_BIT (1 << TEXTURE_RECT_INDEX)
1153 /*@}*/
1154
1155
1156 /**
1157  * TexGenEnabled flags.
1158  */
1159 /*@{*/
1160 #define S_BIT 1
1161 #define T_BIT 2
1162 #define R_BIT 4
1163 #define Q_BIT 8
1164 /*@}*/
1165
1166
1167 /**
1168  * Bit flag versions of the corresponding GL_ constants.
1169  */
1170 /*@{*/
1171 #define TEXGEN_SPHERE_MAP        0x1
1172 #define TEXGEN_OBJ_LINEAR        0x2
1173 #define TEXGEN_EYE_LINEAR        0x4
1174 #define TEXGEN_REFLECTION_MAP_NV 0x8
1175 #define TEXGEN_NORMAL_MAP_NV     0x10
1176
1177 #define TEXGEN_NEED_NORMALS      (TEXGEN_SPHERE_MAP        | \
1178                                   TEXGEN_REFLECTION_MAP_NV | \
1179                                   TEXGEN_NORMAL_MAP_NV)
1180 #define TEXGEN_NEED_EYE_COORD    (TEXGEN_SPHERE_MAP        | \
1181                                   TEXGEN_REFLECTION_MAP_NV | \
1182                                   TEXGEN_NORMAL_MAP_NV     | \
1183                                   TEXGEN_EYE_LINEAR)
1184 /*@}*/
1185
1186
1187 /* A selection of state flags to make driver and module's lives easier. */
1188 #define ENABLE_TEXGEN0        0x1
1189 #define ENABLE_TEXGEN1        0x2
1190 #define ENABLE_TEXGEN2        0x4
1191 #define ENABLE_TEXGEN3        0x8
1192 #define ENABLE_TEXGEN4        0x10
1193 #define ENABLE_TEXGEN5        0x20
1194 #define ENABLE_TEXGEN6        0x40
1195 #define ENABLE_TEXGEN7        0x80
1196
1197 #define ENABLE_TEXMAT0        0x1       /* Ie. not the identity matrix */
1198 #define ENABLE_TEXMAT1        0x2
1199 #define ENABLE_TEXMAT2        0x4
1200 #define ENABLE_TEXMAT3        0x8
1201 #define ENABLE_TEXMAT4        0x10
1202 #define ENABLE_TEXMAT5        0x20
1203 #define ENABLE_TEXMAT6        0x40
1204 #define ENABLE_TEXMAT7        0x80
1205
1206 #define ENABLE_TEXGEN(i) (ENABLE_TEXGEN0 << (i))
1207 #define ENABLE_TEXMAT(i) (ENABLE_TEXMAT0 << (i))
1208
1209
1210 /**
1211  * Texel fetch function prototype.  We use texel fetch functions to
1212  * extract RGBA, color indexes and depth components out of 1D, 2D and 3D
1213  * texture images.  These functions help to isolate us from the gritty
1214  * details of all the various texture image encodings.
1215  *
1216  * \param texImage texture image.
1217  * \param col texel column.
1218  * \param row texel row.
1219  * \param img texel image level/layer.
1220  * \param texelOut output texel (up to 4 GLchans)
1221  */
1222 typedef void (*FetchTexelFuncC)( const struct gl_texture_image *texImage,
1223                                  GLint col, GLint row, GLint img,
1224                                  GLchan *texelOut );
1225
1226 /**
1227  * As above, but returns floats.
1228  * Used for depth component images and for upcoming signed/float
1229  * texture images.
1230  */
1231 typedef void (*FetchTexelFuncF)( const struct gl_texture_image *texImage,
1232                                  GLint col, GLint row, GLint img,
1233                                  GLfloat *texelOut );
1234
1235
1236 typedef void (*StoreTexelFunc)(struct gl_texture_image *texImage,
1237                                GLint col, GLint row, GLint img,
1238                                const void *texel);
1239
1240
1241 /**
1242  * This macro defines the (many) parameters to the texstore functions.
1243  * \param dims  either 1 or 2 or 3
1244  * \param baseInternalFormat  user-specified base internal format
1245  * \param dstFormat  destination Mesa texture format
1246  * \param dstAddr  destination image address
1247  * \param dstX/Y/Zoffset  destination x/y/z offset (ala TexSubImage), in texels
1248  * \param dstRowStride  destination image row stride, in bytes
1249  * \param dstImageOffsets  offset of each 2D slice within 3D texture, in texels
1250  * \param srcWidth/Height/Depth  source image size, in pixels
1251  * \param srcFormat  incoming image format
1252  * \param srcType  incoming image data type
1253  * \param srcAddr  source image address
1254  * \param srcPacking  source image packing parameters
1255  */
1256 #define TEXSTORE_PARAMS \
1257         GLcontext *ctx, GLuint dims, \
1258         GLenum baseInternalFormat, \
1259         const struct gl_texture_format *dstFormat, \
1260         GLvoid *dstAddr, \
1261         GLint dstXoffset, GLint dstYoffset, GLint dstZoffset, \
1262         GLint dstRowStride, const GLuint *dstImageOffsets, \
1263         GLint srcWidth, GLint srcHeight, GLint srcDepth, \
1264         GLenum srcFormat, GLenum srcType, \
1265         const GLvoid *srcAddr, \
1266         const struct gl_pixelstore_attrib *srcPacking
1267
1268
1269
1270 /**
1271  * Texture image storage function.
1272  */
1273 typedef GLboolean (*StoreTexImageFunc)(TEXSTORE_PARAMS);
1274
1275
1276 /**
1277  * Texture format record
1278  */
1279 struct gl_texture_format
1280 {
1281    GLint MesaFormat;            /**< One of the MESA_FORMAT_* values */
1282
1283    GLenum BaseFormat;           /**< Either GL_RGB, GL_RGBA, GL_ALPHA,
1284                                  *   GL_LUMINANCE, GL_LUMINANCE_ALPHA,
1285                                  *   GL_INTENSITY, GL_COLOR_INDEX or
1286                                  *   GL_DEPTH_COMPONENT.
1287                                  */
1288    GLenum DataType;             /**< GL_FLOAT or GL_UNSIGNED_NORMALIZED_ARB */
1289    GLubyte RedBits;             /**< Bits per texel component */
1290    GLubyte GreenBits;           /**< These are just rough approximations for */
1291    GLubyte BlueBits;            /**< compressed texture formats. */
1292    GLubyte AlphaBits;
1293    GLubyte LuminanceBits;
1294    GLubyte IntensityBits;
1295    GLubyte IndexBits;
1296    GLubyte DepthBits;
1297    GLubyte StencilBits;         /**< GL_EXT_packed_depth_stencil */
1298
1299    GLuint TexelBytes;           /**< Bytes per texel, 0 if compressed format */
1300
1301    StoreTexImageFunc StoreImage;
1302
1303    /**
1304     * \name Texel fetch function pointers
1305     */
1306    /*@{*/
1307    FetchTexelFuncC FetchTexel1D;
1308    FetchTexelFuncC FetchTexel2D;
1309    FetchTexelFuncC FetchTexel3D;
1310    FetchTexelFuncF FetchTexel1Df;
1311    FetchTexelFuncF FetchTexel2Df;
1312    FetchTexelFuncF FetchTexel3Df;
1313    /*@}*/
1314
1315    StoreTexelFunc StoreTexel;
1316 };
1317
1318
1319 #define MAX_3D_TEXTURE_SIZE (1 << (MAX_3D_TEXTURE_LEVELS - 1))
1320
1321 /**
1322  * Texture image state.  Describes the dimensions of a texture image,
1323  * the texel format and pointers to Texel Fetch functions.
1324  */
1325 struct gl_texture_image
1326 {
1327    GLenum _BaseFormat;          /**< Either GL_RGB, GL_RGBA, GL_ALPHA,
1328                                  *   GL_LUMINANCE, GL_LUMINANCE_ALPHA,
1329                                  *   GL_INTENSITY, GL_COLOR_INDEX,
1330                                  *   GL_DEPTH_COMPONENT or GL_DEPTH_STENCIL_EXT
1331                                  *   only. Used for choosing TexEnv arithmetic.
1332                                  */
1333    GLint InternalFormat;        /**< Internal format as given by the user */
1334    GLuint Border;               /**< 0 or 1 */
1335    GLuint Width;                /**< = 2^WidthLog2 + 2*Border */
1336    GLuint Height;               /**< = 2^HeightLog2 + 2*Border */
1337    GLuint Depth;                /**< = 2^DepthLog2 + 2*Border */
1338    GLuint Width2;               /**< = Width - 2*Border */
1339    GLuint Height2;              /**< = Height - 2*Border */
1340    GLuint Depth2;               /**< = Depth - 2*Border */
1341    GLuint WidthLog2;            /**< = log2(Width2) */
1342    GLuint HeightLog2;           /**< = log2(Height2) */
1343    GLuint DepthLog2;            /**< = log2(Depth2) */
1344    GLuint MaxLog2;              /**< = MAX(WidthLog2, HeightLog2) */
1345    GLfloat WidthScale;          /**< used for mipmap LOD computation */
1346    GLfloat HeightScale;         /**< used for mipmap LOD computation */
1347    GLfloat DepthScale;          /**< used for mipmap LOD computation */
1348    GLboolean IsClientData;      /**< Data owned by client? */
1349    GLboolean _IsPowerOfTwo;     /**< Are all dimensions powers of two? */
1350
1351    const struct gl_texture_format *TexFormat;
1352
1353    struct gl_texture_object *TexObject;  /**< Pointer back to parent object */
1354
1355    FetchTexelFuncC FetchTexelc; /**< GLchan texel fetch function pointer */
1356    FetchTexelFuncF FetchTexelf; /**< Float texel fetch function pointer */
1357
1358    GLboolean IsCompressed;      /**< GL_ARB_texture_compression */
1359    GLuint CompressedSize;       /**< GL_ARB_texture_compression */
1360
1361    GLuint RowStride;            /**< == Width unless IsClientData and padded */
1362    GLuint *ImageOffsets;        /**< if 3D texture: array [Depth] of offsets to
1363                                      each 2D slice in 'Data', in texels */
1364    GLvoid *Data;                /**< Image data, accessed via FetchTexel() */
1365
1366    /**
1367     * \name For device driver:
1368     */
1369    /*@{*/
1370    void *DriverData;            /**< Arbitrary device driver data */
1371    /*@}*/
1372 };
1373
1374
1375 /**
1376  * Indexes for cube map faces.
1377  */
1378 /*@{*/
1379 #define FACE_POS_X   0
1380 #define FACE_NEG_X   1
1381 #define FACE_POS_Y   2
1382 #define FACE_NEG_Y   3
1383 #define FACE_POS_Z   4
1384 #define FACE_NEG_Z   5
1385 #define MAX_FACES  6
1386 /*@}*/
1387
1388
1389 /**
1390  * Texture object state.  Contains the array of mipmap images, border color,
1391  * wrap modes, filter modes, shadow/texcompare state, and the per-texture
1392  * color palette.
1393  */
1394 struct gl_texture_object
1395 {
1396    _glthread_Mutex Mutex;       /**< for thread safety */
1397    GLint RefCount;              /**< reference count */
1398    GLuint Name;                 /**< the user-visible texture object ID */
1399    GLenum Target;               /**< GL_TEXTURE_1D, GL_TEXTURE_2D, etc. */
1400    GLfloat Priority;            /**< in [0,1] */
1401    GLfloat BorderColor[4];      /**< unclamped */
1402    GLchan _BorderChan[4];       /**< clamped, as GLchan */
1403    GLenum WrapS;                /**< S-axis texture image wrap mode */
1404    GLenum WrapT;                /**< T-axis texture image wrap mode */
1405    GLenum WrapR;                /**< R-axis texture image wrap mode */
1406    GLenum MinFilter;            /**< minification filter */
1407    GLenum MagFilter;            /**< magnification filter */
1408    GLfloat MinLod;              /**< min lambda, OpenGL 1.2 */
1409    GLfloat MaxLod;              /**< max lambda, OpenGL 1.2 */
1410    GLfloat LodBias;             /**< OpenGL 1.4 */
1411    GLint BaseLevel;             /**< min mipmap level, OpenGL 1.2 */
1412    GLint MaxLevel;              /**< max mipmap level, OpenGL 1.2 */
1413    GLfloat MaxAnisotropy;       /**< GL_EXT_texture_filter_anisotropic */
1414    GLboolean CompareFlag;       /**< GL_SGIX_shadow */
1415    GLenum CompareOperator;      /**< GL_SGIX_shadow */
1416    GLfloat ShadowAmbient;       /**< GL_ARB_shadow_ambient */
1417    GLenum CompareMode;          /**< GL_ARB_shadow */
1418    GLenum CompareFunc;          /**< GL_ARB_shadow */
1419    GLenum DepthMode;            /**< GL_ARB_depth_texture */
1420    GLint _MaxLevel;             /**< actual max mipmap level (q in the spec) */
1421    GLfloat _MaxLambda;          /**< = _MaxLevel - BaseLevel (q - b in spec) */
1422    GLboolean GenerateMipmap;    /**< GL_SGIS_generate_mipmap */
1423    GLboolean Complete;          /**< Is texture object complete? */
1424
1425    /** Actual texture images, indexed by [cube face] and [mipmap level] */
1426    struct gl_texture_image *Image[MAX_FACES][MAX_TEXTURE_LEVELS];
1427
1428    /** GL_EXT_paletted_texture */
1429    struct gl_color_table Palette;
1430
1431
1432    /**
1433     * \name For device driver.
1434     * Note: instead of attaching driver data to this pointer, it's preferable
1435     * to instead use this struct as a base class for your own texture object
1436     * class.  Driver->NewTextureObject() can be used to implement the
1437     * allocation.
1438     */
1439    void *DriverData;    /**< Arbitrary device driver data */
1440 };
1441
1442
1443 /**
1444  * Texture combine environment state.
1445  *
1446  * \todo
1447  * If GL_NV_texture_env_combine4 is ever supported, the arrays in this
1448  * structure will need to be expanded for 4 elements.
1449  */
1450 struct gl_tex_env_combine_state
1451 {
1452    GLenum ModeRGB;       /**< GL_REPLACE, GL_DECAL, GL_ADD, etc. */
1453    GLenum ModeA;         /**< GL_REPLACE, GL_DECAL, GL_ADD, etc. */
1454    GLenum SourceRGB[3];  /**< GL_PRIMARY_COLOR, GL_TEXTURE, etc. */
1455    GLenum SourceA[3];    /**< GL_PRIMARY_COLOR, GL_TEXTURE, etc. */
1456    GLenum OperandRGB[3]; /**< SRC_COLOR, ONE_MINUS_SRC_COLOR, etc */
1457    GLenum OperandA[3];   /**< SRC_ALPHA, ONE_MINUS_SRC_ALPHA, etc */
1458    GLuint ScaleShiftRGB; /**< 0, 1 or 2 */
1459    GLuint ScaleShiftA;   /**< 0, 1 or 2 */
1460    GLuint _NumArgsRGB;   /**< Number of inputs used for the combine mode. */
1461    GLuint _NumArgsA;     /**< Number of inputs used for the combine mode. */
1462 };
1463
1464
1465 /**
1466  * Texture unit state.  Contains enable flags, texture environment/function/
1467  * combiners, texgen state, pointers to current texture objects and
1468  * post-filter color tables.
1469  */
1470 struct gl_texture_unit
1471 {
1472    GLbitfield Enabled;          /**< bitmask of TEXTURE_*_BIT flags */
1473    GLbitfield _ReallyEnabled;   /**< 0 or exactly one of TEXTURE_*_BIT flags */
1474
1475    GLenum EnvMode;              /**< GL_MODULATE, GL_DECAL, GL_BLEND, etc. */
1476    GLfloat EnvColor[4];
1477    GLbitfield TexGenEnabled;    /**< Bitwise-OR of [STRQ]_BIT values */
1478    /** \name Tex coord generation mode
1479     * Either GL_OBJECT_LINEAR, GL_EYE_LINEAR or GL_SPHERE_MAP. */
1480    /*@{*/
1481    GLenum GenModeS;
1482    GLenum GenModeT;
1483    GLenum GenModeR;
1484    GLenum GenModeQ;
1485    /*@}*/
1486    GLbitfield _GenBitS;
1487    GLbitfield _GenBitT;
1488    GLbitfield _GenBitR;
1489    GLbitfield _GenBitQ;
1490    GLbitfield _GenFlags;        /**< bitwise or of GenBit[STRQ] */
1491    GLfloat ObjectPlaneS[4];
1492    GLfloat ObjectPlaneT[4];
1493    GLfloat ObjectPlaneR[4];
1494    GLfloat ObjectPlaneQ[4];
1495    GLfloat EyePlaneS[4];
1496    GLfloat EyePlaneT[4];
1497    GLfloat EyePlaneR[4];
1498    GLfloat EyePlaneQ[4];
1499    GLfloat LodBias;             /**< for biasing mipmap levels */
1500
1501    /**
1502     * \name GL_EXT_texture_env_combine
1503     */
1504    struct gl_tex_env_combine_state Combine;
1505
1506    /**
1507     * Derived state based on \c EnvMode and the \c BaseFormat of the
1508     * currently enabled texture.
1509     */
1510    struct gl_tex_env_combine_state _EnvMode;
1511
1512    /**
1513     * Currently enabled combiner state.  This will point to either
1514     * \c Combine or \c _EnvMode.
1515     */
1516    struct gl_tex_env_combine_state *_CurrentCombine;
1517
1518    struct gl_texture_object *Current1D;
1519    struct gl_texture_object *Current2D;
1520    struct gl_texture_object *Current3D;
1521    struct gl_texture_object *CurrentCubeMap; /**< GL_ARB_texture_cube_map */
1522    struct gl_texture_object *CurrentRect;    /**< GL_NV_texture_rectangle */
1523
1524    struct gl_texture_object *_Current; /**< Points to really enabled tex obj */
1525
1526    struct gl_texture_object Saved1D;  /**< only used by glPush/PopAttrib */
1527    struct gl_texture_object Saved2D;
1528    struct gl_texture_object Saved3D;
1529    struct gl_texture_object SavedCubeMap;
1530    struct gl_texture_object SavedRect;
1531
1532    /* GL_SGI_texture_color_table */
1533    struct gl_color_table ColorTable;
1534    struct gl_color_table ProxyColorTable;
1535    GLboolean ColorTableEnabled;
1536 };
1537
1538 struct texenvprog_cache_item {
1539    GLuint hash;
1540    void *key;
1541    struct gl_fragment_program *data;
1542    struct texenvprog_cache_item *next;
1543 };
1544
1545 struct texenvprog_cache {
1546    struct texenvprog_cache_item **items;
1547    GLuint size, n_items;
1548    GLcontext *ctx;
1549 };
1550
1551 /**
1552  * Texture attribute group (GL_TEXTURE_BIT).
1553  */
1554 struct gl_texture_attrib
1555 {
1556    /**
1557     * name multitexture
1558     */
1559    /**@{*/
1560    GLuint CurrentUnit;         /**< Active texture unit */
1561    GLbitfield _EnabledUnits;  /**< one bit set for each really-enabled unit */
1562    GLbitfield _EnabledCoordUnits;   /**< one bit per enabled coordinate unit */
1563    GLbitfield _GenFlags;            /**< for texgen */
1564    GLbitfield _TexGenEnabled;
1565    GLbitfield _TexMatEnabled;
1566    /**@}*/
1567
1568    struct gl_texture_unit Unit[MAX_TEXTURE_UNITS];
1569
1570    struct gl_texture_object *Proxy1D;
1571    struct gl_texture_object *Proxy2D;
1572    struct gl_texture_object *Proxy3D;
1573    struct gl_texture_object *ProxyCubeMap;
1574    struct gl_texture_object *ProxyRect;
1575
1576    /** GL_EXT_shared_texture_palette */
1577    GLboolean SharedPalette;
1578    struct gl_color_table Palette;
1579
1580    /** Cached texenv fragment programs */
1581    struct texenvprog_cache env_fp_cache;
1582 };
1583
1584
1585 /**
1586  * Transformation attribute group (GL_TRANSFORM_BIT).
1587  */
1588 struct gl_transform_attrib
1589 {
1590    GLenum MatrixMode;                           /**< Matrix mode */
1591    GLfloat EyeUserPlane[MAX_CLIP_PLANES][4];    /**< User clip planes */
1592    GLfloat _ClipUserPlane[MAX_CLIP_PLANES][4];  /**< derived */
1593    GLbitfield ClipPlanesEnabled;                /**< on/off bitmask */
1594    GLboolean Normalize;                         /**< Normalize all normals? */
1595    GLboolean RescaleNormals;                    /**< GL_EXT_rescale_normal */
1596    GLboolean RasterPositionUnclipped;           /**< GL_IBM_rasterpos_clip */
1597
1598    GLboolean CullVertexFlag;    /**< True if GL_CULL_VERTEX_EXT is enabled */
1599    GLfloat CullEyePos[4];
1600    GLfloat CullObjPos[4];
1601 };
1602
1603
1604 /**
1605  * Viewport attribute group (GL_VIEWPORT_BIT).
1606  */
1607 struct gl_viewport_attrib
1608 {
1609    GLint X, Y;                  /**< position */
1610    GLsizei Width, Height;       /**< size */
1611    GLfloat Near, Far;           /**< Depth buffer range */
1612    GLmatrix _WindowMap;         /**< Mapping transformation as a matrix. */
1613 };
1614
1615
1616 /**
1617  * Node for the attribute stack.
1618  */
1619 struct gl_attrib_node
1620 {
1621    GLbitfield kind;
1622    void *data;
1623    struct gl_attrib_node *next;
1624 };
1625
1626
1627 /**
1628  * GL_ARB_vertex/pixel_buffer_object buffer object
1629  */
1630 struct gl_buffer_object
1631 {
1632    GLint RefCount;
1633    GLuint Name;
1634    GLenum Usage;
1635    GLenum Access;
1636    GLvoid *Pointer;          /**< Only valid while buffer is mapped */
1637    GLsizeiptrARB Size;       /**< Size of storage in bytes */
1638    GLubyte *Data;            /**< Location of storage either in RAM or VRAM. */
1639    GLboolean OnCard;         /**< Is buffer in VRAM? (hardware drivers) */
1640 };
1641
1642
1643
1644 /**
1645  * Client pixel packing/unpacking attributes
1646  */
1647 struct gl_pixelstore_attrib
1648 {
1649    GLint Alignment;
1650    GLint RowLength;
1651    GLint SkipPixels;
1652    GLint SkipRows;
1653    GLint ImageHeight;     /**< for GL_EXT_texture3D */
1654    GLint SkipImages;      /**< for GL_EXT_texture3D */
1655    GLboolean SwapBytes;
1656    GLboolean LsbFirst;
1657    GLboolean ClientStorage; /**< GL_APPLE_client_storage */
1658    GLboolean Invert;        /**< GL_MESA_pack_invert */
1659    struct gl_buffer_object *BufferObj; /**< GL_ARB_pixel_buffer_object */
1660 };
1661
1662
1663
1664 /**
1665  * Client vertex array attributes
1666  */
1667 struct gl_client_array
1668 {
1669    GLint Size;                  /**< components per element (1,2,3,4) */
1670    GLenum Type;                 /**< datatype: GL_FLOAT, GL_INT, etc */
1671    GLsizei Stride;              /**< user-specified stride */
1672    GLsizei StrideB;             /**< actual stride in bytes */
1673    const GLubyte *Ptr;          /**< Points to array data */
1674    GLboolean Enabled;           /**< Enabled flag is a boolean */
1675    GLboolean Normalized;        /**< GL_ARB_vertex_program */
1676
1677    /**< GL_ARB_vertex_buffer_object */
1678    struct gl_buffer_object *BufferObj;
1679    GLuint _MaxElement;
1680 };
1681
1682
1683 /**
1684  * Collection of vertex arrays.  Defined by the GL_APPLE_vertex_array_object
1685  * extension, but a nice encapsulation in any case.
1686  */
1687 struct gl_array_object
1688 {
1689    /** Name of the array object as received from glGenVertexArrayAPPLE. */
1690    GLuint Name;
1691
1692    /** Conventional vertex arrays */
1693    /*@{*/
1694    struct gl_client_array Vertex;
1695    struct gl_client_array Normal;
1696    struct gl_client_array Color;
1697    struct gl_client_array SecondaryColor;
1698    struct gl_client_array FogCoord;
1699    struct gl_client_array Index;
1700    struct gl_client_array EdgeFlag;
1701    struct gl_client_array TexCoord[MAX_TEXTURE_COORD_UNITS];
1702    /*@}*/
1703
1704    /** Generic arrays for vertex programs/shaders */
1705    struct gl_client_array VertexAttrib[VERT_ATTRIB_MAX];
1706
1707    /** Mask of _NEW_ARRAY_* values indicating which arrays are enabled */
1708    GLbitfield _Enabled;
1709 };
1710
1711
1712 /**
1713  * Vertex array state
1714  */
1715 struct gl_array_attrib
1716 {
1717    struct gl_array_object *ArrayObj;
1718    struct gl_array_object *DefaultArrayObj;
1719
1720    GLint ActiveTexture;         /**< Client Active Texture */
1721    GLuint LockFirst;            /**< GL_EXT_compiled_vertex_array */
1722    GLuint LockCount;            /**< GL_EXT_compiled_vertex_array */
1723
1724    GLbitfield NewState;         /**< mask of _NEW_ARRAY_* values */
1725
1726 #if FEATURE_ARB_vertex_buffer_object
1727    struct gl_buffer_object *NullBufferObj;
1728    struct gl_buffer_object *ArrayBufferObj;
1729    struct gl_buffer_object *ElementArrayBufferObj;
1730 #endif
1731    GLuint _MaxElement;          /* Min of all enabled array's maxes */
1732 };
1733
1734
1735 /**
1736  * Feedback buffer state
1737  */
1738 struct gl_feedback
1739 {
1740    GLenum Type;
1741    GLbitfield _Mask;            /* FB_* bits */
1742    GLfloat *Buffer;
1743    GLuint BufferSize;
1744    GLuint Count;
1745 };
1746
1747
1748 /**
1749  * Selection buffer state
1750  */
1751 struct gl_selection
1752 {
1753    GLuint *Buffer;      /**< selection buffer */
1754    GLuint BufferSize;   /**< size of the selection buffer */
1755    GLuint BufferCount;  /**< number of values in the selection buffer */
1756    GLuint Hits;         /**< number of records in the selection buffer */
1757    GLuint NameStackDepth; /**< name stack depth */
1758    GLuint NameStack[MAX_NAME_STACK_DEPTH]; /**< name stack */
1759    GLboolean HitFlag;   /**< hit flag */
1760    GLfloat HitMinZ;     /**< minimum hit depth */
1761    GLfloat HitMaxZ;     /**< maximum hit depth */
1762 };
1763
1764
1765 /**
1766  * 1-D Evaluator control points
1767  */
1768 struct gl_1d_map
1769 {
1770    GLuint Order;        /**< Number of control points */
1771    GLfloat u1, u2, du;  /**< u1, u2, 1.0/(u2-u1) */
1772    GLfloat *Points;     /**< Points to contiguous control points */
1773 };
1774
1775
1776 /**
1777  * 2-D Evaluator control points
1778  */
1779 struct gl_2d_map
1780 {
1781    GLuint Uorder;               /**< Number of control points in U dimension */
1782    GLuint Vorder;               /**< Number of control points in V dimension */
1783    GLfloat u1, u2, du;
1784    GLfloat v1, v2, dv;
1785    GLfloat *Points;             /**< Points to contiguous control points */
1786 };
1787
1788
1789 /**
1790  * All evaluator control point state
1791  */
1792 struct gl_evaluators
1793 {
1794    /**
1795     * \name 1-D maps
1796     */
1797    /*@{*/
1798    struct gl_1d_map Map1Vertex3;
1799    struct gl_1d_map Map1Vertex4;
1800    struct gl_1d_map Map1Index;
1801    struct gl_1d_map Map1Color4;
1802    struct gl_1d_map Map1Normal;
1803    struct gl_1d_map Map1Texture1;
1804    struct gl_1d_map Map1Texture2;
1805    struct gl_1d_map Map1Texture3;
1806    struct gl_1d_map Map1Texture4;
1807    struct gl_1d_map Map1Attrib[16];  /**< GL_NV_vertex_program */
1808    /*@}*/
1809
1810    /**
1811     * \name 2-D maps
1812     */
1813    /*@{*/
1814    struct gl_2d_map Map2Vertex3;
1815    struct gl_2d_map Map2Vertex4;
1816    struct gl_2d_map Map2Index;
1817    struct gl_2d_map Map2Color4;
1818    struct gl_2d_map Map2Normal;
1819    struct gl_2d_map Map2Texture1;
1820    struct gl_2d_map Map2Texture2;
1821    struct gl_2d_map Map2Texture3;
1822    struct gl_2d_map Map2Texture4;
1823    struct gl_2d_map Map2Attrib[16];  /**< GL_NV_vertex_program */
1824    /*@}*/
1825 };
1826
1827
1828 /**
1829  * Names of the various vertex/fragment program register files, etc.
1830  *
1831  * NOTE: first four tokens must fit into 2 bits (see t_vb_arbprogram.c)
1832  * All values should fit in a 4-bit field.
1833  *
1834  * NOTE: PROGRAM_ENV_PARAM, PROGRAM_STATE_VAR, PROGRAM_NAMED_PARAM,
1835  * PROGRAM_CONSTANT, and PROGRAM_UNIFORM can all be considered to
1836  * be "uniform" variables since they can only be set outside glBegin/End.
1837  * They're also all stored in the same Parameters array.
1838  */
1839 enum register_file
1840 {
1841    PROGRAM_TEMPORARY = 0,   /**< machine->Temporary[] */
1842    PROGRAM_LOCAL_PARAM = 1, /**< gl_program->LocalParams[] */
1843    PROGRAM_ENV_PARAM = 2,   /**< gl_program->Parameters[] */
1844    PROGRAM_STATE_VAR = 3,   /**< gl_program->Parameters[] */
1845    PROGRAM_INPUT = 4,       /**< machine->Inputs[] */
1846    PROGRAM_OUTPUT = 5,      /**< machine->Outputs[] */
1847    PROGRAM_NAMED_PARAM = 6, /**< gl_program->Parameters[] */
1848    PROGRAM_CONSTANT = 7,    /**< gl_program->Parameters[] */
1849    PROGRAM_UNIFORM = 8,     /**< gl_program->Parameters[] */
1850    PROGRAM_VARYING = 9,     /**< machine->Inputs[]/Outputs[] */
1851    PROGRAM_WRITE_ONLY = 10, /**< A dummy, write-only register */
1852    PROGRAM_ADDRESS = 11,    /**< machine->AddressReg */
1853    PROGRAM_SAMPLER = 12,    /**< for shader samplers, compile-time only */
1854    PROGRAM_UNDEFINED = 13,  /**< Invalid value */
1855    PROGRAM_FILE_MAX
1856 };
1857
1858
1859 /** Vertex and fragment instructions */
1860 struct prog_instruction;
1861 struct gl_program_parameter_list;
1862
1863
1864 /**
1865  * Base class for any kind of program object
1866  */
1867 struct gl_program
1868 {
1869    GLuint Id;
1870    GLubyte *String;  /**< Null-terminated program text */
1871    GLint RefCount;
1872    GLenum Target;    /**< GL_VERTEX/FRAGMENT_PROGRAM_ARB, GL_FRAGMENT_PROGRAM_NV */
1873    GLenum Format;    /**< String encoding format */
1874    GLboolean Resident;
1875
1876    struct prog_instruction *Instructions;
1877
1878    GLbitfield InputsRead;     /**< Bitmask of which input regs are read */
1879    GLbitfield OutputsWritten; /**< Bitmask of which output regs are written to */
1880    GLbitfield TexturesUsed[MAX_TEXTURE_IMAGE_UNITS];  /**< TEXTURE_x_BIT bitmask */
1881
1882    /** Named parameters, constants, etc. from program text */
1883    struct gl_program_parameter_list *Parameters;
1884    /** Numbered local parameters */
1885    GLfloat LocalParams[MAX_PROGRAM_LOCAL_PARAMS][4];
1886
1887    /** Vertex/fragment shader varying vars */
1888    struct gl_program_parameter_list *Varying;
1889    /** Vertex program user-defined attributes */
1890    struct gl_program_parameter_list *Attributes;
1891
1892    /** Logical counts */
1893    /*@{*/
1894    GLuint NumInstructions;
1895    GLuint NumTemporaries;
1896    GLuint NumParameters;
1897    GLuint NumAttributes;
1898    GLuint NumAddressRegs;
1899    GLuint NumAluInstructions;
1900    GLuint NumTexInstructions;
1901    GLuint NumTexIndirections;
1902    /*@}*/
1903    /** Native, actual h/w counts */
1904    /*@{*/
1905    GLuint NumNativeInstructions;
1906    GLuint NumNativeTemporaries;
1907    GLuint NumNativeParameters;
1908    GLuint NumNativeAttributes;
1909    GLuint NumNativeAddressRegs;
1910    GLuint NumNativeAluInstructions;
1911    GLuint NumNativeTexInstructions;
1912    GLuint NumNativeTexIndirections;
1913    /*@}*/
1914 };
1915
1916
1917 /** Vertex program object */
1918 struct gl_vertex_program
1919 {
1920    struct gl_program Base;   /**< base class */
1921    GLboolean IsNVProgram;    /**< is this a GL_NV_vertex_program program? */
1922    GLboolean IsPositionInvariant;
1923    void *TnlData;               /**< should probably use Base.DriverData */
1924 };
1925
1926
1927 /** Fragment program object */
1928 struct gl_fragment_program
1929 {
1930    struct gl_program Base;   /**< base class */
1931    GLenum FogOption;
1932    GLboolean UsesKill;
1933 };
1934
1935
1936 /**
1937  * State common to vertex and fragment programs.
1938  */
1939 struct gl_program_state
1940 {
1941    GLint ErrorPos;                       /* GL_PROGRAM_ERROR_POSITION_ARB/NV */
1942    const char *ErrorString;              /* GL_PROGRAM_ERROR_STRING_ARB/NV */
1943 };
1944
1945
1946 /**
1947  * Context state for vertex programs.
1948  */
1949 struct gl_vertex_program_state
1950 {
1951    GLboolean Enabled;               /**< GL_VERTEX_PROGRAM_ARB/NV */
1952    GLboolean _Enabled;              /**< Enabled and valid program? */
1953    GLboolean PointSizeEnabled;      /**< GL_VERTEX_PROGRAM_POINT_SIZE_ARB/NV */
1954    GLboolean TwoSideEnabled;        /**< GL_VERTEX_PROGRAM_TWO_SIDE_ARB/NV */
1955    struct gl_vertex_program *Current;  /**< user-bound vertex program */
1956
1957    /** Currently enabled and valid program (including internal programs
1958     * and compiled shader programs).
1959     */
1960    struct gl_vertex_program *_Current;
1961
1962    GLfloat Parameters[MAX_PROGRAM_ENV_PARAMS][4]; /**< Env params */
1963
1964    /* For GL_NV_vertex_program only: */
1965    GLenum TrackMatrix[MAX_PROGRAM_ENV_PARAMS / 4];
1966    GLenum TrackMatrixTransform[MAX_PROGRAM_ENV_PARAMS / 4];
1967
1968    /** Should fixed-function T&L be implemented with a vertex prog? */
1969    GLboolean _MaintainTnlProgram;
1970
1971    /** Program to emulate fixed-function T&L (see above) */
1972    struct gl_vertex_program *_TnlProgram;
1973
1974 #if FEATURE_MESA_program_debug
1975    GLprogramcallbackMESA Callback;
1976    GLvoid *CallbackData;
1977    GLboolean CallbackEnabled;
1978    GLuint CurrentPosition;
1979 #endif
1980 };
1981
1982
1983 /**
1984  * Context state for fragment programs.
1985  */
1986 struct gl_fragment_program_state
1987 {
1988    GLboolean Enabled;     /**< User-set fragment program enable flag */
1989    GLboolean _Enabled;    /**< Fragment program enabled and valid? */
1990    GLboolean _Active;
1991    struct gl_fragment_program *Current;  /**< User-bound fragment program */
1992
1993    /** Currently enabled and valid program (including internal programs
1994     * and compiled shader programs).
1995     */
1996    struct gl_fragment_program *_Current;
1997
1998    GLfloat Parameters[MAX_PROGRAM_ENV_PARAMS][4]; /**< Env params */
1999
2000    /** Should fixed-function texturing be implemented with a fragment prog? */
2001    GLboolean _MaintainTexEnvProgram;
2002    GLboolean _UseTexEnvProgram;
2003
2004    /** Program to emulate fixed-function texture env/combine (see above) */
2005    struct gl_fragment_program *_TexEnvProgram;
2006
2007 #if FEATURE_MESA_program_debug
2008    GLprogramcallbackMESA Callback;
2009    GLvoid *CallbackData;
2010    GLboolean CallbackEnabled;
2011    GLuint CurrentPosition;
2012 #endif
2013 };
2014
2015
2016 /**
2017  * ATI_fragment_shader runtime state
2018  */
2019 #define ATI_FS_INPUT_PRIMARY 0
2020 #define ATI_FS_INPUT_SECONDARY 1
2021
2022 struct atifs_instruction;
2023 struct atifs_setupinst;
2024
2025 /**
2026  * ATI fragment shader
2027  */
2028 struct ati_fragment_shader
2029 {
2030    GLuint Id;
2031    GLint RefCount;
2032    struct atifs_instruction *Instructions[2];
2033    struct atifs_setupinst *SetupInst[2];
2034    GLfloat Constants[8][4];
2035    GLbitfield LocalConstDef;  /** Indicates which constants have been set */
2036    GLubyte numArithInstr[2];
2037    GLubyte regsAssigned[2];
2038    GLubyte NumPasses;         /** 1 or 2 */
2039    GLubyte cur_pass;
2040    GLubyte last_optype;
2041    GLboolean interpinp1;
2042    GLboolean isValid;
2043    GLuint swizzlerq;
2044 };
2045
2046 /**
2047  * Context state for GL_ATI_fragment_shader
2048  */
2049 struct gl_ati_fragment_shader_state
2050 {
2051    GLboolean Enabled;
2052    GLboolean _Enabled;                      /** enabled and valid shader? */
2053    GLboolean Compiling;
2054    GLfloat GlobalConstants[8][4];
2055    struct ati_fragment_shader *Current;
2056 };
2057
2058
2059 /**
2060  * Occlusion/timer query object.
2061  */
2062 struct gl_query_object
2063 {
2064    GLuint Id;
2065    GLuint64EXT Result; /* the counter */
2066    GLboolean Active;   /* inside Begin/EndQuery */
2067    GLboolean Ready;    /* result is ready */
2068 };
2069
2070
2071 /**
2072  * Context state for query objects.
2073  */
2074 struct gl_query_state
2075 {
2076    struct _mesa_HashTable *QueryObjects;
2077    struct gl_query_object *CurrentOcclusionObject; /* GL_ARB_occlusion_query */
2078    struct gl_query_object *CurrentTimerObject;     /* GL_EXT_timer_query */
2079 };
2080
2081
2082
2083 /**
2084  * A GLSL shader object.
2085  */
2086 struct gl_shader
2087 {
2088    GLenum Type;  /**< GL_FRAGMENT_SHADER || GL_VERTEX_SHADER (first field!) */
2089    GLuint Name;  /**< AKA the handle */
2090    GLint RefCount;  /**< Reference count */
2091    GLboolean DeletePending;
2092
2093    const GLchar *Source;  /**< Source code string */
2094    GLboolean CompileStatus;
2095    GLuint NumPrograms;  /**< size of Programs[] array */
2096    struct gl_program **Programs;  /**< Post-compile assembly code */
2097    GLchar *InfoLog;
2098 };
2099
2100
2101 /**
2102  * A GLSL program object.  Basically a linked collection of "shaders".
2103  */
2104 struct gl_shader_program
2105 {
2106    GLenum Type;  /**< Always GL_SHADER_PROGRAM (internal token) */
2107    GLuint Name;  /**< aka handle or ID */
2108    GLint RefCount;  /**< Reference count */
2109    GLboolean DeletePending;
2110
2111    GLuint NumShaders;          /**< number of attached shaders */
2112    struct gl_shader **Shaders; /**< List of attached the shaders */
2113
2114    /* post-link info: */
2115    struct gl_vertex_program *VertexProgram;     /**< Linked vertex program */
2116    struct gl_fragment_program *FragmentProgram; /**< Linked fragment prog */
2117    struct gl_program_parameter_list *Uniforms; /**< Plus constants, etc */
2118    struct gl_program_parameter_list *Varying;
2119    struct gl_program_parameter_list *Attributes; /**< Vertex attributes */
2120    GLboolean LinkStatus;   /**< GL_LINK_STATUS */
2121    GLboolean Validated;
2122    GLchar *InfoLog;
2123 };
2124
2125
2126 /**
2127  * Context state for GLSL vertex/fragment shaders.
2128  */
2129 struct gl_shader_state
2130 {
2131    struct gl_shader_program *CurrentProgram; /**< The user-bound program */
2132    /** Driver-selectable options: */
2133    GLboolean EmitHighLevelInstructions; /**< IF/ELSE/ENDIF vs. BRA, etc. */
2134    GLboolean EmitCondCodes;             /**< Use condition codes? */
2135    GLboolean EmitComments;              /**< Annotated instructions */
2136 };
2137
2138
2139 /**
2140  * State which can be shared by multiple contexts:
2141  */
2142 struct gl_shared_state
2143 {
2144    _glthread_Mutex Mutex;                  /**< for thread safety */
2145    GLint RefCount;                         /**< Reference count */
2146    struct _mesa_HashTable *DisplayList;    /**< Display lists hash table */
2147    struct _mesa_HashTable *TexObjects;     /**< Texture objects hash table */
2148
2149    /**
2150     * \name Default texture objects (shared by all multi-texture units)
2151     */
2152    /*@{*/
2153    struct gl_texture_object *Default1D;
2154    struct gl_texture_object *Default2D;
2155    struct gl_texture_object *Default3D;
2156    struct gl_texture_object *DefaultCubeMap;
2157    struct gl_texture_object *DefaultRect;
2158    /*@}*/
2159
2160    /**
2161     * \name Thread safety and statechange notification for texture
2162     * objects.
2163     *
2164     * \todo Improve the granularity of locking.
2165     */
2166    /*@{*/
2167    _glthread_Mutex TexMutex;               /**< texobj thread safety */
2168    GLuint TextureStateStamp;               /**< state notification for shared tex  */
2169    /*@}*/
2170
2171
2172
2173    /**
2174     * \name Vertex/fragment programs
2175     */
2176    /*@{*/
2177    struct _mesa_HashTable *Programs; /**< All vertex/fragment programs */
2178 #if FEATURE_ARB_vertex_program
2179    struct gl_program *DefaultVertexProgram;
2180 #endif
2181 #if FEATURE_ARB_fragment_program
2182    struct gl_program *DefaultFragmentProgram;
2183 #endif
2184    /*@}*/
2185
2186 #if FEATURE_ATI_fragment_shader
2187    struct _mesa_HashTable *ATIShaders;
2188    struct ati_fragment_shader *DefaultFragmentShader;
2189 #endif
2190
2191 #if FEATURE_ARB_vertex_buffer_object || FEATURE_ARB_pixel_buffer_object
2192    struct _mesa_HashTable *BufferObjects;
2193 #endif
2194
2195 #if FEATURE_ARB_shader_objects
2196    /** Table of both gl_shader and gl_shader_program objects */
2197    struct _mesa_HashTable *ShaderObjects;
2198 #endif
2199
2200 #if FEATURE_EXT_framebuffer_object
2201    struct _mesa_HashTable *RenderBuffers;
2202    struct _mesa_HashTable *FrameBuffers;
2203 #endif
2204
2205    /** Objects associated with the GL_APPLE_vertex_array_object extension. */
2206    struct _mesa_HashTable *ArrayObjects;
2207
2208    void *DriverData;  /**< Device driver shared state */
2209 };
2210
2211
2212
2213
2214 /**
2215  * A renderbuffer stores colors or depth values or stencil values.
2216  * A framebuffer object will have a collection of these.
2217  * Data are read/written to the buffer with a handful of Get/Put functions.
2218  *
2219  * Instances of this object are allocated with the Driver's NewRenderbuffer
2220  * hook.  Drivers will likely wrap this class inside a driver-specific
2221  * class to simulate inheritance.
2222  */
2223 struct gl_renderbuffer
2224 {
2225 #define RB_MAGIC 0xaabbccdd
2226    int Magic; /** XXX TEMPORARY DEBUG INFO */
2227    _glthread_Mutex Mutex;                  /**< for thread safety */
2228    GLuint ClassID;        /**< Useful for drivers */
2229    GLuint Name;
2230    GLint RefCount;
2231    GLuint Width, Height;
2232    GLenum InternalFormat; /**< The user-specified format */
2233    GLenum _ActualFormat;  /**< The driver-chosen format */
2234    GLenum _BaseFormat;    /**< Either GL_RGB, GL_RGBA, GL_DEPTH_COMPONENT or
2235                                GL_STENCIL_INDEX. */
2236    GLenum DataType;      /**< Type of values passed to the Get/Put functions */
2237    GLubyte RedBits;      /**< Bits of red per pixel */
2238    GLubyte GreenBits;
2239    GLubyte BlueBits;
2240    GLubyte AlphaBits;
2241    GLubyte IndexBits;
2242    GLubyte DepthBits;
2243    GLubyte StencilBits;
2244    GLvoid *Data;        /**< This may not be used by some kinds of RBs */
2245
2246    /* Used to wrap one renderbuffer around another: */
2247    struct gl_renderbuffer *Wrapped;
2248
2249    /* Delete this renderbuffer */
2250    void (*Delete)(struct gl_renderbuffer *rb);
2251
2252    /* Allocate new storage for this renderbuffer */
2253    GLboolean (*AllocStorage)(GLcontext *ctx, struct gl_renderbuffer *rb,
2254                              GLenum internalFormat,
2255                              GLuint width, GLuint height);
2256
2257    /* Lock/Unlock are called before/after calling the Get/Put functions.
2258     * Not sure this is the right place for these yet.
2259    void (*Lock)(GLcontext *ctx, struct gl_renderbuffer *rb);
2260    void (*Unlock)(GLcontext *ctx, struct gl_renderbuffer *rb);
2261     */
2262
2263    /* Return a pointer to the element/pixel at (x,y).
2264     * Should return NULL if the buffer memory can't be directly addressed.
2265     */
2266    void *(*GetPointer)(GLcontext *ctx, struct gl_renderbuffer *rb,
2267                        GLint x, GLint y);
2268
2269    /* Get/Read a row of values.
2270     * The values will be of format _BaseFormat and type DataType.
2271     */
2272    void (*GetRow)(GLcontext *ctx, struct gl_renderbuffer *rb, GLuint count,
2273                   GLint x, GLint y, void *values);
2274
2275    /* Get/Read values at arbitrary locations.
2276     * The values will be of format _BaseFormat and type DataType.
2277     */
2278    void (*GetValues)(GLcontext *ctx, struct gl_renderbuffer *rb, GLuint count,
2279                      const GLint x[], const GLint y[], void *values);
2280
2281    /* Put/Write a row of values.
2282     * The values will be of format _BaseFormat and type DataType.
2283     */
2284    void (*PutRow)(GLcontext *ctx, struct gl_renderbuffer *rb, GLuint count,
2285                   GLint x, GLint y, const void *values, const GLubyte *mask);
2286
2287    /* Put/Write a row of RGB values.  This is a special-case routine that's
2288     * only used for RGBA renderbuffers when the source data is GL_RGB. That's
2289     * a common case for glDrawPixels and some triangle routines.
2290     * The values will be of format GL_RGB and type DataType.
2291     */
2292    void (*PutRowRGB)(GLcontext *ctx, struct gl_renderbuffer *rb, GLuint count,
2293                     GLint x, GLint y, const void *values, const GLubyte *mask);
2294
2295
2296    /* Put/Write a row of identical values.
2297     * The values will be of format _BaseFormat and type DataType.
2298     */
2299    void (*PutMonoRow)(GLcontext *ctx, struct gl_renderbuffer *rb, GLuint count,
2300                      GLint x, GLint y, const void *value, const GLubyte *mask);
2301
2302    /* Put/Write values at arbitrary locations.
2303     * The values will be of format _BaseFormat and type DataType.
2304     */
2305    void (*PutValues)(GLcontext *ctx, struct gl_renderbuffer *rb, GLuint count,
2306                      const GLint x[], const GLint y[], const void *values,
2307                      const GLubyte *mask);
2308    /* Put/Write identical values at arbitrary locations.
2309     * The values will be of format _BaseFormat and type DataType.
2310     */
2311    void (*PutMonoValues)(GLcontext *ctx, struct gl_renderbuffer *rb,
2312                          GLuint count, const GLint x[], const GLint y[],
2313                          const void *value, const GLubyte *mask);
2314 };
2315
2316
2317 /**
2318  * A renderbuffer attachment point points to either a texture object
2319  * (and specifies a mipmap level, cube face or 3D texture slice) or
2320  * points to a renderbuffer.
2321  */
2322 struct gl_renderbuffer_attachment
2323 {
2324    GLenum Type;  /* GL_NONE or GL_TEXTURE or GL_RENDERBUFFER_EXT */
2325    GLboolean Complete;
2326
2327    /* IF Type == GL_RENDERBUFFER_EXT: */
2328    struct gl_renderbuffer *Renderbuffer;
2329
2330    /* IF Type == GL_TEXTURE: */
2331    struct gl_texture_object *Texture;
2332    GLuint TextureLevel;
2333    GLuint CubeMapFace;  /* 0 .. 5, for cube map textures */
2334    GLuint Zoffset;      /* for 3D textures */
2335 };
2336
2337
2338 /**
2339  * A framebuffer is a collection of renderbuffers (color, depth, stencil, etc).
2340  * In C++ terms, think of this as a base class from which device drivers
2341  * will make derived classes.
2342  */
2343 struct gl_framebuffer
2344 {
2345    _glthread_Mutex Mutex;                  /**< for thread safety */
2346    GLuint Name;      /* if zero, this is a window system framebuffer */
2347    GLint RefCount;
2348    GLboolean DeletePending;
2349
2350    GLvisual Visual;     /**< The framebuffer's visual.
2351                              Immutable if this is a window system buffer.
2352                              Computed from attachments if user-made FBO. */
2353
2354    GLboolean Initialized;
2355
2356    GLuint Width, Height;        /**< size of frame buffer in pixels */
2357
2358    /** \name  Drawing bounds (Intersection of buffer size and scissor box) */
2359    /*@{*/
2360    GLint _Xmin, _Xmax;  /**< inclusive */
2361    GLint _Ymin, _Ymax;  /**< exclusive */
2362    /*@}*/
2363
2364    /** \name  Derived Z buffer stuff */
2365    /*@{*/
2366    GLuint _DepthMax;    /**< Max depth buffer value */
2367    GLfloat _DepthMaxF;  /**< Float max depth buffer value */
2368    GLfloat _MRD;        /**< minimum resolvable difference in Z values */
2369    /*@}*/
2370
2371    GLenum _Status; /* One of the GL_FRAMEBUFFER_(IN)COMPLETE_* tokens */
2372
2373    /* Array of all renderbuffer attachments, indexed by BUFFER_* tokens. */
2374    struct gl_renderbuffer_attachment Attachment[BUFFER_COUNT];
2375
2376    /* In unextended OpenGL these vars are part of the GL_COLOR_BUFFER
2377     * attribute group and GL_PIXEL attribute group, respectively.
2378     */
2379    GLenum ColorDrawBuffer[MAX_DRAW_BUFFERS];
2380    GLenum ColorReadBuffer;
2381
2382    /* These are computed from ColorDrawBuffer and ColorReadBuffer */
2383    GLbitfield _ColorDrawBufferMask[MAX_DRAW_BUFFERS]; /* Mask of BUFFER_BIT_* flags */
2384    GLint _ColorReadBufferIndex; /* -1 = None */
2385
2386    /* These are computed from _ColorDrawBufferMask and _ColorReadBufferIndex */
2387    GLuint _NumColorDrawBuffers[MAX_DRAW_BUFFERS];
2388    struct gl_renderbuffer *_ColorDrawBuffers[MAX_DRAW_BUFFERS][4];
2389    struct gl_renderbuffer *_ColorReadBuffer;
2390
2391    /** The Actual depth/stencil buffers to use.  May be wrappers around the
2392     * depth/stencil buffers attached above. */
2393    struct gl_renderbuffer *_DepthBuffer;
2394    struct gl_renderbuffer *_StencilBuffer;
2395
2396    /** Delete this framebuffer */
2397    void (*Delete)(struct gl_framebuffer *fb);
2398 };
2399
2400
2401 /**
2402  * Limits for vertex and fragment programs.
2403  */
2404 struct gl_program_constants
2405 {
2406    /* logical limits */
2407    GLuint MaxInstructions;
2408    GLuint MaxAluInstructions; /* fragment programs only, for now */
2409    GLuint MaxTexInstructions; /* fragment programs only, for now */
2410    GLuint MaxTexIndirections; /* fragment programs only, for now */
2411    GLuint MaxAttribs;
2412    GLuint MaxTemps;
2413    GLuint MaxAddressRegs; /* vertex program only, for now */
2414    GLuint MaxParameters;
2415    GLuint MaxLocalParams;
2416    GLuint MaxEnvParams;
2417    /* native/hardware limits */
2418    GLuint MaxNativeInstructions;
2419    GLuint MaxNativeAluInstructions; /* fragment programs only, for now */
2420    GLuint MaxNativeTexInstructions; /* fragment programs only, for now */
2421    GLuint MaxNativeTexIndirections; /* fragment programs only, for now */
2422    GLuint MaxNativeAttribs;
2423    GLuint MaxNativeTemps;
2424    GLuint MaxNativeAddressRegs; /* vertex program only, for now */
2425    GLuint MaxNativeParameters;
2426    /* For shaders */
2427    GLuint MaxUniformComponents;
2428 };
2429
2430
2431 /**
2432  * Constants which may be overridden by device driver during context creation
2433  * but are never changed after that.
2434  */
2435 struct gl_constants
2436 {
2437    GLint MaxTextureLevels;              /**< Maximum number of allowed mipmap levels. */
2438    GLint Max3DTextureLevels;            /**< Maximum number of allowed mipmap levels for 3D texture targets. */
2439    GLint MaxCubeTextureLevels;          /**< Maximum number of allowed mipmap levels for GL_ARB_texture_cube_map */
2440    GLint MaxTextureRectSize;            /* GL_NV_texture_rectangle */
2441    GLuint MaxTextureCoordUnits;
2442    GLuint MaxTextureImageUnits;
2443    GLuint MaxTextureUnits;              /* = MIN(CoordUnits, ImageUnits) */
2444    GLfloat MaxTextureMaxAnisotropy;     /* GL_EXT_texture_filter_anisotropic */
2445    GLfloat MaxTextureLodBias;           /* GL_EXT_texture_lod_bias */
2446    GLuint MaxArrayLockSize;
2447    GLint SubPixelBits;
2448    GLfloat MinPointSize, MaxPointSize;          /* aliased */
2449    GLfloat MinPointSizeAA, MaxPointSizeAA;      /* antialiased */
2450    GLfloat PointSizeGranularity;
2451    GLfloat MinLineWidth, MaxLineWidth;          /* aliased */
2452    GLfloat MinLineWidthAA, MaxLineWidthAA;      /* antialiased */
2453    GLfloat LineWidthGranularity;
2454    GLuint MaxColorTableSize;
2455    GLuint MaxConvolutionWidth;
2456    GLuint MaxConvolutionHeight;
2457    GLuint MaxClipPlanes;
2458    GLuint MaxLights;
2459    GLfloat MaxShininess;                        /* GL_NV_light_max_exponent */
2460    GLfloat MaxSpotExponent;                     /* GL_NV_light_max_exponent */
2461    GLuint MaxViewportWidth, MaxViewportHeight;
2462    struct gl_program_constants VertexProgram;    /* GL_ARB_vertex_program */
2463    struct gl_program_constants FragmentProgram;  /* GL_ARB_fragment_program */
2464    /* shared by vertex and fragment program: */
2465    GLuint MaxProgramMatrices;
2466    GLuint MaxProgramMatrixStackDepth;
2467    /* vertex array / buffer object bounds checking */
2468    GLboolean CheckArrayBounds;
2469    /* GL_ARB_draw_buffers */
2470    GLuint MaxDrawBuffers;
2471    /* GL_OES_read_format */
2472    GLenum ColorReadFormat;
2473    GLenum ColorReadType;
2474    /* GL_EXT_framebuffer_object */
2475    GLuint MaxColorAttachments;
2476    GLuint MaxRenderbufferSize;
2477    /* GL_ARB_vertex_shader */
2478    GLuint MaxVertexTextureImageUnits;
2479    GLuint MaxVarying;
2480 };
2481
2482
2483 /**
2484  * Enable flag for each OpenGL extension.  Different device drivers will
2485  * enable different extensions at runtime.
2486  */
2487 struct gl_extensions
2488 {
2489    /**
2490     * \name Flags to quickly test if certain extensions are available.
2491     *
2492     * Not every extension needs to have such a flag, but it's encouraged.
2493     */
2494    /*@{*/
2495    GLboolean dummy;  /* don't remove this! */
2496    GLboolean ARB_depth_texture;
2497    GLboolean ARB_draw_buffers;
2498    GLboolean ARB_fragment_program;
2499    GLboolean ARB_fragment_shader;
2500    GLboolean ARB_half_float_pixel;
2501    GLboolean ARB_imaging;
2502    GLboolean ARB_multisample;
2503    GLboolean ARB_multitexture;
2504    GLboolean ARB_occlusion_query;
2505    GLboolean ARB_point_sprite;
2506    GLboolean ARB_shader_objects;
2507    GLboolean ARB_shading_language_100;
2508    GLboolean ARB_shading_language_120;
2509    GLboolean ARB_shadow;
2510    GLboolean ARB_texture_border_clamp;
2511    GLboolean ARB_texture_compression;
2512    GLboolean ARB_texture_cube_map;
2513    GLboolean ARB_texture_env_combine;
2514    GLboolean ARB_texture_env_crossbar;
2515    GLboolean ARB_texture_env_dot3;
2516    GLboolean ARB_texture_float;
2517    GLboolean ARB_texture_mirrored_repeat;
2518    GLboolean ARB_texture_non_power_of_two;
2519    GLboolean ARB_transpose_matrix;
2520    GLboolean ARB_vertex_buffer_object;
2521    GLboolean ARB_vertex_program;
2522    GLboolean ARB_vertex_shader;
2523    GLboolean ARB_window_pos;
2524    GLboolean EXT_abgr;
2525    GLboolean EXT_bgra;
2526    GLboolean EXT_blend_color;
2527    GLboolean EXT_blend_equation_separate;
2528    GLboolean EXT_blend_func_separate;
2529    GLboolean EXT_blend_logic_op;
2530    GLboolean EXT_blend_minmax;
2531    GLboolean EXT_blend_subtract;
2532    GLboolean EXT_clip_volume_hint;
2533    GLboolean EXT_cull_vertex;
2534    GLboolean EXT_convolution;
2535    GLboolean EXT_compiled_vertex_array;
2536    GLboolean EXT_copy_texture;
2537    GLboolean EXT_depth_bounds_test;
2538    GLboolean EXT_draw_range_elements;
2539    GLboolean EXT_framebuffer_object;
2540    GLboolean EXT_fog_coord;
2541    GLboolean EXT_framebuffer_blit;
2542    GLboolean EXT_gpu_program_parameters;
2543    GLboolean EXT_histogram;
2544    GLboolean EXT_multi_draw_arrays;
2545    GLboolean EXT_paletted_texture;
2546    GLboolean EXT_packed_depth_stencil;
2547    GLboolean EXT_packed_pixels;
2548    GLboolean EXT_pixel_buffer_object;
2549    GLboolean EXT_point_parameters;
2550    GLboolean EXT_polygon_offset;
2551    GLboolean EXT_rescale_normal;
2552    GLboolean EXT_shadow_funcs;
2553    GLboolean EXT_secondary_color;
2554    GLboolean EXT_separate_specular_color;
2555    GLboolean EXT_shared_texture_palette;
2556    GLboolean EXT_stencil_wrap;
2557    GLboolean EXT_stencil_two_side;
2558    GLboolean EXT_subtexture;
2559    GLboolean EXT_texture;
2560    GLboolean EXT_texture_object;
2561    GLboolean EXT_texture3D;
2562    GLboolean EXT_texture_compression_s3tc;
2563    GLboolean EXT_texture_env_add;
2564    GLboolean EXT_texture_env_combine;
2565    GLboolean EXT_texture_env_dot3;
2566    GLboolean EXT_texture_filter_anisotropic;
2567    GLboolean EXT_texture_lod_bias;
2568    GLboolean EXT_texture_mirror_clamp;
2569    GLboolean EXT_texture_sRGB;
2570    GLboolean EXT_timer_query;
2571    GLboolean EXT_vertex_array;
2572    GLboolean EXT_vertex_array_set;
2573    /* vendor extensions */
2574    GLboolean APPLE_client_storage;
2575    GLboolean APPLE_packed_pixels;
2576    GLboolean APPLE_vertex_array_object;
2577    GLboolean ATI_texture_mirror_once;
2578    GLboolean ATI_texture_env_combine3;
2579    GLboolean ATI_fragment_shader;
2580    GLboolean ATI_separate_stencil;
2581    GLboolean IBM_rasterpos_clip;
2582    GLboolean IBM_multimode_draw_arrays;
2583    GLboolean MESA_pack_invert;
2584    GLboolean MESA_packed_depth_stencil;
2585    GLboolean MESA_program_debug;
2586    GLboolean MESA_resize_buffers;
2587    GLboolean MESA_ycbcr_texture;
2588    GLboolean NV_blend_square;
2589    GLboolean NV_fragment_program;
2590    GLboolean NV_light_max_exponent;
2591    GLboolean NV_point_sprite;
2592    GLboolean NV_texgen_reflection;
2593    GLboolean NV_texture_rectangle;
2594    GLboolean NV_vertex_program;
2595    GLboolean NV_vertex_program1_1;
2596    GLboolean OES_read_format;
2597    GLboolean SGI_color_matrix;
2598    GLboolean SGI_color_table;
2599    GLboolean SGI_texture_color_table;
2600    GLboolean SGIS_generate_mipmap;
2601    GLboolean SGIS_texture_edge_clamp;
2602    GLboolean SGIS_texture_lod;
2603    GLboolean SGIX_depth_texture;
2604    GLboolean SGIX_shadow;
2605    GLboolean SGIX_shadow_ambient; /* or GL_ARB_shadow_ambient */
2606    GLboolean TDFX_texture_compression_FXT1;
2607    GLboolean S3_s3tc;
2608    /*@}*/
2609    /* The extension string */
2610    const GLubyte *String;
2611 };
2612
2613
2614 /**
2615  * A stack of matrices (projection, modelview, color, texture, etc).
2616  */
2617 struct gl_matrix_stack
2618 {
2619    GLmatrix *Top;      /**< points into Stack */
2620    GLmatrix *Stack;    /**< array [MaxDepth] of GLmatrix */
2621    GLuint Depth;       /**< 0 <= Depth < MaxDepth */
2622    GLuint MaxDepth;    /**< size of Stack[] array */
2623    GLuint DirtyFlag;   /**< _NEW_MODELVIEW or _NEW_PROJECTION, for example */
2624 };
2625
2626
2627 /**
2628  * \name Bits for image transfer operations
2629  *
2630  * \sa __GLcontextRec::ImageTransferState.
2631  */
2632 /*@{*/
2633 #define IMAGE_SCALE_BIAS_BIT                      0x1
2634 #define IMAGE_SHIFT_OFFSET_BIT                    0x2
2635 #define IMAGE_MAP_COLOR_BIT                       0x4
2636 #define IMAGE_COLOR_TABLE_BIT                     0x8
2637 #define IMAGE_CONVOLUTION_BIT                     0x10
2638 #define IMAGE_POST_CONVOLUTION_SCALE_BIAS         0x20
2639 #define IMAGE_POST_CONVOLUTION_COLOR_TABLE_BIT    0x40
2640 #define IMAGE_COLOR_MATRIX_BIT                    0x80
2641 #define IMAGE_POST_COLOR_MATRIX_COLOR_TABLE_BIT   0x100
2642 #define IMAGE_HISTOGRAM_BIT                       0x200
2643 #define IMAGE_MIN_MAX_BIT                         0x400
2644 #define IMAGE_CLAMP_BIT                           0x800 /* extra */
2645
2646
2647 /** Pixel Transfer ops up to convolution */
2648 #define IMAGE_PRE_CONVOLUTION_BITS (IMAGE_SCALE_BIAS_BIT |     \
2649                                     IMAGE_SHIFT_OFFSET_BIT |   \
2650                                     IMAGE_MAP_COLOR_BIT |      \
2651                                     IMAGE_COLOR_TABLE_BIT)
2652
2653 /** Pixel transfer ops after convolution */
2654 #define IMAGE_POST_CONVOLUTION_BITS (IMAGE_POST_CONVOLUTION_SCALE_BIAS |      \
2655                                      IMAGE_POST_CONVOLUTION_COLOR_TABLE_BIT | \
2656                                      IMAGE_COLOR_MATRIX_BIT |                 \
2657                                      IMAGE_POST_COLOR_MATRIX_COLOR_TABLE_BIT |\
2658                                      IMAGE_HISTOGRAM_BIT |                    \
2659                                      IMAGE_MIN_MAX_BIT)
2660 /*@}*/
2661
2662
2663 /**
2664  * \name Bits to indicate what state has changed.
2665  *
2666  * 4 unused flags.
2667  */
2668 /*@{*/
2669 #define _NEW_MODELVIEW          0x1        /**< __GLcontextRec::ModelView */
2670 #define _NEW_PROJECTION         0x2        /**< __GLcontextRec::Projection */
2671 #define _NEW_TEXTURE_MATRIX     0x4        /**< __GLcontextRec::TextureMatrix */
2672 #define _NEW_COLOR_MATRIX       0x8        /**< __GLcontextRec::ColorMatrix */
2673 #define _NEW_ACCUM              0x10       /**< __GLcontextRec::Accum */
2674 #define _NEW_COLOR              0x20       /**< __GLcontextRec::Color */
2675 #define _NEW_DEPTH              0x40       /**< __GLcontextRec::Depth */
2676 #define _NEW_EVAL               0x80       /**< __GLcontextRec::Eval, __GLcontextRec::EvalMap */
2677 #define _NEW_FOG                0x100      /**< __GLcontextRec::Fog */
2678 #define _NEW_HINT               0x200      /**< __GLcontextRec::Hint */
2679 #define _NEW_LIGHT              0x400      /**< __GLcontextRec::Light */
2680 #define _NEW_LINE               0x800      /**< __GLcontextRec::Line */
2681 #define _NEW_PIXEL              0x1000     /**< __GLcontextRec::Pixel */
2682 #define _NEW_POINT              0x2000     /**< __GLcontextRec::Point */
2683 #define _NEW_POLYGON            0x4000     /**< __GLcontextRec::Polygon */
2684 #define _NEW_POLYGONSTIPPLE     0x8000     /**< __GLcontextRec::PolygonStipple */
2685 #define _NEW_SCISSOR            0x10000    /**< __GLcontextRec::Scissor */
2686 #define _NEW_STENCIL            0x20000    /**< __GLcontextRec::Stencil */
2687 #define _NEW_TEXTURE            0x40000    /**< __GLcontextRec::Texture */
2688 #define _NEW_TRANSFORM          0x80000    /**< __GLcontextRec::Transform */
2689 #define _NEW_VIEWPORT           0x100000   /**< __GLcontextRec::Viewport */
2690 #define _NEW_PACKUNPACK         0x200000   /**< __GLcontextRec::Pack, __GLcontextRec::Unpack */
2691 #define _NEW_ARRAY              0x400000   /**< __GLcontextRec::Array */
2692 #define _NEW_RENDERMODE         0x800000   /**< __GLcontextRec::RenderMode, __GLcontextRec::Feedback, __GLcontextRec::Select */
2693 #define _NEW_BUFFERS            0x1000000  /**< __GLcontextRec::Visual, __GLcontextRec::DrawBuffer, */
2694 #define _NEW_MULTISAMPLE        0x2000000  /**< __GLcontextRec::Multisample */
2695 #define _NEW_TRACK_MATRIX       0x4000000  /**< __GLcontextRec::VertexProgram */
2696 #define _NEW_PROGRAM            0x8000000  /**< __GLcontextRec::VertexProgram */
2697 #define _NEW_ALL ~0
2698 /*@}*/
2699
2700
2701 /**
2702  * \name Bits to track array state changes
2703  *
2704  * Also used to summarize array enabled.
2705  */
2706 /*@{*/
2707 #define _NEW_ARRAY_VERTEX           VERT_BIT_POS
2708 #define _NEW_ARRAY_WEIGHT           VERT_BIT_WEIGHT
2709 #define _NEW_ARRAY_NORMAL           VERT_BIT_NORMAL
2710 #define _NEW_ARRAY_COLOR0           VERT_BIT_COLOR0
2711 #define _NEW_ARRAY_COLOR1           VERT_BIT_COLOR1
2712 #define _NEW_ARRAY_FOGCOORD         VERT_BIT_FOG
2713 #define _NEW_ARRAY_INDEX            VERT_BIT_COLOR_INDEX
2714 #define _NEW_ARRAY_EDGEFLAG         VERT_BIT_EDGEFLAG
2715 #define _NEW_ARRAY_TEXCOORD_0       VERT_BIT_TEX0
2716 #define _NEW_ARRAY_TEXCOORD_1       VERT_BIT_TEX1
2717 #define _NEW_ARRAY_TEXCOORD_2       VERT_BIT_TEX2
2718 #define _NEW_ARRAY_TEXCOORD_3       VERT_BIT_TEX3
2719 #define _NEW_ARRAY_TEXCOORD_4       VERT_BIT_TEX4
2720 #define _NEW_ARRAY_TEXCOORD_5       VERT_BIT_TEX5
2721 #define _NEW_ARRAY_TEXCOORD_6       VERT_BIT_TEX6
2722 #define _NEW_ARRAY_TEXCOORD_7       VERT_BIT_TEX7
2723 #define _NEW_ARRAY_ATTRIB_0         VERT_BIT_GENERIC0  /* start at bit 16 */
2724 #define _NEW_ARRAY_ALL              0xffffffff
2725
2726
2727 #define _NEW_ARRAY_TEXCOORD(i) (_NEW_ARRAY_TEXCOORD_0 << (i))
2728 #define _NEW_ARRAY_ATTRIB(i) (_NEW_ARRAY_ATTRIB_0 << (i))
2729 /*@}*/
2730
2731
2732 /**
2733  * \name A bunch of flags that we think might be useful to drivers.
2734  *
2735  * Set in the __GLcontextRec::_TriangleCaps bitfield.
2736  */
2737 /*@{*/
2738 #define DD_FLATSHADE                0x1
2739 #define DD_SEPARATE_SPECULAR        0x2
2740 #define DD_TRI_CULL_FRONT_BACK      0x4 /* special case on some hw */
2741 #define DD_TRI_LIGHT_TWOSIDE        0x8
2742 #define DD_TRI_UNFILLED             0x10
2743 #define DD_TRI_SMOOTH               0x20
2744 #define DD_TRI_STIPPLE              0x40
2745 #define DD_TRI_OFFSET               0x80
2746 #define DD_LINE_SMOOTH              0x100
2747 #define DD_LINE_STIPPLE             0x200
2748 #define DD_LINE_WIDTH               0x400
2749 #define DD_POINT_SMOOTH             0x800
2750 #define DD_POINT_SIZE               0x1000
2751 #define DD_POINT_ATTEN              0x2000
2752 #define DD_TRI_TWOSTENCIL           0x4000
2753 /*@}*/
2754
2755
2756 /**
2757  * \name Define the state changes under which each of these bits might change
2758  */
2759 /*@{*/
2760 #define _DD_NEW_FLATSHADE                _NEW_LIGHT
2761 #define _DD_NEW_SEPARATE_SPECULAR        (_NEW_LIGHT | _NEW_FOG | _NEW_PROGRAM)
2762 #define _DD_NEW_TRI_CULL_FRONT_BACK      _NEW_POLYGON
2763 #define _DD_NEW_TRI_LIGHT_TWOSIDE        _NEW_LIGHT
2764 #define _DD_NEW_TRI_UNFILLED             _NEW_POLYGON
2765 #define _DD_NEW_TRI_SMOOTH               _NEW_POLYGON
2766 #define _DD_NEW_TRI_STIPPLE              _NEW_POLYGON
2767 #define _DD_NEW_TRI_OFFSET               _NEW_POLYGON
2768 #define _DD_NEW_LINE_SMOOTH              _NEW_LINE
2769 #define _DD_NEW_LINE_STIPPLE             _NEW_LINE
2770 #define _DD_NEW_LINE_WIDTH               _NEW_LINE
2771 #define _DD_NEW_POINT_SMOOTH             _NEW_POINT
2772 #define _DD_NEW_POINT_SIZE               _NEW_POINT
2773 #define _DD_NEW_POINT_ATTEN              _NEW_POINT
2774 /*@}*/
2775
2776
2777 #define _MESA_NEW_NEED_EYE_COORDS         (_NEW_LIGHT |         \
2778                                            _NEW_TEXTURE |       \
2779                                            _NEW_POINT |         \
2780                                            _NEW_PROGRAM |       \
2781                                            _NEW_MODELVIEW)
2782
2783 #define _MESA_NEW_NEED_NORMALS            (_NEW_LIGHT |         \
2784                                            _NEW_TEXTURE)
2785
2786 #define _IMAGE_NEW_TRANSFER_STATE         (_NEW_PIXEL | _NEW_COLOR_MATRIX)
2787
2788
2789
2790
2791 /*
2792  * Forward declaration of display list data types:
2793  */
2794 union node;
2795 typedef union node Node;
2796
2797
2798 /* This has to be included here. */
2799 #include "dd.h"
2800
2801
2802 #define NUM_VERTEX_FORMAT_ENTRIES (sizeof(GLvertexformat) / sizeof(void *))
2803
2804 /**
2805  * Core Mesa's support for tnl modules:
2806  */
2807 struct gl_tnl_module
2808 {
2809    /**
2810     * Vertex format to be lazily swapped into current dispatch.
2811     */
2812    const GLvertexformat *Current;
2813
2814    /**
2815     * \name Record of functions swapped out.
2816     * On restore, only need to swap these functions back in.
2817     */
2818    /*@{*/
2819    struct {
2820        _glapi_proc * location;
2821        _glapi_proc function;
2822    } Swapped[NUM_VERTEX_FORMAT_ENTRIES];
2823    GLuint SwapCount;
2824    /*@}*/
2825 };
2826
2827 /* Strictly this is a tnl/ private concept, but it doesn't seem
2828  * worthwhile adding a tnl private structure just to hold this one bit
2829  * of information:
2830  */
2831 #define MESA_DLIST_DANGLING_REFS     0x1
2832
2833 /* Provide a location where information about a display list can be
2834  * collected.  Could be extended with driverPrivate structures,
2835  * etc. in the future.
2836  */
2837 struct mesa_display_list
2838 {
2839    Node *node;
2840    GLuint id;
2841    GLbitfield flags;
2842 };
2843
2844
2845 /**
2846  * State used during display list compilation and execution.
2847  */
2848 struct gl_dlist_state
2849 {
2850    struct mesa_display_list *CallStack[MAX_LIST_NESTING];
2851    GLuint CallDepth;            /**< Current recursion calling depth */
2852
2853    struct mesa_display_list *CurrentList;
2854    Node *CurrentListPtr;        /**< Head of list being compiled */
2855    GLuint CurrentListNum;       /**< Number of the list being compiled */
2856    Node *CurrentBlock;          /**< Pointer to current block of nodes */
2857    GLuint CurrentPos;           /**< Index into current block of nodes */
2858
2859    GLvertexformat ListVtxfmt;
2860
2861    GLubyte ActiveAttribSize[VERT_ATTRIB_MAX];
2862    GLfloat CurrentAttrib[VERT_ATTRIB_MAX][4];
2863
2864    GLubyte ActiveMaterialSize[MAT_ATTRIB_MAX];
2865    GLfloat CurrentMaterial[MAT_ATTRIB_MAX][4];
2866
2867    GLubyte ActiveIndex;
2868    GLfloat CurrentIndex;
2869
2870    GLubyte ActiveEdgeFlag;
2871    GLboolean CurrentEdgeFlag;
2872 };
2873
2874
2875 /**
2876  * Mesa rendering context.
2877  *
2878  * This is the central context data structure for Mesa.  Almost all
2879  * OpenGL state is contained in this structure.
2880  * Think of this as a base class from which device drivers will derive
2881  * sub classes.
2882  *
2883  * The GLcontext typedef names this structure.
2884  */
2885 struct __GLcontextRec
2886 {
2887    /** State possibly shared with other contexts in the address space */
2888    struct gl_shared_state *Shared;
2889
2890    /** \name API function pointer tables */
2891    /*@{*/
2892    struct _glapi_table *Save;   /**< Display list save functions */
2893    struct _glapi_table *Exec;   /**< Execute functions */
2894    struct _glapi_table *CurrentDispatch;  /**< == Save or Exec !! */
2895    /*@}*/
2896
2897    GLvisual Visual;
2898    GLframebuffer *DrawBuffer;   /**< buffer for writing */
2899    GLframebuffer *ReadBuffer;   /**< buffer for reading */
2900    GLframebuffer *WinSysDrawBuffer;  /**< set with MakeCurrent */
2901    GLframebuffer *WinSysReadBuffer;  /**< set with MakeCurrent */
2902
2903    /**
2904     * Device driver function pointer table
2905     */
2906    struct dd_function_table Driver;
2907
2908    void *DriverCtx;     /**< Points to device driver context/state */
2909
2910    /** Core/Driver constants */
2911    struct gl_constants Const;
2912
2913    /** \name The various 4x4 matrix stacks */
2914    /*@{*/
2915    struct gl_matrix_stack ModelviewMatrixStack;
2916    struct gl_matrix_stack ProjectionMatrixStack;
2917    struct gl_matrix_stack ColorMatrixStack;
2918    struct gl_matrix_stack TextureMatrixStack[MAX_TEXTURE_COORD_UNITS];
2919    struct gl_matrix_stack ProgramMatrixStack[MAX_PROGRAM_MATRICES];
2920    struct gl_matrix_stack *CurrentStack; /**< Points to one of the above stacks */
2921    /*@}*/
2922
2923    /** Combined modelview and projection matrix */
2924    GLmatrix _ModelProjectMatrix;
2925
2926    /** \name Display lists */
2927    struct gl_dlist_state ListState;
2928
2929    GLboolean ExecuteFlag;       /**< Execute GL commands? */
2930    GLboolean CompileFlag;       /**< Compile GL commands into display list? */
2931
2932    /** Extension information */
2933    struct gl_extensions Extensions;
2934
2935    /** \name State attribute stack (for glPush/PopAttrib) */
2936    /*@{*/
2937    GLuint AttribStackDepth;
2938    struct gl_attrib_node *AttribStack[MAX_ATTRIB_STACK_DEPTH];
2939    /*@}*/
2940
2941    /** \name Renderer attribute groups
2942     *
2943     * We define a struct for each attribute group to make pushing and popping
2944     * attributes easy.  Also it's a good organization.
2945     */
2946    /*@{*/
2947    struct gl_accum_attrib       Accum;          /**< Accum buffer attributes */
2948    struct gl_colorbuffer_attrib Color;          /**< Color buffer attributes */
2949    struct gl_current_attrib     Current;        /**< Current attributes */
2950    struct gl_depthbuffer_attrib Depth;          /**< Depth buffer attributes */
2951    struct gl_eval_attrib        Eval;           /**< Eval attributes */
2952    struct gl_fog_attrib         Fog;            /**< Fog attributes */
2953    struct gl_hint_attrib        Hint;           /**< Hint attributes */
2954    struct gl_light_attrib       Light;          /**< Light attributes */
2955    struct gl_line_attrib        Line;           /**< Line attributes */
2956    struct gl_list_attrib        List;           /**< List attributes */
2957    struct gl_multisample_attrib Multisample;
2958    struct gl_pixel_attrib       Pixel;          /**< Pixel attributes */
2959    struct gl_point_attrib       Point;          /**< Point attributes */
2960    struct gl_polygon_attrib     Polygon;        /**< Polygon attributes */
2961    GLuint PolygonStipple[32];                   /**< Polygon stipple */
2962    struct gl_scissor_attrib     Scissor;        /**< Scissor attributes */
2963    struct gl_stencil_attrib     Stencil;        /**< Stencil buffer attributes */
2964    struct gl_texture_attrib     Texture;        /**< Texture attributes */
2965    struct gl_transform_attrib   Transform;      /**< Transformation attributes */
2966    struct gl_viewport_attrib    Viewport;       /**< Viewport attributes */
2967    /*@}*/
2968
2969    /** \name Client attribute stack */
2970    /*@{*/
2971    GLuint ClientAttribStackDepth;
2972    struct gl_attrib_node *ClientAttribStack[MAX_CLIENT_ATTRIB_STACK_DEPTH];
2973    /*@}*/
2974
2975    /** \name Client attribute groups */
2976    /*@{*/
2977    struct gl_array_attrib       Array;  /**< Vertex arrays */
2978    struct gl_pixelstore_attrib  Pack;   /**< Pixel packing */
2979    struct gl_pixelstore_attrib  Unpack; /**< Pixel unpacking */
2980    struct gl_pixelstore_attrib  DefaultPacking; /**< Default params */
2981    /*@}*/
2982
2983    /** \name Other assorted state (not pushed/popped on attribute stack) */
2984    /*@{*/
2985    struct gl_pixelmaps          PixelMaps;
2986    struct gl_histogram_attrib   Histogram;
2987    struct gl_minmax_attrib      MinMax;
2988    struct gl_convolution_attrib Convolution1D;
2989    struct gl_convolution_attrib Convolution2D;
2990    struct gl_convolution_attrib Separable2D;
2991
2992    struct gl_evaluators EvalMap;   /**< All evaluators */
2993    struct gl_feedback   Feedback;  /**< Feedback */
2994    struct gl_selection  Select;    /**< Selection */
2995
2996    struct gl_color_table ColorTable[COLORTABLE_MAX];
2997    struct gl_color_table ProxyColorTable[COLORTABLE_MAX];
2998 #if 0
2999    struct gl_color_table PostConvolutionColorTable;
3000    struct gl_color_table ProxyPostConvolutionColorTable;
3001    struct gl_color_table PostColorMatrixColorTable;
3002    struct gl_color_table ProxyPostColorMatrixColorTable;
3003 #endif
3004
3005    struct gl_program_state Program;        /**< for vertex or fragment progs */
3006    struct gl_vertex_program_state VertexProgram;   /**< GL_ARB/NV_vertex_program */
3007    struct gl_fragment_program_state FragmentProgram;  /**< GL_ARB/NV_vertex_program */
3008    struct gl_ati_fragment_shader_state ATIFragmentShader;  /**< GL_ATI_fragment_shader */
3009
3010    struct gl_query_state Query;  /**< GL_ARB_occlusion_query */
3011
3012    struct gl_shader_state Shader; /**< GLSL shader object state */
3013    /*@}*/
3014
3015 #if FEATURE_EXT_framebuffer_object
3016    struct gl_renderbuffer *CurrentRenderbuffer;
3017 #endif
3018
3019    GLenum ErrorValue;        /**< Last error code */
3020    GLenum RenderMode;        /**< either GL_RENDER, GL_SELECT, GL_FEEDBACK */
3021    GLbitfield NewState;      /**< bitwise-or of _NEW_* flags */
3022
3023    /** \name Derived state */
3024    /*@{*/
3025    GLbitfield _TriangleCaps;      /**< bitwise-or of DD_* flags */
3026    GLbitfield _ImageTransferState;/**< bitwise-or of IMAGE_*_BIT flags */
3027    GLfloat _EyeZDir[3];
3028    GLfloat _ModelViewInvScale;
3029    GLboolean _NeedEyeCoords;
3030    GLboolean _ForceEyeCoords;
3031    GLenum _CurrentProgram;    /* currently executing program */
3032
3033    GLuint TextureStateTimestamp; /* detect changes to shared state */
3034
3035    struct gl_shine_tab *_ShineTable[2]; /**< Active shine tables */
3036    struct gl_shine_tab *_ShineTabList;  /**< MRU list of inactive shine tables */
3037    /**@}*/
3038
3039    struct gl_list_extensions ListExt; /**< driver dlist extensions */
3040
3041
3042    GLuint _Facing; /**< This is a hack for 2-sided stencil test.
3043                     *
3044                     * We don't have a better way to communicate this value from
3045                     * swrast_setup to swrast. */
3046
3047    /** \name For debugging/development only */
3048    /*@{*/
3049    GLboolean FirstTimeCurrent;
3050    /*@}*/
3051
3052    /** Dither disable via MESA_NO_DITHER env var */
3053    GLboolean NoDither;
3054
3055    /** software compression/decompression supported or not */
3056    GLboolean Mesa_DXTn;
3057
3058    /** Core tnl module support */
3059    struct gl_tnl_module TnlModule;
3060
3061    /**
3062     * \name Hooks for module contexts.
3063     *
3064     * These will eventually live in the driver or elsewhere.
3065     */
3066    /*@{*/
3067    void *swrast_context;
3068    void *swsetup_context;
3069    void *swtnl_context;
3070    void *swtnl_im;
3071    void *acache_context;
3072    void *aelt_context;
3073    /*@}*/
3074 };
3075
3076
3077 /** The string names for GL_POINT, GL_LINE_LOOP, etc */
3078 extern const char *_mesa_prim_name[GL_POLYGON+4];
3079
3080
3081 #ifdef DEBUG
3082 extern int MESA_VERBOSE;
3083 extern int MESA_DEBUG_FLAGS;
3084 # define MESA_FUNCTION __FUNCTION__
3085 #else
3086 # define MESA_VERBOSE 0
3087 # define MESA_DEBUG_FLAGS 0
3088 # define MESA_FUNCTION "a function"
3089 # ifndef NDEBUG
3090 #  define NDEBUG
3091 # endif
3092 #endif
3093
3094
3095 enum _verbose
3096 {
3097    VERBOSE_VARRAY               = 0x0001,
3098    VERBOSE_TEXTURE              = 0x0002,
3099    VERBOSE_IMMEDIATE            = 0x0004,
3100    VERBOSE_PIPELINE             = 0x0008,
3101    VERBOSE_DRIVER               = 0x0010,
3102    VERBOSE_STATE                = 0x0020,
3103    VERBOSE_API                  = 0x0040,
3104    VERBOSE_DISPLAY_LIST         = 0x0100,
3105    VERBOSE_LIGHTING             = 0x0200,
3106    VERBOSE_PRIMS                = 0x0400,
3107    VERBOSE_VERTS                = 0x0800,
3108    VERBOSE_DISASSEM             = 0x1000
3109 };
3110
3111
3112 enum _debug
3113 {
3114    DEBUG_ALWAYS_FLUSH           = 0x1
3115 };
3116
3117
3118
3119 #define Elements(x) sizeof(x)/sizeof(*(x))
3120
3121
3122 #endif /* TYPES_H */