src/mesa/main/mtypes.h

   1 /*
   2  * Mesa 3-D graphics library
   3  * Version:  7.3
   4  *
   5  * Copyright (C) 1999-2007  Brian Paul   All Rights Reserved.
   6  * Copyright (C) 1999-2008  VMware, Inc.  All Rights Reserved.
   7  *
   8  * Permission is hereby granted, free of charge, to any person obtaining a
   9  * copy of this software and associated documentation files (the "Software"),
  10  * to deal in the Software without restriction, including without limitation
  11  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
  12  * and/or sell copies of the Software, and to permit persons to whom the
  13  * Software is furnished to do so, subject to the following conditions:
  14  *
  15  * The above copyright notice and this permission notice shall be included
  16  * in all copies or substantial portions of the Software.
  17  *
  18  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
  19  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  20  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  21  * BRIAN PAUL BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
  22  * AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  23  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  24  */
  25
  26 /**
  27  * \file mtypes.h
  28  * Main Mesa data structures.
  29  *
  30  * Please try to mark derived values with a leading underscore ('_').
  31  */
  32
  33 #ifndef TYPES_H
  34 #define TYPES_H
  35
  36
  37 #include "glheader.h"
  38 #include <GL/internal/glcore.h> /* __GLcontextModes (GLvisual) */
  39 #include "config.h"             /* Hardwired parameters */
  40 #include "glapi/glapi.h"
  41 #include "math/m_matrix.h"      /* GLmatrix */
  42 #include "bitset.h"
  43
  44
  45 /**
  46  * Special, internal token
  47  */
  48 #define GL_SHADER_PROGRAM_MESA 0x9999
  49
  50
  51 /**
  52  * Color channel data type.
  53  */
  54 #if CHAN_BITS == 8
  55    typedef GLubyte GLchan;
  56 #define CHAN_MAX 255
  57 #define CHAN_MAXF 255.0F
  58 #define CHAN_TYPE GL_UNSIGNED_BYTE
  59 #elif CHAN_BITS == 16
  60    typedef GLushort GLchan;
  61 #define CHAN_MAX 65535
  62 #define CHAN_MAXF 65535.0F
  63 #define CHAN_TYPE GL_UNSIGNED_SHORT
  64 #elif CHAN_BITS == 32
  65    typedef GLfloat GLchan;
  66 #define CHAN_MAX 1.0
  67 #define CHAN_MAXF 1.0F
  68 #define CHAN_TYPE GL_FLOAT
  69 #else
  70 #error "illegal number of color channel bits"
  71 #endif
  72
  73
  74 /**
  75  * Stencil buffer data type.
  76  */
  77 #if STENCIL_BITS==8
  78    typedef GLubyte GLstencil;
  79 #elif STENCIL_BITS==16
  80    typedef GLushort GLstencil;
  81 #else
  82 #  error "illegal number of stencil bits"
  83 #endif
  84
  85
  86 /**
  87  * Fixed point data type.
  88  */
  89 typedef int GLfixed;
  90 /*
  91  * Fixed point arithmetic macros
  92  */
  93 #ifndef FIXED_FRAC_BITS
  94 #define FIXED_FRAC_BITS 11
  95 #endif
  96
  97 #define FIXED_SHIFT     FIXED_FRAC_BITS
  98 #define FIXED_ONE       (1 << FIXED_SHIFT)
  99 #define FIXED_HALF      (1 << (FIXED_SHIFT-1))
 100 #define FIXED_FRAC_MASK (FIXED_ONE - 1)
 101 #define FIXED_INT_MASK  (~FIXED_FRAC_MASK)
 102 #define FIXED_EPSILON   1
 103 #define FIXED_SCALE     ((float) FIXED_ONE)
 104 #define FIXED_DBL_SCALE ((double) FIXED_ONE)
 105 #define FloatToFixed(X) (IROUND((X) * FIXED_SCALE))
 106 #define FixedToDouble(X) ((X) * (1.0 / FIXED_DBL_SCALE))
 107 #define IntToFixed(I)   ((I) << FIXED_SHIFT)
 108 #define FixedToInt(X)   ((X) >> FIXED_SHIFT)
 109 #define FixedToUns(X)   (((unsigned int)(X)) >> FIXED_SHIFT)
 110 #define FixedCeil(X)    (((X) + FIXED_ONE - FIXED_EPSILON) & FIXED_INT_MASK)
 111 #define FixedFloor(X)   ((X) & FIXED_INT_MASK)
 112 #define FixedToFloat(X) ((X) * (1.0F / FIXED_SCALE))
 113 #define PosFloatToFixed(X)      FloatToFixed(X)
 114 #define SignedFloatToFixed(X)   FloatToFixed(X)
 115
 116
 117
 118 /**
 119  * \name Some forward type declarations
 120  */
 121 /*@{*/
 122 struct _mesa_HashTable;
 123 struct gl_pixelstore_attrib;
 124 struct gl_program_cache;
 125 struct gl_texture_format;
 126 struct gl_texture_image;
 127 struct gl_texture_object;
 128 typedef struct __GLcontextRec GLcontext;
 129 typedef struct __GLcontextModesRec GLvisual;
 130 typedef struct gl_framebuffer GLframebuffer;
 131 /*@}*/
 132
 133
 134
 135 /**
 136  * Indexes for vertex program attributes.
 137  * GL_NV_vertex_program aliases generic attributes over the conventional
 138  * attributes.  In GL_ARB_vertex_program shader the aliasing is optional.
 139  * In GL_ARB_vertex_shader / OpenGL 2.0 the aliasing is disallowed (the
 140  * generic attributes are distinct/separate).
 141  */
 142 enum
 143 {
 144    VERT_ATTRIB_POS = 0,
 145    VERT_ATTRIB_WEIGHT = 1,
 146    VERT_ATTRIB_NORMAL = 2,
 147    VERT_ATTRIB_COLOR0 = 3,
 148    VERT_ATTRIB_COLOR1 = 4,
 149    VERT_ATTRIB_FOG = 5,
 150    VERT_ATTRIB_COLOR_INDEX = 6,
 151    VERT_ATTRIB_POINT_SIZE = 6,  /*alias*/
 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_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_UNITS];
 726    GLuint TexGen[MAX_TEXTURE_UNITS];
 727    /* SGI_texture_color_table */
 728    GLboolean TextureColorTable[MAX_TEXTURE_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 };
 921
 922
 923 /**
 924  * Display list attribute group (GL_LIST_BIT).
 925  */
 926 struct gl_list_attrib
 927 {
 928    GLuint ListBase;
 929 };
 930
 931
 932 /**
 933  * Used by device drivers to hook new commands into display lists.
 934  */
 935 struct gl_list_instruction
 936 {
 937    GLuint Size;
 938    void (*Execute)( GLcontext *ctx, void *data );
 939    void (*Destroy)( GLcontext *ctx, void *data );
 940    void (*Print)( GLcontext *ctx, void *data );
 941 };
 942
 943 #define MAX_DLIST_EXT_OPCODES 16
 944
 945 /**
 946  * Used by device drivers to hook new commands into display lists.
 947  */
 948 struct gl_list_extensions
 949 {
 950    struct gl_list_instruction Opcode[MAX_DLIST_EXT_OPCODES];
 951    GLuint NumOpcodes;
 952 };
 953
 954
 955 /**
 956  * Multisample attribute group (GL_MULTISAMPLE_BIT).
 957  */
 958 struct gl_multisample_attrib
 959 {
 960    GLboolean Enabled;
 961    GLboolean _Enabled;   /**< true if Enabled and multisample buffer */
 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 Params[3];           /**< GL_EXT_point_parameters */
1067    GLfloat MinSize, MaxSize;    /**< GL_EXT_point_parameters */
1068    GLfloat Threshold;           /**< GL_EXT_point_parameters */
1069    GLboolean _Attenuated;       /**< True if Params != [1, 0, 0] */
1070    GLboolean PointSprite;       /**< GL_NV/ARB_point_sprite */
1071    GLboolean CoordReplace[MAX_TEXTURE_UNITS]; /**< GL_ARB_point_sprite */
1072    GLenum SpriteRMode;          /**< GL_NV_point_sprite (only!) */
1073    GLenum SpriteOrigin;         /**< GL_ARB_point_sprite */
1074 };
1075
1076
1077 /**
1078  * Polygon attribute group (GL_POLYGON_BIT).
1079  */
1080 struct gl_polygon_attrib
1081 {
1082    GLenum FrontFace;            /**< Either GL_CW or GL_CCW */
1083    GLenum FrontMode;            /**< Either GL_POINT, GL_LINE or GL_FILL */
1084    GLenum BackMode;             /**< Either GL_POINT, GL_LINE or GL_FILL */
1085    GLboolean _FrontBit;         /**< 0=GL_CCW, 1=GL_CW */
1086    GLboolean CullFlag;          /**< Culling on/off flag */
1087    GLboolean SmoothFlag;        /**< True if GL_POLYGON_SMOOTH is enabled */
1088    GLboolean StippleFlag;       /**< True if GL_POLYGON_STIPPLE is enabled */
1089    GLenum CullFaceMode;         /**< Culling mode GL_FRONT or GL_BACK */
1090    GLfloat OffsetFactor;        /**< Polygon offset factor, from user */
1091    GLfloat OffsetUnits;         /**< Polygon offset units, from user */
1092    GLboolean OffsetPoint;       /**< Offset in GL_POINT mode */
1093    GLboolean OffsetLine;        /**< Offset in GL_LINE mode */
1094    GLboolean OffsetFill;        /**< Offset in GL_FILL mode */
1095 };
1096
1097
1098 /**
1099  * Scissor attributes (GL_SCISSOR_BIT).
1100  */
1101 struct gl_scissor_attrib
1102 {
1103    GLboolean Enabled;           /**< Scissor test enabled? */
1104    GLint X, Y;                  /**< Lower left corner of box */
1105    GLsizei Width, Height;       /**< Size of box */
1106 };
1107
1108
1109 /**
1110  * Stencil attribute group (GL_STENCIL_BUFFER_BIT).
1111  */
1112 struct gl_stencil_attrib
1113 {
1114    GLboolean Enabled;           /**< Enabled flag */
1115    GLboolean TestTwoSide;       /**< GL_EXT_stencil_two_side */
1116    GLubyte ActiveFace;          /**< GL_EXT_stencil_two_side (0 or 1) */
1117    GLboolean _TestTwoSide;
1118    GLenum Function[2];          /**< Stencil function */
1119    GLenum FailFunc[2];          /**< Fail function */
1120    GLenum ZPassFunc[2];         /**< Depth buffer pass function */
1121    GLenum ZFailFunc[2];         /**< Depth buffer fail function */
1122    GLint Ref[2];                /**< Reference value */
1123    GLuint ValueMask[2];         /**< Value mask */
1124    GLuint WriteMask[2];         /**< Write mask */
1125    GLuint Clear;                /**< Clear value */
1126 };
1127
1128
1129 #define NUM_TEXTURE_TARGETS 7   /* 1D, 2D, 3D, CUBE, RECT, 1D_STACK, and 2D_STACK */
1130
1131 /**
1132  * An index for each type of texture object
1133  */
1134 /*@{*/
1135 #define TEXTURE_1D_INDEX       0
1136 #define TEXTURE_2D_INDEX       1
1137 #define TEXTURE_3D_INDEX       2
1138 #define TEXTURE_CUBE_INDEX     3
1139 #define TEXTURE_RECT_INDEX     4
1140 #define TEXTURE_1D_ARRAY_INDEX 5
1141 #define TEXTURE_2D_ARRAY_INDEX 6
1142 /*@}*/
1143
1144 /**
1145  * Bit flags for each type of texture object
1146  * Used for Texture.Unit[]._ReallyEnabled flags.
1147  */
1148 /*@{*/
1149 #define TEXTURE_1D_BIT       (1 << TEXTURE_1D_INDEX)
1150 #define TEXTURE_2D_BIT       (1 << TEXTURE_2D_INDEX)
1151 #define TEXTURE_3D_BIT       (1 << TEXTURE_3D_INDEX)
1152 #define TEXTURE_CUBE_BIT     (1 << TEXTURE_CUBE_INDEX)
1153 #define TEXTURE_RECT_BIT     (1 << TEXTURE_RECT_INDEX)
1154 #define TEXTURE_1D_ARRAY_BIT (1 << TEXTURE_1D_ARRAY_INDEX)
1155 #define TEXTURE_2D_ARRAY_BIT (1 << TEXTURE_2D_ARRAY_INDEX)
1156 /*@}*/
1157
1158
1159 /**
1160  * TexGenEnabled flags.
1161  */
1162 /*@{*/
1163 #define S_BIT 1
1164 #define T_BIT 2
1165 #define R_BIT 4
1166 #define Q_BIT 8
1167 /*@}*/
1168
1169
1170 /**
1171  * Bit flag versions of the corresponding GL_ constants.
1172  */
1173 /*@{*/
1174 #define TEXGEN_SPHERE_MAP        0x1
1175 #define TEXGEN_OBJ_LINEAR        0x2
1176 #define TEXGEN_EYE_LINEAR        0x4
1177 #define TEXGEN_REFLECTION_MAP_NV 0x8
1178 #define TEXGEN_NORMAL_MAP_NV     0x10
1179
1180 #define TEXGEN_NEED_NORMALS      (TEXGEN_SPHERE_MAP        | \
1181                                   TEXGEN_REFLECTION_MAP_NV | \
1182                                   TEXGEN_NORMAL_MAP_NV)
1183 #define TEXGEN_NEED_EYE_COORD    (TEXGEN_SPHERE_MAP        | \
1184                                   TEXGEN_REFLECTION_MAP_NV | \
1185                                   TEXGEN_NORMAL_MAP_NV     | \
1186                                   TEXGEN_EYE_LINEAR)
1187 /*@}*/
1188
1189
1190 /* A selection of state flags to make driver and module's lives easier. */
1191 #define ENABLE_TEXGEN0        0x1
1192 #define ENABLE_TEXGEN1        0x2
1193 #define ENABLE_TEXGEN2        0x4
1194 #define ENABLE_TEXGEN3        0x8
1195 #define ENABLE_TEXGEN4        0x10
1196 #define ENABLE_TEXGEN5        0x20
1197 #define ENABLE_TEXGEN6        0x40
1198 #define ENABLE_TEXGEN7        0x80
1199
1200 #define ENABLE_TEXMAT0        0x1       /* Ie. not the identity matrix */
1201 #define ENABLE_TEXMAT1        0x2
1202 #define ENABLE_TEXMAT2        0x4
1203 #define ENABLE_TEXMAT3        0x8
1204 #define ENABLE_TEXMAT4        0x10
1205 #define ENABLE_TEXMAT5        0x20
1206 #define ENABLE_TEXMAT6        0x40
1207 #define ENABLE_TEXMAT7        0x80
1208
1209 #define ENABLE_TEXGEN(i) (ENABLE_TEXGEN0 << (i))
1210 #define ENABLE_TEXMAT(i) (ENABLE_TEXMAT0 << (i))
1211
1212
1213 /**
1214  * Texel fetch function prototype.  We use texel fetch functions to
1215  * extract RGBA, color indexes and depth components out of 1D, 2D and 3D
1216  * texture images.  These functions help to isolate us from the gritty
1217  * details of all the various texture image encodings.
1218  *
1219  * \param texImage texture image.
1220  * \param col texel column.
1221  * \param row texel row.
1222  * \param img texel image level/layer.
1223  * \param texelOut output texel (up to 4 GLchans)
1224  */
1225 typedef void (*FetchTexelFuncC)( const struct gl_texture_image *texImage,
1226                                  GLint col, GLint row, GLint img,
1227                                  GLchan *texelOut );
1228
1229 /**
1230  * As above, but returns floats.
1231  * Used for depth component images and for upcoming signed/float
1232  * texture images.
1233  */
1234 typedef void (*FetchTexelFuncF)( const struct gl_texture_image *texImage,
1235                                  GLint col, GLint row, GLint img,
1236                                  GLfloat *texelOut );
1237
1238
1239 typedef void (*StoreTexelFunc)(struct gl_texture_image *texImage,
1240                                GLint col, GLint row, GLint img,
1241                                const void *texel);
1242
1243
1244 /**
1245  * This macro defines the (many) parameters to the texstore functions.
1246  * \param dims  either 1 or 2 or 3
1247  * \param baseInternalFormat  user-specified base internal format
1248  * \param dstFormat  destination Mesa texture format
1249  * \param dstAddr  destination image address
1250  * \param dstX/Y/Zoffset  destination x/y/z offset (ala TexSubImage), in texels
1251  * \param dstRowStride  destination image row stride, in bytes
1252  * \param dstImageOffsets  offset of each 2D slice within 3D texture, in texels
1253  * \param srcWidth/Height/Depth  source image size, in pixels
1254  * \param srcFormat  incoming image format
1255  * \param srcType  incoming image data type
1256  * \param srcAddr  source image address
1257  * \param srcPacking  source image packing parameters
1258  */
1259 #define TEXSTORE_PARAMS \
1260         GLcontext *ctx, GLuint dims, \
1261         GLenum baseInternalFormat, \
1262         const struct gl_texture_format *dstFormat, \
1263         GLvoid *dstAddr, \
1264         GLint dstXoffset, GLint dstYoffset, GLint dstZoffset, \
1265         GLint dstRowStride, const GLuint *dstImageOffsets, \
1266         GLint srcWidth, GLint srcHeight, GLint srcDepth, \
1267         GLenum srcFormat, GLenum srcType, \
1268         const GLvoid *srcAddr, \
1269         const struct gl_pixelstore_attrib *srcPacking
1270
1271
1272
1273 /**
1274  * Texture image storage function.
1275  */
1276 typedef GLboolean (*StoreTexImageFunc)(TEXSTORE_PARAMS);
1277
1278
1279 /**
1280  * Texture format record
1281  */
1282 struct gl_texture_format
1283 {
1284    GLint MesaFormat;            /**< One of the MESA_FORMAT_* values */
1285
1286    GLenum BaseFormat;           /**< Either GL_RGB, GL_RGBA, GL_ALPHA,
1287                                  *   GL_LUMINANCE, GL_LUMINANCE_ALPHA,
1288                                  *   GL_INTENSITY, GL_COLOR_INDEX or
1289                                  *   GL_DEPTH_COMPONENT.
1290                                  */
1291    GLenum DataType;             /**< GL_FLOAT or GL_UNSIGNED_NORMALIZED_ARB */
1292
1293    /**
1294     * Bits per texel component.  These are just rough approximations
1295     * for compressed texture formats.
1296     */
1297    /*@{*/
1298    GLubyte RedBits;
1299    GLubyte GreenBits;
1300    GLubyte BlueBits;
1301    GLubyte AlphaBits;
1302    GLubyte LuminanceBits;
1303    GLubyte IntensityBits;
1304    GLubyte IndexBits;
1305    GLubyte DepthBits;
1306    GLubyte StencilBits;         /**< GL_EXT_packed_depth_stencil */
1307    /*@}*/
1308
1309    GLuint TexelBytes;           /**< Bytes per texel, 0 if compressed format */
1310
1311    StoreTexImageFunc StoreImage;
1312
1313    /**
1314     * \name Texel fetch function pointers
1315     */
1316    /*@{*/
1317    FetchTexelFuncC FetchTexel1D;
1318    FetchTexelFuncC FetchTexel2D;
1319    FetchTexelFuncC FetchTexel3D;
1320    FetchTexelFuncF FetchTexel1Df;
1321    FetchTexelFuncF FetchTexel2Df;
1322    FetchTexelFuncF FetchTexel3Df;
1323    /*@}*/
1324
1325    StoreTexelFunc StoreTexel;
1326 };
1327
1328
1329 /**
1330  * Texture image state.  Describes the dimensions of a texture image,
1331  * the texel format and pointers to Texel Fetch functions.
1332  */
1333 struct gl_texture_image
1334 {
1335    GLenum _BaseFormat;          /**< Either GL_RGB, GL_RGBA, GL_ALPHA,
1336                                  *   GL_LUMINANCE, GL_LUMINANCE_ALPHA,
1337                                  *   GL_INTENSITY, GL_COLOR_INDEX,
1338                                  *   GL_DEPTH_COMPONENT or GL_DEPTH_STENCIL_EXT
1339                                  *   only. Used for choosing TexEnv arithmetic.
1340                                  */
1341    GLint InternalFormat;        /**< Internal format as given by the user */
1342    GLuint Border;               /**< 0 or 1 */
1343    GLuint Width;                /**< = 2^WidthLog2 + 2*Border */
1344    GLuint Height;               /**< = 2^HeightLog2 + 2*Border */
1345    GLuint Depth;                /**< = 2^DepthLog2 + 2*Border */
1346    GLuint Width2;               /**< = Width - 2*Border */
1347    GLuint Height2;              /**< = Height - 2*Border */
1348    GLuint Depth2;               /**< = Depth - 2*Border */
1349    GLuint WidthLog2;            /**< = log2(Width2) */
1350    GLuint HeightLog2;           /**< = log2(Height2) */
1351    GLuint DepthLog2;            /**< = log2(Depth2) */
1352    GLuint MaxLog2;              /**< = MAX(WidthLog2, HeightLog2) */
1353    GLfloat WidthScale;          /**< used for mipmap LOD computation */
1354    GLfloat HeightScale;         /**< used for mipmap LOD computation */
1355    GLfloat DepthScale;          /**< used for mipmap LOD computation */
1356    GLboolean IsClientData;      /**< Data owned by client? */
1357    GLboolean _IsPowerOfTwo;     /**< Are all dimensions powers of two? */
1358
1359    const struct gl_texture_format *TexFormat;
1360
1361    struct gl_texture_object *TexObject;  /**< Pointer back to parent object */
1362
1363    FetchTexelFuncC FetchTexelc; /**< GLchan texel fetch function pointer */
1364    FetchTexelFuncF FetchTexelf; /**< Float texel fetch function pointer */
1365
1366    GLboolean IsCompressed;      /**< GL_ARB_texture_compression */
1367    GLuint CompressedSize;       /**< GL_ARB_texture_compression */
1368
1369    GLuint RowStride;            /**< Padded width in units of texels */
1370    GLuint *ImageOffsets;        /**< if 3D texture: array [Depth] of offsets to
1371                                      each 2D slice in 'Data', in texels */
1372    GLvoid *Data;                /**< Image data, accessed via FetchTexel() */
1373
1374    /**
1375     * \name For device driver:
1376     */
1377    /*@{*/
1378    void *DriverData;            /**< Arbitrary device driver data */
1379    /*@}*/
1380 };
1381
1382
1383 /**
1384  * Indexes for cube map faces.
1385  */
1386 /*@{*/
1387 #define FACE_POS_X   0
1388 #define FACE_NEG_X   1
1389 #define FACE_POS_Y   2
1390 #define FACE_NEG_Y   3
1391 #define FACE_POS_Z   4
1392 #define FACE_NEG_Z   5
1393 #define MAX_FACES    6
1394 /*@}*/
1395
1396
1397 /**
1398  * Texture object state.  Contains the array of mipmap images, border color,
1399  * wrap modes, filter modes, shadow/texcompare state, and the per-texture
1400  * color palette.
1401  */
1402 struct gl_texture_object
1403 {
1404    _glthread_Mutex Mutex;       /**< for thread safety */
1405    GLint RefCount;              /**< reference count */
1406    GLuint Name;                 /**< the user-visible texture object ID */
1407    GLenum Target;               /**< GL_TEXTURE_1D, GL_TEXTURE_2D, etc. */
1408    GLfloat Priority;            /**< in [0,1] */
1409    GLfloat BorderColor[4];      /**< unclamped */
1410    GLchan _BorderChan[4];       /**< clamped, as GLchan */
1411    GLenum WrapS;                /**< S-axis texture image wrap mode */
1412    GLenum WrapT;                /**< T-axis texture image wrap mode */
1413    GLenum WrapR;                /**< R-axis texture image wrap mode */
1414    GLenum MinFilter;            /**< minification filter */
1415    GLenum MagFilter;            /**< magnification filter */
1416    GLfloat MinLod;              /**< min lambda, OpenGL 1.2 */
1417    GLfloat MaxLod;              /**< max lambda, OpenGL 1.2 */
1418    GLfloat LodBias;             /**< OpenGL 1.4 */
1419    GLint BaseLevel;             /**< min mipmap level, OpenGL 1.2 */
1420    GLint MaxLevel;              /**< max mipmap level, OpenGL 1.2 */
1421    GLfloat MaxAnisotropy;       /**< GL_EXT_texture_filter_anisotropic */
1422    GLboolean CompareFlag;       /**< GL_SGIX_shadow */
1423    GLenum CompareOperator;      /**< GL_SGIX_shadow */
1424    GLfloat ShadowAmbient;       /**< GL_ARB_shadow_ambient */
1425    GLenum CompareMode;          /**< GL_ARB_shadow */
1426    GLenum CompareFunc;          /**< GL_ARB_shadow */
1427    GLenum _Function;            /**< Comparison function derived from
1428                                  * \c CompareOperator, \c CompareMode, and
1429                                  * \c CompareFunc.
1430                                  */
1431    GLenum DepthMode;            /**< GL_ARB_depth_texture */
1432    GLint _MaxLevel;             /**< actual max mipmap level (q in the spec) */
1433    GLfloat _MaxLambda;          /**< = _MaxLevel - BaseLevel (q - b in spec) */
1434    GLint CropRect[4];           /**< GL_OES_draw_texture */
1435    GLboolean GenerateMipmap;    /**< GL_SGIS_generate_mipmap */
1436    GLboolean _Complete;         /**< Is texture object complete? */
1437
1438    /** Actual texture images, indexed by [cube face] and [mipmap level] */
1439    struct gl_texture_image *Image[MAX_FACES][MAX_TEXTURE_LEVELS];
1440
1441    /** GL_EXT_paletted_texture */
1442    struct gl_color_table Palette;
1443
1444    /**
1445     * \name For device driver.
1446     * Note: instead of attaching driver data to this pointer, it's preferable
1447     * to instead use this struct as a base class for your own texture object
1448     * class.  Driver->NewTextureObject() can be used to implement the
1449     * allocation.
1450     */
1451    void *DriverData;    /**< Arbitrary device driver data */
1452 };
1453
1454
1455 /**
1456  * Texture combine environment state.
1457  *
1458  * \todo
1459  * If GL_NV_texture_env_combine4 is ever supported, the arrays in this
1460  * structure will need to be expanded for 4 elements.
1461  */
1462 struct gl_tex_env_combine_state
1463 {
1464    GLenum ModeRGB;       /**< GL_REPLACE, GL_DECAL, GL_ADD, etc. */
1465    GLenum ModeA;         /**< GL_REPLACE, GL_DECAL, GL_ADD, etc. */
1466    GLenum SourceRGB[3];  /**< GL_PRIMARY_COLOR, GL_TEXTURE, etc. */
1467    GLenum SourceA[3];    /**< GL_PRIMARY_COLOR, GL_TEXTURE, etc. */
1468    GLenum OperandRGB[3]; /**< SRC_COLOR, ONE_MINUS_SRC_COLOR, etc */
1469    GLenum OperandA[3];   /**< SRC_ALPHA, ONE_MINUS_SRC_ALPHA, etc */
1470    GLuint ScaleShiftRGB; /**< 0, 1 or 2 */
1471    GLuint ScaleShiftA;   /**< 0, 1 or 2 */
1472    GLuint _NumArgsRGB;   /**< Number of inputs used for the combine mode. */
1473    GLuint _NumArgsA;     /**< Number of inputs used for the combine mode. */
1474 };
1475
1476
1477 /**
1478  * Texture unit state.  Contains enable flags, texture environment/function/
1479  * combiners, texgen state, pointers to current texture objects and
1480  * post-filter color tables.
1481  */
1482 struct gl_texture_unit
1483 {
1484    GLbitfield Enabled;          /**< bitmask of TEXTURE_*_BIT flags */
1485    GLbitfield _ReallyEnabled;   /**< 0 or exactly one of TEXTURE_*_BIT flags */
1486
1487    GLenum EnvMode;              /**< GL_MODULATE, GL_DECAL, GL_BLEND, etc. */
1488    GLfloat EnvColor[4];
1489    GLbitfield TexGenEnabled;    /**< Bitwise-OR of [STRQ]_BIT values */
1490    /** \name Tex coord generation mode
1491     * Either GL_OBJECT_LINEAR, GL_EYE_LINEAR or GL_SPHERE_MAP. */
1492    /*@{*/
1493    GLenum GenModeS;
1494    GLenum GenModeT;
1495    GLenum GenModeR;
1496    GLenum GenModeQ;
1497    /*@}*/
1498    GLbitfield _GenBitS;
1499    GLbitfield _GenBitT;
1500    GLbitfield _GenBitR;
1501    GLbitfield _GenBitQ;
1502    GLbitfield _GenFlags;        /**< bitwise or of _GenBit[STRQ] */
1503    GLfloat ObjectPlaneS[4];
1504    GLfloat ObjectPlaneT[4];
1505    GLfloat ObjectPlaneR[4];
1506    GLfloat ObjectPlaneQ[4];
1507    GLfloat EyePlaneS[4];
1508    GLfloat EyePlaneT[4];
1509    GLfloat EyePlaneR[4];
1510    GLfloat EyePlaneQ[4];
1511    GLfloat LodBias;             /**< for biasing mipmap levels */
1512
1513    /**
1514     * \name GL_EXT_texture_env_combine
1515     */
1516    struct gl_tex_env_combine_state Combine;
1517
1518    /**
1519     * Derived state based on \c EnvMode and the \c BaseFormat of the
1520     * currently enabled texture.
1521     */
1522    struct gl_tex_env_combine_state _EnvMode;
1523
1524    /**
1525     * Currently enabled combiner state.  This will point to either
1526     * \c Combine or \c _EnvMode.
1527     */
1528    struct gl_tex_env_combine_state *_CurrentCombine;
1529
1530    struct gl_texture_object *Current1D;
1531    struct gl_texture_object *Current2D;
1532    struct gl_texture_object *Current3D;
1533    struct gl_texture_object *CurrentCubeMap; /**< GL_ARB_texture_cube_map */
1534    struct gl_texture_object *CurrentRect;    /**< GL_NV_texture_rectangle */
1535    struct gl_texture_object *Current1DArray; /**< GL_MESA_texture_array */
1536    struct gl_texture_object *Current2DArray; /**< GL_MESA_texture_array */
1537
1538    struct gl_texture_object *_Current; /**< Points to really enabled tex obj */
1539
1540    /** GL_SGI_texture_color_table */
1541    /*@{*/
1542    struct gl_color_table ColorTable;
1543    struct gl_color_table ProxyColorTable;
1544    GLboolean ColorTableEnabled;
1545    /*@}*/
1546 };
1547
1548
1549
1550 /**
1551  * Texture attribute group (GL_TEXTURE_BIT).
1552  */
1553 struct gl_texture_attrib
1554 {
1555    /**
1556     * name multitexture
1557     */
1558    /**@{*/
1559    GLuint CurrentUnit;   /**< Active texture unit [0, MaxTextureImageUnits-1] */
1560    GLbitfield _EnabledUnits;  /**< one bit set for each really-enabled unit */
1561    GLbitfield _EnabledCoordUnits;   /**< one bit per enabled coordinate unit */
1562    GLbitfield _GenFlags;            /**< for texgen */
1563    GLbitfield _TexGenEnabled;
1564    GLbitfield _TexMatEnabled;
1565    /**@}*/
1566
1567    struct gl_texture_unit Unit[MAX_TEXTURE_UNITS];
1568
1569    /** Proxy texture objects */
1570    struct gl_texture_object *ProxyTex[NUM_TEXTURE_TARGETS];
1571
1572    /** GL_EXT_shared_texture_palette */
1573    GLboolean SharedPalette;
1574    struct gl_color_table Palette;
1575 };
1576
1577
1578 /**
1579  * Transformation attribute group (GL_TRANSFORM_BIT).
1580  */
1581 struct gl_transform_attrib
1582 {
1583    GLenum MatrixMode;                           /**< Matrix mode */
1584    GLfloat EyeUserPlane[MAX_CLIP_PLANES][4];    /**< User clip planes */
1585    GLfloat _ClipUserPlane[MAX_CLIP_PLANES][4];  /**< derived */
1586    GLbitfield ClipPlanesEnabled;                /**< on/off bitmask */
1587    GLboolean Normalize;                         /**< Normalize all normals? */
1588    GLboolean RescaleNormals;                    /**< GL_EXT_rescale_normal */
1589    GLboolean RasterPositionUnclipped;           /**< GL_IBM_rasterpos_clip */
1590
1591    GLboolean CullVertexFlag;    /**< True if GL_CULL_VERTEX_EXT is enabled */
1592    GLfloat CullEyePos[4];
1593    GLfloat CullObjPos[4];
1594 };
1595
1596
1597 /**
1598  * Viewport attribute group (GL_VIEWPORT_BIT).
1599  */
1600 struct gl_viewport_attrib
1601 {
1602    GLint X, Y;                  /**< position */
1603    GLsizei Width, Height;       /**< size */
1604    GLfloat Near, Far;           /**< Depth buffer range */
1605    GLmatrix _WindowMap;         /**< Mapping transformation as a matrix. */
1606 };
1607
1608
1609 /**
1610  * Node for the attribute stack.
1611  */
1612 struct gl_attrib_node
1613 {
1614    GLbitfield kind;
1615    void *data;
1616    struct gl_attrib_node *next;
1617 };
1618
1619
1620 /**
1621  * GL_ARB_vertex/pixel_buffer_object buffer object
1622  */
1623 struct gl_buffer_object
1624 {
1625    GLint RefCount;
1626    GLuint Name;
1627    GLenum Usage;
1628    GLenum Access;
1629    GLvoid *Pointer;          /**< Only valid while buffer is mapped */
1630    GLsizeiptrARB Size;       /**< Size of storage in bytes */
1631    GLubyte *Data;            /**< Location of storage either in RAM or VRAM. */
1632    GLboolean OnCard;         /**< Is buffer in VRAM? (hardware drivers) */
1633 };
1634
1635
1636
1637 /**
1638  * Client pixel packing/unpacking attributes
1639  */
1640 struct gl_pixelstore_attrib
1641 {
1642    GLint Alignment;
1643    GLint RowLength;
1644    GLint SkipPixels;
1645    GLint SkipRows;
1646    GLint ImageHeight;     /**< for GL_EXT_texture3D */
1647    GLint SkipImages;      /**< for GL_EXT_texture3D */
1648    GLboolean SwapBytes;
1649    GLboolean LsbFirst;
1650    GLboolean ClientStorage; /**< GL_APPLE_client_storage */
1651    GLboolean Invert;        /**< GL_MESA_pack_invert */
1652    struct gl_buffer_object *BufferObj; /**< GL_ARB_pixel_buffer_object */
1653 };
1654
1655
1656
1657 /**
1658  * Client vertex array attributes
1659  */
1660 struct gl_client_array
1661 {
1662    GLint Size;                  /**< components per element (1,2,3,4) */
1663    GLenum Type;                 /**< datatype: GL_FLOAT, GL_INT, etc */
1664    GLsizei Stride;              /**< user-specified stride */
1665    GLsizei StrideB;             /**< actual stride in bytes */
1666    const GLubyte *Ptr;          /**< Points to array data */
1667    GLboolean Enabled;           /**< Enabled flag is a boolean */
1668    GLboolean Normalized;        /**< GL_ARB_vertex_program */
1669
1670    /**< GL_ARB_vertex_buffer_object */
1671    struct gl_buffer_object *BufferObj;
1672    GLuint _MaxElement;
1673 };
1674
1675
1676 /**
1677  * Collection of vertex arrays.  Defined by the GL_APPLE_vertex_array_object
1678  * extension, but a nice encapsulation in any case.
1679  */
1680 struct gl_array_object
1681 {
1682    /** Name of the array object as received from glGenVertexArrayAPPLE. */
1683    GLuint Name;
1684
1685    /** Conventional vertex arrays */
1686    /*@{*/
1687    struct gl_client_array Vertex;
1688    struct gl_client_array Normal;
1689    struct gl_client_array Color;
1690    struct gl_client_array SecondaryColor;
1691    struct gl_client_array FogCoord;
1692    struct gl_client_array Index;
1693    struct gl_client_array EdgeFlag;
1694    struct gl_client_array TexCoord[MAX_TEXTURE_COORD_UNITS];
1695    struct gl_client_array PointSize;
1696    /*@}*/
1697
1698    /** Generic arrays for vertex programs/shaders */
1699    struct gl_client_array VertexAttrib[VERT_ATTRIB_MAX];
1700
1701    /** Mask of _NEW_ARRAY_* values indicating which arrays are enabled */
1702    GLbitfield _Enabled;
1703 };
1704
1705
1706 /**
1707  * Vertex array state
1708  */
1709 struct gl_array_attrib
1710 {
1711    struct gl_array_object *ArrayObj;
1712    struct gl_array_object *DefaultArrayObj;
1713
1714    GLint ActiveTexture;         /**< Client Active Texture */
1715    GLuint LockFirst;            /**< GL_EXT_compiled_vertex_array */
1716    GLuint LockCount;            /**< GL_EXT_compiled_vertex_array */
1717
1718    GLbitfield NewState;         /**< mask of _NEW_ARRAY_* values */
1719
1720 #if FEATURE_ARB_vertex_buffer_object
1721    struct gl_buffer_object *NullBufferObj;
1722    struct gl_buffer_object *ArrayBufferObj;
1723    struct gl_buffer_object *ElementArrayBufferObj;
1724 #endif
1725    GLuint _MaxElement;          /* Min of all enabled array's maxes */
1726 };
1727
1728
1729 /**
1730  * Feedback buffer state
1731  */
1732 struct gl_feedback
1733 {
1734    GLenum Type;
1735    GLbitfield _Mask;            /* FB_* bits */
1736    GLfloat *Buffer;
1737    GLuint BufferSize;
1738    GLuint Count;
1739 };
1740
1741
1742 /**
1743  * Selection buffer state
1744  */
1745 struct gl_selection
1746 {
1747    GLuint *Buffer;      /**< selection buffer */
1748    GLuint BufferSize;   /**< size of the selection buffer */
1749    GLuint BufferCount;  /**< number of values in the selection buffer */
1750    GLuint Hits;         /**< number of records in the selection buffer */
1751    GLuint NameStackDepth; /**< name stack depth */
1752    GLuint NameStack[MAX_NAME_STACK_DEPTH]; /**< name stack */
1753    GLboolean HitFlag;   /**< hit flag */
1754    GLfloat HitMinZ;     /**< minimum hit depth */
1755    GLfloat HitMaxZ;     /**< maximum hit depth */
1756 };
1757
1758
1759 /**
1760  * 1-D Evaluator control points
1761  */
1762 struct gl_1d_map
1763 {
1764    GLuint Order;        /**< Number of control points */
1765    GLfloat u1, u2, du;  /**< u1, u2, 1.0/(u2-u1) */
1766    GLfloat *Points;     /**< Points to contiguous control points */
1767 };
1768
1769
1770 /**
1771  * 2-D Evaluator control points
1772  */
1773 struct gl_2d_map
1774 {
1775    GLuint Uorder;               /**< Number of control points in U dimension */
1776    GLuint Vorder;               /**< Number of control points in V dimension */
1777    GLfloat u1, u2, du;
1778    GLfloat v1, v2, dv;
1779    GLfloat *Points;             /**< Points to contiguous control points */
1780 };
1781
1782
1783 /**
1784  * All evaluator control point state
1785  */
1786 struct gl_evaluators
1787 {
1788    /**
1789     * \name 1-D maps
1790     */
1791    /*@{*/
1792    struct gl_1d_map Map1Vertex3;
1793    struct gl_1d_map Map1Vertex4;
1794    struct gl_1d_map Map1Index;
1795    struct gl_1d_map Map1Color4;
1796    struct gl_1d_map Map1Normal;
1797    struct gl_1d_map Map1Texture1;
1798    struct gl_1d_map Map1Texture2;
1799    struct gl_1d_map Map1Texture3;
1800    struct gl_1d_map Map1Texture4;
1801    struct gl_1d_map Map1Attrib[16];  /**< GL_NV_vertex_program */
1802    /*@}*/
1803
1804    /**
1805     * \name 2-D maps
1806     */
1807    /*@{*/
1808    struct gl_2d_map Map2Vertex3;
1809    struct gl_2d_map Map2Vertex4;
1810    struct gl_2d_map Map2Index;
1811    struct gl_2d_map Map2Color4;
1812    struct gl_2d_map Map2Normal;
1813    struct gl_2d_map Map2Texture1;
1814    struct gl_2d_map Map2Texture2;
1815    struct gl_2d_map Map2Texture3;
1816    struct gl_2d_map Map2Texture4;
1817    struct gl_2d_map Map2Attrib[16];  /**< GL_NV_vertex_program */
1818    /*@}*/
1819 };
1820
1821
1822 /**
1823  * Names of the various vertex/fragment program register files, etc.
1824  *
1825  * NOTE: first four tokens must fit into 2 bits (see t_vb_arbprogram.c)
1826  * All values should fit in a 4-bit field.
1827  *
1828  * NOTE: PROGRAM_ENV_PARAM, PROGRAM_STATE_VAR, PROGRAM_NAMED_PARAM,
1829  * PROGRAM_CONSTANT, and PROGRAM_UNIFORM can all be considered to
1830  * be "uniform" variables since they can only be set outside glBegin/End.
1831  * They're also all stored in the same Parameters array.
1832  */
1833 enum register_file
1834 {
1835    PROGRAM_TEMPORARY = 0,   /**< machine->Temporary[] */
1836    PROGRAM_LOCAL_PARAM = 1, /**< gl_program->LocalParams[] */
1837    PROGRAM_ENV_PARAM = 2,   /**< gl_program->Parameters[] */
1838    PROGRAM_STATE_VAR = 3,   /**< gl_program->Parameters[] */
1839    PROGRAM_INPUT = 4,       /**< machine->Inputs[] */
1840    PROGRAM_OUTPUT = 5,      /**< machine->Outputs[] */
1841    PROGRAM_NAMED_PARAM = 6, /**< gl_program->Parameters[] */
1842    PROGRAM_CONSTANT = 7,    /**< gl_program->Parameters[] */
1843    PROGRAM_UNIFORM = 8,     /**< gl_program->Parameters[] */
1844    PROGRAM_VARYING = 9,     /**< machine->Inputs[]/Outputs[] */
1845    PROGRAM_WRITE_ONLY = 10, /**< A dummy, write-only register */
1846    PROGRAM_ADDRESS = 11,    /**< machine->AddressReg */
1847    PROGRAM_SAMPLER = 12,    /**< for shader samplers, compile-time only */
1848    PROGRAM_UNDEFINED = 13,  /**< Invalid value */
1849    PROGRAM_FILE_MAX
1850 };
1851
1852
1853 /** Vertex and fragment instructions */
1854 struct prog_instruction;
1855 struct gl_program_parameter_list;
1856 struct gl_uniform_list;
1857
1858
1859 /**
1860  * Base class for any kind of program object
1861  */
1862 struct gl_program
1863 {
1864    GLuint Id;
1865    GLubyte *String;  /**< Null-terminated program text */
1866    GLint RefCount;
1867    GLenum Target;    /**< GL_VERTEX/FRAGMENT_PROGRAM_ARB, GL_FRAGMENT_PROGRAM_NV */
1868    GLenum Format;    /**< String encoding format */
1869    GLboolean Resident;
1870
1871    struct prog_instruction *Instructions;
1872
1873    GLbitfield InputsRead;     /**< Bitmask of which input regs are read */
1874    GLbitfield OutputsWritten; /**< Bitmask of which output regs are written to */
1875    GLbitfield InputFlags[MAX_PROGRAM_INPUTS];   /**< PROG_PARAM_BIT_x flags */
1876    GLbitfield OutputFlags[MAX_PROGRAM_OUTPUTS]; /**< PROG_PARAM_BIT_x flags */
1877    GLbitfield TexturesUsed[MAX_TEXTURE_UNITS];  /**< TEXTURE_x_BIT bitmask */
1878    GLbitfield SamplersUsed;   /**< Bitfield of which samplers are used */
1879    GLbitfield ShadowSamplers; /**< Texture units used for shadow sampling. */
1880
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    /** Map from sampler unit to texture unit (set by glUniform1i()) */
1893    GLubyte SamplerUnits[MAX_SAMPLERS];
1894    /** Which texture target is being sampled (TEXTURE_1D/2D/3D/etc_INDEX) */
1895    GLubyte SamplerTargets[MAX_SAMPLERS];
1896
1897    /** Logical counts */
1898    /*@{*/
1899    GLuint NumInstructions;
1900    GLuint NumTemporaries;
1901    GLuint NumParameters;
1902    GLuint NumAttributes;
1903    GLuint NumAddressRegs;
1904    GLuint NumAluInstructions;
1905    GLuint NumTexInstructions;
1906    GLuint NumTexIndirections;
1907    /*@}*/
1908    /** Native, actual h/w counts */
1909    /*@{*/
1910    GLuint NumNativeInstructions;
1911    GLuint NumNativeTemporaries;
1912    GLuint NumNativeParameters;
1913    GLuint NumNativeAttributes;
1914    GLuint NumNativeAddressRegs;
1915    GLuint NumNativeAluInstructions;
1916    GLuint NumNativeTexInstructions;
1917    GLuint NumNativeTexIndirections;
1918    /*@}*/
1919 };
1920
1921
1922 /** Vertex program object */
1923 struct gl_vertex_program
1924 {
1925    struct gl_program Base;   /**< base class */
1926    GLboolean IsNVProgram;    /**< is this a GL_NV_vertex_program program? */
1927    GLboolean IsPositionInvariant;
1928    void *TnlData;               /**< should probably use Base.DriverData */
1929 };
1930
1931
1932 /** Fragment program object */
1933 struct gl_fragment_program
1934 {
1935    struct gl_program Base;   /**< base class */
1936    GLenum FogOption;
1937    GLboolean UsesKill;          /**< shader uses KIL instruction */
1938    GLboolean UsesPointCoord;    /**< shader uses gl_PointCoord */
1939    GLboolean UsesFrontFacing;   /**< shader used gl_FrontFacing */
1940    GLboolean UsesFogFragCoord;  /**< shader used gl_FogFragCoord */
1941 };
1942
1943
1944 /**
1945  * State common to vertex and fragment programs.
1946  */
1947 struct gl_program_state
1948 {
1949    GLint ErrorPos;                       /* GL_PROGRAM_ERROR_POSITION_ARB/NV */
1950    const char *ErrorString;              /* GL_PROGRAM_ERROR_STRING_ARB/NV */
1951 };
1952
1953
1954 /**
1955  * Context state for vertex programs.
1956  */
1957 struct gl_vertex_program_state
1958 {
1959    GLboolean Enabled;               /**< User-set GL_VERTEX_PROGRAM_ARB/NV flag */
1960    GLboolean _Enabled;              /**< Enabled and _valid_ user program? */
1961    GLboolean PointSizeEnabled;      /**< GL_VERTEX_PROGRAM_POINT_SIZE_ARB/NV */
1962    GLboolean TwoSideEnabled;        /**< GL_VERTEX_PROGRAM_TWO_SIDE_ARB/NV */
1963    struct gl_vertex_program *Current;  /**< User-bound vertex program */
1964
1965    /** Currently enabled and valid vertex program (including internal programs,
1966     * user-defined vertex programs and GLSL vertex shaders).
1967     * This is the program we must use when rendering.
1968     */
1969    struct gl_vertex_program *_Current;
1970
1971    GLfloat Parameters[MAX_PROGRAM_ENV_PARAMS][4]; /**< Env params */
1972
1973    /* For GL_NV_vertex_program only: */
1974    GLenum TrackMatrix[MAX_PROGRAM_ENV_PARAMS / 4];
1975    GLenum TrackMatrixTransform[MAX_PROGRAM_ENV_PARAMS / 4];
1976
1977    /** Should fixed-function T&L be implemented with a vertex prog? */
1978    GLboolean _MaintainTnlProgram;
1979
1980    /** Program to emulate fixed-function T&L (see above) */
1981    struct gl_vertex_program *_TnlProgram;
1982
1983    /** Cache of fixed-function programs */
1984    struct gl_program_cache *Cache;
1985
1986 #if FEATURE_MESA_program_debug
1987    GLprogramcallbackMESA Callback;
1988    GLvoid *CallbackData;
1989    GLboolean CallbackEnabled;
1990    GLuint CurrentPosition;
1991 #endif
1992 };
1993
1994
1995 /**
1996  * Context state for fragment programs.
1997  */
1998 struct gl_fragment_program_state
1999 {
2000    GLboolean Enabled;     /**< User-set fragment program enable flag */
2001    GLboolean _Enabled;    /**< Enabled and _valid_ user program? */
2002    struct gl_fragment_program *Current;  /**< User-bound fragment program */
2003
2004    /** Currently enabled and valid fragment program (including internal programs,
2005     * user-defined fragment programs and GLSL fragment shaders).
2006     * This is the program we must use when rendering.
2007     */
2008    struct gl_fragment_program *_Current;
2009
2010    GLfloat Parameters[MAX_PROGRAM_ENV_PARAMS][4]; /**< Env params */
2011
2012    /** Should fixed-function texturing be implemented with a fragment prog? */
2013    GLboolean _MaintainTexEnvProgram;
2014
2015    /** Program to emulate fixed-function texture env/combine (see above) */
2016    struct gl_fragment_program *_TexEnvProgram;
2017
2018    /** Cache of fixed-function programs */
2019    struct gl_program_cache *Cache;
2020
2021 #if FEATURE_MESA_program_debug
2022    GLprogramcallbackMESA Callback;
2023    GLvoid *CallbackData;
2024    GLboolean CallbackEnabled;
2025    GLuint CurrentPosition;
2026 #endif
2027 };
2028
2029
2030 /**
2031  * ATI_fragment_shader runtime state
2032  */
2033 #define ATI_FS_INPUT_PRIMARY 0
2034 #define ATI_FS_INPUT_SECONDARY 1
2035
2036 struct atifs_instruction;
2037 struct atifs_setupinst;
2038
2039 /**
2040  * ATI fragment shader
2041  */
2042 struct ati_fragment_shader
2043 {
2044    GLuint Id;
2045    GLint RefCount;
2046    struct atifs_instruction *Instructions[2];
2047    struct atifs_setupinst *SetupInst[2];
2048    GLfloat Constants[8][4];
2049    GLbitfield LocalConstDef;  /** Indicates which constants have been set */
2050    GLubyte numArithInstr[2];
2051    GLubyte regsAssigned[2];
2052    GLubyte NumPasses;         /** 1 or 2 */
2053    GLubyte cur_pass;
2054    GLubyte last_optype;
2055    GLboolean interpinp1;
2056    GLboolean isValid;
2057    GLuint swizzlerq;
2058 };
2059
2060 /**
2061  * Context state for GL_ATI_fragment_shader
2062  */
2063 struct gl_ati_fragment_shader_state
2064 {
2065    GLboolean Enabled;
2066    GLboolean _Enabled;                      /** enabled and valid shader? */
2067    GLboolean Compiling;
2068    GLfloat GlobalConstants[8][4];
2069    struct ati_fragment_shader *Current;
2070 };
2071
2072
2073 /**
2074  * Occlusion/timer query object.
2075  */
2076 struct gl_query_object
2077 {
2078    GLenum Target;      /**< The query target, when active */
2079    GLuint Id;          /**< hash table ID/name */
2080    GLuint64EXT Result; /**< the counter */
2081    GLboolean Active;   /**< inside Begin/EndQuery */
2082    GLboolean Ready;    /**< result is ready? */
2083 };
2084
2085
2086 /**
2087  * Context state for query objects.
2088  */
2089 struct gl_query_state
2090 {
2091    struct _mesa_HashTable *QueryObjects;
2092    struct gl_query_object *CurrentOcclusionObject; /* GL_ARB_occlusion_query */
2093    struct gl_query_object *CurrentTimerObject;     /* GL_EXT_timer_query */
2094 };
2095
2096
2097 /** Set by #pragma directives */
2098 struct gl_sl_pragmas
2099 {
2100    GLboolean Optimize;  /**< defaults on */
2101    GLboolean Debug;     /**< defaults off */
2102 };
2103
2104
2105 /**
2106  * A GLSL vertex or fragment shader object.
2107  */
2108 struct gl_shader
2109 {
2110    GLenum Type;  /**< GL_FRAGMENT_SHADER || GL_VERTEX_SHADER (first field!) */
2111    GLuint Name;  /**< AKA the handle */
2112    GLint RefCount;  /**< Reference count */
2113    GLboolean DeletePending;
2114    GLboolean CompileStatus;
2115    GLboolean Main;  /**< shader defines main() */
2116    const GLchar *Source;  /**< Source code string */
2117    struct gl_program *Program;  /**< Post-compile assembly code */
2118    GLchar *InfoLog;
2119    struct gl_sl_pragmas Pragmas;
2120 };
2121
2122
2123 /**
2124  * A GLSL program object.
2125  * Basically a linked collection of vertex and fragment shaders.
2126  */
2127 struct gl_shader_program
2128 {
2129    GLenum Type;  /**< Always GL_SHADER_PROGRAM (internal token) */
2130    GLuint Name;  /**< aka handle or ID */
2131    GLint RefCount;  /**< Reference count */
2132    GLboolean DeletePending;
2133
2134    GLuint NumShaders;          /**< number of attached shaders */
2135    struct gl_shader **Shaders; /**< List of attached the shaders */
2136
2137    /** User-defined attribute bindings (glBindAttribLocation) */
2138    struct gl_program_parameter_list *Attributes;
2139
2140    /* post-link info: */
2141    struct gl_vertex_program *VertexProgram;     /**< Linked vertex program */
2142    struct gl_fragment_program *FragmentProgram; /**< Linked fragment prog */
2143    struct gl_uniform_list *Uniforms;
2144    struct gl_program_parameter_list *Varying;
2145    GLboolean LinkStatus;   /**< GL_LINK_STATUS */
2146    GLboolean Validated;
2147    GLchar *InfoLog;
2148 };
2149
2150
2151 /**
2152  * Context state for GLSL vertex/fragment shaders.
2153  */
2154 struct gl_shader_state
2155 {
2156    struct gl_shader_program *CurrentProgram; /**< The user-bound program */
2157    /** Driver-selectable options: */
2158    GLboolean EmitHighLevelInstructions; /**< IF/ELSE/ENDIF vs. BRA, etc. */
2159    GLboolean EmitCondCodes;             /**< Use condition codes? */
2160    GLboolean EmitComments;              /**< Annotated instructions */
2161    void *MemPool;
2162 };
2163
2164
2165 /**
2166  * State which can be shared by multiple contexts:
2167  */
2168 struct gl_shared_state
2169 {
2170    _glthread_Mutex Mutex;                  /**< for thread safety */
2171    GLint RefCount;                         /**< Reference count */
2172    struct _mesa_HashTable *DisplayList;    /**< Display lists hash table */
2173    struct _mesa_HashTable *TexObjects;     /**< Texture objects hash table */
2174
2175    /**
2176     * \name Default texture objects (shared by all multi-texture units)
2177     */
2178    /*@{*/
2179    struct gl_texture_object *Default1D;
2180    struct gl_texture_object *Default2D;
2181    struct gl_texture_object *Default3D;
2182    struct gl_texture_object *DefaultCubeMap;
2183    struct gl_texture_object *DefaultRect;
2184    struct gl_texture_object *Default1DArray;
2185    struct gl_texture_object *Default2DArray;
2186    /*@}*/
2187
2188    /**
2189     * \name Thread safety and statechange notification for texture
2190     * objects.
2191     *
2192     * \todo Improve the granularity of locking.
2193     */
2194    /*@{*/
2195    _glthread_Mutex TexMutex;            /**< texobj thread safety */
2196    GLuint TextureStateStamp;            /**< state notification for shared tex */
2197    /*@}*/
2198
2199
2200    /**
2201     * \name Vertex/fragment programs
2202     */
2203    /*@{*/
2204    struct _mesa_HashTable *Programs; /**< All vertex/fragment programs */
2205 #if FEATURE_ARB_vertex_program
2206    struct gl_vertex_program *DefaultVertexProgram;
2207 #endif
2208 #if FEATURE_ARB_fragment_program
2209    struct gl_fragment_program *DefaultFragmentProgram;
2210 #endif
2211    /*@}*/
2212
2213 #if FEATURE_ATI_fragment_shader
2214    struct _mesa_HashTable *ATIShaders;
2215    struct ati_fragment_shader *DefaultFragmentShader;
2216 #endif
2217
2218 #if FEATURE_ARB_vertex_buffer_object || FEATURE_ARB_pixel_buffer_object
2219    struct _mesa_HashTable *BufferObjects;
2220 #endif
2221
2222 #if FEATURE_ARB_shader_objects
2223    /** Table of both gl_shader and gl_shader_program objects */
2224    struct _mesa_HashTable *ShaderObjects;
2225 #endif
2226
2227 #if FEATURE_EXT_framebuffer_object
2228    struct _mesa_HashTable *RenderBuffers;
2229    struct _mesa_HashTable *FrameBuffers;
2230 #endif
2231
2232    /** Objects associated with the GL_APPLE_vertex_array_object extension. */
2233    struct _mesa_HashTable *ArrayObjects;
2234
2235    void *DriverData;  /**< Device driver shared state */
2236 };
2237
2238
2239
2240
2241 /**
2242  * A renderbuffer stores colors or depth values or stencil values.
2243  * A framebuffer object will have a collection of these.
2244  * Data are read/written to the buffer with a handful of Get/Put functions.
2245  *
2246  * Instances of this object are allocated with the Driver's NewRenderbuffer
2247  * hook.  Drivers will likely wrap this class inside a driver-specific
2248  * class to simulate inheritance.
2249  */
2250 struct gl_renderbuffer
2251 {
2252 #define RB_MAGIC 0xaabbccdd
2253    int Magic; /** XXX TEMPORARY DEBUG INFO */
2254    _glthread_Mutex Mutex;                  /**< for thread safety */
2255    GLuint ClassID;        /**< Useful for drivers */
2256    GLuint Name;
2257    GLint RefCount;
2258    GLuint Width, Height;
2259    GLenum InternalFormat; /**< The user-specified format */
2260    GLenum _ActualFormat;  /**< The driver-chosen format */
2261    GLenum _BaseFormat;    /**< Either GL_RGB, GL_RGBA, GL_DEPTH_COMPONENT or
2262                                GL_STENCIL_INDEX. */
2263    GLenum DataType;      /**< Type of values passed to the Get/Put functions */
2264    GLubyte RedBits;      /**< Bits of red per pixel */
2265    GLubyte GreenBits;
2266    GLubyte BlueBits;
2267    GLubyte AlphaBits;
2268    GLubyte IndexBits;
2269    GLubyte DepthBits;
2270    GLubyte StencilBits;
2271    GLvoid *Data;        /**< This may not be used by some kinds of RBs */
2272
2273    /* Used to wrap one renderbuffer around another: */
2274    struct gl_renderbuffer *Wrapped;
2275
2276    /* Delete this renderbuffer */
2277    void (*Delete)(struct gl_renderbuffer *rb);
2278
2279    /* Allocate new storage for this renderbuffer */
2280    GLboolean (*AllocStorage)(GLcontext *ctx, struct gl_renderbuffer *rb,
2281                              GLenum internalFormat,
2282                              GLuint width, GLuint height);
2283
2284    /* Lock/Unlock are called before/after calling the Get/Put functions.
2285     * Not sure this is the right place for these yet.
2286    void (*Lock)(GLcontext *ctx, struct gl_renderbuffer *rb);
2287    void (*Unlock)(GLcontext *ctx, struct gl_renderbuffer *rb);
2288     */
2289
2290    /* Return a pointer to the element/pixel at (x,y).
2291     * Should return NULL if the buffer memory can't be directly addressed.
2292     */
2293    void *(*GetPointer)(GLcontext *ctx, struct gl_renderbuffer *rb,
2294                        GLint x, GLint y);
2295
2296    /* Get/Read a row of values.
2297     * The values will be of format _BaseFormat and type DataType.
2298     */
2299    void (*GetRow)(GLcontext *ctx, struct gl_renderbuffer *rb, GLuint count,
2300                   GLint x, GLint y, void *values);
2301
2302    /* Get/Read values at arbitrary locations.
2303     * The values will be of format _BaseFormat and type DataType.
2304     */
2305    void (*GetValues)(GLcontext *ctx, struct gl_renderbuffer *rb, GLuint count,
2306                      const GLint x[], const GLint y[], void *values);
2307
2308    /* Put/Write a row of values.
2309     * The values will be of format _BaseFormat and type DataType.
2310     */
2311    void (*PutRow)(GLcontext *ctx, struct gl_renderbuffer *rb, GLuint count,
2312                   GLint x, GLint y, const void *values, const GLubyte *mask);
2313
2314    /* Put/Write a row of RGB values.  This is a special-case routine that's
2315     * only used for RGBA renderbuffers when the source data is GL_RGB. That's
2316     * a common case for glDrawPixels and some triangle routines.
2317     * The values will be of format GL_RGB and type DataType.
2318     */
2319    void (*PutRowRGB)(GLcontext *ctx, struct gl_renderbuffer *rb, GLuint count,
2320                     GLint x, GLint y, const void *values, const GLubyte *mask);
2321
2322
2323    /* Put/Write a row of identical values.
2324     * The values will be of format _BaseFormat and type DataType.
2325     */
2326    void (*PutMonoRow)(GLcontext *ctx, struct gl_renderbuffer *rb, GLuint count,
2327                      GLint x, GLint y, const void *value, const GLubyte *mask);
2328
2329    /* Put/Write values at arbitrary locations.
2330     * The values will be of format _BaseFormat and type DataType.
2331     */
2332    void (*PutValues)(GLcontext *ctx, struct gl_renderbuffer *rb, GLuint count,
2333                      const GLint x[], const GLint y[], const void *values,
2334                      const GLubyte *mask);
2335    /* Put/Write identical values at arbitrary locations.
2336     * The values will be of format _BaseFormat and type DataType.
2337     */
2338    void (*PutMonoValues)(GLcontext *ctx, struct gl_renderbuffer *rb,
2339                          GLuint count, const GLint x[], const GLint y[],
2340                          const void *value, const GLubyte *mask);
2341 };
2342
2343
2344 /**
2345  * A renderbuffer attachment point points to either a texture object
2346  * (and specifies a mipmap level, cube face or 3D texture slice) or
2347  * points to a renderbuffer.
2348  */
2349 struct gl_renderbuffer_attachment
2350 {
2351    GLenum Type;  /**< \c GL_NONE or \c GL_TEXTURE or \c GL_RENDERBUFFER_EXT */
2352    GLboolean Complete;
2353
2354    /**
2355     * If \c Type is \c GL_RENDERBUFFER_EXT, this stores a pointer to the
2356     * application supplied renderbuffer object.
2357     */
2358    struct gl_renderbuffer *Renderbuffer;
2359
2360    /**
2361     * If \c Type is \c GL_TEXTURE, this stores a pointer to the application
2362     * supplied texture object.
2363     */
2364    struct gl_texture_object *Texture;
2365    GLuint TextureLevel; /**< Attached mipmap level. */
2366    GLuint CubeMapFace;  /**< 0 .. 5, for cube map textures. */
2367    GLuint Zoffset;      /**< Slice for 3D textures,  or layer for both 1D
2368                          * and 2D array textures */
2369 };
2370
2371
2372 /**
2373  * A framebuffer is a collection of renderbuffers (color, depth, stencil, etc).
2374  * In C++ terms, think of this as a base class from which device drivers
2375  * will make derived classes.
2376  */
2377 struct gl_framebuffer
2378 {
2379    _glthread_Mutex Mutex;                  /**< for thread safety */
2380    GLuint Name;      /* if zero, this is a window system framebuffer */
2381    GLint RefCount;
2382    GLboolean DeletePending;
2383
2384    GLvisual Visual;     /**< The framebuffer's visual.
2385                              Immutable if this is a window system buffer.
2386                              Computed from attachments if user-made FBO. */
2387
2388    GLboolean Initialized;
2389
2390    GLuint Width, Height;        /**< size of frame buffer in pixels */
2391
2392    /** \name  Drawing bounds (Intersection of buffer size and scissor box) */
2393    /*@{*/
2394    GLint _Xmin, _Xmax;  /**< inclusive */
2395    GLint _Ymin, _Ymax;  /**< exclusive */
2396    /*@}*/
2397
2398    /** \name  Derived Z buffer stuff */
2399    /*@{*/
2400    GLuint _DepthMax;    /**< Max depth buffer value */
2401    GLfloat _DepthMaxF;  /**< Float max depth buffer value */
2402    GLfloat _MRD;        /**< minimum resolvable difference in Z values */
2403    /*@}*/
2404
2405    GLenum _Status; /* One of the GL_FRAMEBUFFER_(IN)COMPLETE_* tokens */
2406
2407    /* Array of all renderbuffer attachments, indexed by BUFFER_* tokens. */
2408    struct gl_renderbuffer_attachment Attachment[BUFFER_COUNT];
2409
2410    /* In unextended OpenGL these vars are part of the GL_COLOR_BUFFER
2411     * attribute group and GL_PIXEL attribute group, respectively.
2412     */
2413    GLenum ColorDrawBuffer[MAX_DRAW_BUFFERS];
2414    GLenum ColorReadBuffer;
2415
2416    /** Computed from ColorDraw/ReadBuffer above */
2417    GLuint _NumColorDrawBuffers;
2418    GLint _ColorDrawBufferIndexes[MAX_DRAW_BUFFERS]; /**< BUFFER_x or -1 */
2419    GLint _ColorReadBufferIndex; /* -1 = None */
2420    struct gl_renderbuffer *_ColorDrawBuffers[MAX_DRAW_BUFFERS];
2421    struct gl_renderbuffer *_ColorReadBuffer;
2422
2423    /** The Actual depth/stencil buffers to use.  May be wrappers around the
2424     * depth/stencil buffers attached above. */
2425    struct gl_renderbuffer *_DepthBuffer;
2426    struct gl_renderbuffer *_StencilBuffer;
2427
2428    /** Delete this framebuffer */
2429    void (*Delete)(struct gl_framebuffer *fb);
2430 };
2431
2432
2433 /**
2434  * Limits for vertex and fragment programs.
2435  */
2436 struct gl_program_constants
2437 {
2438    /* logical limits */
2439    GLuint MaxInstructions;
2440    GLuint MaxAluInstructions; /* fragment programs only, for now */
2441    GLuint MaxTexInstructions; /* fragment programs only, for now */
2442    GLuint MaxTexIndirections; /* fragment programs only, for now */
2443    GLuint MaxAttribs;
2444    GLuint MaxTemps;
2445    GLuint MaxAddressRegs; /* vertex program only, for now */
2446    GLuint MaxParameters;
2447    GLuint MaxLocalParams;
2448    GLuint MaxEnvParams;
2449    /* native/hardware limits */
2450    GLuint MaxNativeInstructions;
2451    GLuint MaxNativeAluInstructions; /* fragment programs only, for now */
2452    GLuint MaxNativeTexInstructions; /* fragment programs only, for now */
2453    GLuint MaxNativeTexIndirections; /* fragment programs only, for now */
2454    GLuint MaxNativeAttribs;
2455    GLuint MaxNativeTemps;
2456    GLuint MaxNativeAddressRegs; /* vertex program only, for now */
2457    GLuint MaxNativeParameters;
2458    /* For shaders */
2459    GLuint MaxUniformComponents;
2460 };
2461
2462
2463 /**
2464  * Constants which may be overridden by device driver during context creation
2465  * but are never changed after that.
2466  */
2467 struct gl_constants
2468 {
2469    GLint MaxTextureLevels;              /**< Maximum number of allowed mipmap levels. */
2470    GLint Max3DTextureLevels;            /**< Maximum number of allowed mipmap levels for 3D texture targets. */
2471    GLint MaxCubeTextureLevels;          /**< Maximum number of allowed mipmap levels for GL_ARB_texture_cube_map */
2472    GLint MaxArrayTextureLayers;         /**< Maximum number of layers in an array texture. */
2473    GLint MaxTextureRectSize;            /* GL_NV_texture_rectangle */
2474    GLuint MaxTextureCoordUnits;
2475    GLuint MaxTextureImageUnits;
2476    GLuint MaxTextureUnits;              /**< = MIN(CoordUnits, ImageUnits) */
2477    GLfloat MaxTextureMaxAnisotropy;     /**< GL_EXT_texture_filter_anisotropic */
2478    GLfloat MaxTextureLodBias;           /**< GL_EXT_texture_lod_bias */
2479    GLuint MaxArrayLockSize;
2480    GLint SubPixelBits;
2481    GLfloat MinPointSize, MaxPointSize;          /* aliased */
2482    GLfloat MinPointSizeAA, MaxPointSizeAA;      /* antialiased */
2483    GLfloat PointSizeGranularity;
2484    GLfloat MinLineWidth, MaxLineWidth;          /* aliased */
2485    GLfloat MinLineWidthAA, MaxLineWidthAA;      /* antialiased */
2486    GLfloat LineWidthGranularity;
2487    GLuint MaxColorTableSize;
2488    GLuint MaxConvolutionWidth;
2489    GLuint MaxConvolutionHeight;
2490    GLuint MaxClipPlanes;
2491    GLuint MaxLights;
2492    GLfloat MaxShininess;                        /* GL_NV_light_max_exponent */
2493    GLfloat MaxSpotExponent;                     /* GL_NV_light_max_exponent */
2494    GLuint MaxViewportWidth, MaxViewportHeight;
2495    struct gl_program_constants VertexProgram;    /* GL_ARB_vertex_program */
2496    struct gl_program_constants FragmentProgram;  /* GL_ARB_fragment_program */
2497    /* shared by vertex and fragment program: */
2498    GLuint MaxProgramMatrices;
2499    GLuint MaxProgramMatrixStackDepth;
2500    /* vertex array / buffer object bounds checking */
2501    GLboolean CheckArrayBounds;
2502    /* GL_ARB_draw_buffers */
2503    GLuint MaxDrawBuffers;
2504    /* GL_OES_read_format */
2505    GLenum ColorReadFormat;
2506    GLenum ColorReadType;
2507    /* GL_EXT_framebuffer_object */
2508    GLuint MaxColorAttachments;
2509    GLuint MaxRenderbufferSize;
2510    /* GL_ARB_vertex_shader */
2511    GLuint MaxVertexTextureImageUnits;
2512    GLuint MaxVarying;  /**< Number of float[4] vectors */
2513 };
2514
2515
2516 /**
2517  * Enable flag for each OpenGL extension.  Different device drivers will
2518  * enable different extensions at runtime.
2519  */
2520 struct gl_extensions
2521 {
2522    /**
2523     * \name Flags to quickly test if certain extensions are available.
2524     *
2525     * Not every extension needs to have such a flag, but it's encouraged.
2526     */
2527    /*@{*/
2528    GLboolean dummy;  /* don't remove this! */
2529    GLboolean ARB_depth_texture;
2530    GLboolean ARB_draw_buffers;
2531    GLboolean ARB_fragment_program;
2532    GLboolean ARB_fragment_program_shadow;
2533    GLboolean ARB_fragment_shader;
2534    GLboolean ARB_framebuffer_object;
2535    GLboolean ARB_half_float_pixel;
2536    GLboolean ARB_imaging;
2537    GLboolean ARB_multisample;
2538    GLboolean ARB_multitexture;
2539    GLboolean ARB_occlusion_query;
2540    GLboolean ARB_point_sprite;
2541    GLboolean ARB_shader_objects;
2542    GLboolean ARB_shading_language_100;
2543    GLboolean ARB_shading_language_120;
2544    GLboolean ARB_shadow;
2545    GLboolean ARB_texture_border_clamp;
2546    GLboolean ARB_texture_compression;
2547    GLboolean ARB_texture_cube_map;
2548    GLboolean ARB_texture_env_combine;
2549    GLboolean ARB_texture_env_crossbar;
2550    GLboolean ARB_texture_env_dot3;
2551    GLboolean ARB_texture_float;
2552    GLboolean ARB_texture_mirrored_repeat;
2553    GLboolean ARB_texture_non_power_of_two;
2554    GLboolean ARB_transpose_matrix;
2555    GLboolean ARB_vertex_buffer_object;
2556    GLboolean ARB_vertex_program;
2557    GLboolean ARB_vertex_shader;
2558    GLboolean ARB_window_pos;
2559    GLboolean EXT_abgr;
2560    GLboolean EXT_bgra;
2561    GLboolean EXT_blend_color;
2562    GLboolean EXT_blend_equation_separate;
2563    GLboolean EXT_blend_func_separate;
2564    GLboolean EXT_blend_logic_op;
2565    GLboolean EXT_blend_minmax;
2566    GLboolean EXT_blend_subtract;
2567    GLboolean EXT_clip_volume_hint;
2568    GLboolean EXT_cull_vertex;
2569    GLboolean EXT_convolution;
2570    GLboolean EXT_compiled_vertex_array;
2571    GLboolean EXT_copy_texture;
2572    GLboolean EXT_depth_bounds_test;
2573    GLboolean EXT_draw_range_elements;
2574    GLboolean EXT_framebuffer_object;
2575    GLboolean EXT_fog_coord;
2576    GLboolean EXT_framebuffer_blit;
2577    GLboolean EXT_gpu_program_parameters;
2578    GLboolean EXT_histogram;
2579    GLboolean EXT_multi_draw_arrays;
2580    GLboolean EXT_paletted_texture;
2581    GLboolean EXT_packed_depth_stencil;
2582    GLboolean EXT_packed_pixels;
2583    GLboolean EXT_pixel_buffer_object;
2584    GLboolean EXT_point_parameters;
2585    GLboolean EXT_polygon_offset;
2586    GLboolean EXT_rescale_normal;
2587    GLboolean EXT_shadow_funcs;
2588    GLboolean EXT_secondary_color;
2589    GLboolean EXT_separate_specular_color;
2590    GLboolean EXT_shared_texture_palette;
2591    GLboolean EXT_stencil_wrap;
2592    GLboolean EXT_stencil_two_side;
2593    GLboolean EXT_subtexture;
2594    GLboolean EXT_texture;
2595    GLboolean EXT_texture_object;
2596    GLboolean EXT_texture3D;
2597    GLboolean EXT_texture_compression_s3tc;
2598    GLboolean EXT_texture_env_add;
2599    GLboolean EXT_texture_env_combine;
2600    GLboolean EXT_texture_env_dot3;
2601    GLboolean EXT_texture_filter_anisotropic;
2602    GLboolean EXT_texture_lod_bias;
2603    GLboolean EXT_texture_mirror_clamp;
2604    GLboolean EXT_texture_sRGB;
2605    GLboolean EXT_timer_query;
2606    GLboolean EXT_vertex_array;
2607    GLboolean EXT_vertex_array_set;
2608    /* vendor extensions */
2609    GLboolean APPLE_client_storage;
2610    GLboolean APPLE_packed_pixels;
2611    GLboolean APPLE_vertex_array_object;
2612    GLboolean ATI_texture_mirror_once;
2613    GLboolean ATI_texture_env_combine3;
2614    GLboolean ATI_fragment_shader;
2615    GLboolean ATI_separate_stencil;
2616    GLboolean IBM_rasterpos_clip;
2617    GLboolean IBM_multimode_draw_arrays;
2618    GLboolean MESA_pack_invert;
2619    GLboolean MESA_packed_depth_stencil;
2620    GLboolean MESA_program_debug;
2621    GLboolean MESA_resize_buffers;
2622    GLboolean MESA_ycbcr_texture;
2623    GLboolean MESA_texture_array;
2624    GLboolean NV_blend_square;
2625    GLboolean NV_fragment_program;
2626    GLboolean NV_light_max_exponent;
2627    GLboolean NV_point_sprite;
2628    GLboolean NV_texgen_reflection;
2629    GLboolean NV_texture_rectangle;
2630    GLboolean NV_vertex_program;
2631    GLboolean NV_vertex_program1_1;
2632    GLboolean OES_read_format;
2633    GLboolean SGI_color_matrix;
2634    GLboolean SGI_color_table;
2635    GLboolean SGI_texture_color_table;
2636    GLboolean SGIS_generate_mipmap;
2637    GLboolean SGIS_texture_edge_clamp;
2638    GLboolean SGIS_texture_lod;
2639    GLboolean SGIX_shadow;
2640    GLboolean SGIX_shadow_ambient; /* or GL_ARB_shadow_ambient */
2641    GLboolean TDFX_texture_compression_FXT1;
2642    GLboolean S3_s3tc;
2643    /*@}*/
2644    /* The extension string */
2645    const GLubyte *String;
2646 };
2647
2648
2649 /**
2650  * A stack of matrices (projection, modelview, color, texture, etc).
2651  */
2652 struct gl_matrix_stack
2653 {
2654    GLmatrix *Top;      /**< points into Stack */
2655    GLmatrix *Stack;    /**< array [MaxDepth] of GLmatrix */
2656    GLuint Depth;       /**< 0 <= Depth < MaxDepth */
2657    GLuint MaxDepth;    /**< size of Stack[] array */
2658    GLuint DirtyFlag;   /**< _NEW_MODELVIEW or _NEW_PROJECTION, for example */
2659 };
2660
2661
2662 /**
2663  * \name Bits for image transfer operations
2664  *
2665  * \sa __GLcontextRec::ImageTransferState.
2666  */
2667 /*@{*/
2668 #define IMAGE_SCALE_BIAS_BIT                      0x1
2669 #define IMAGE_SHIFT_OFFSET_BIT                    0x2
2670 #define IMAGE_MAP_COLOR_BIT                       0x4
2671 #define IMAGE_COLOR_TABLE_BIT                     0x8
2672 #define IMAGE_CONVOLUTION_BIT                     0x10
2673 #define IMAGE_POST_CONVOLUTION_SCALE_BIAS         0x20
2674 #define IMAGE_POST_CONVOLUTION_COLOR_TABLE_BIT    0x40
2675 #define IMAGE_COLOR_MATRIX_BIT                    0x80
2676 #define IMAGE_POST_COLOR_MATRIX_COLOR_TABLE_BIT   0x100
2677 #define IMAGE_HISTOGRAM_BIT                       0x200
2678 #define IMAGE_MIN_MAX_BIT                         0x400
2679 #define IMAGE_CLAMP_BIT                           0x800 /* extra */
2680
2681
2682 /** Pixel Transfer ops up to convolution */
2683 #define IMAGE_PRE_CONVOLUTION_BITS (IMAGE_SCALE_BIAS_BIT |     \
2684                                     IMAGE_SHIFT_OFFSET_BIT |   \
2685                                     IMAGE_MAP_COLOR_BIT |      \
2686                                     IMAGE_COLOR_TABLE_BIT)
2687
2688 /** Pixel transfer ops after convolution */
2689 #define IMAGE_POST_CONVOLUTION_BITS (IMAGE_POST_CONVOLUTION_SCALE_BIAS |      \
2690                                      IMAGE_POST_CONVOLUTION_COLOR_TABLE_BIT | \
2691                                      IMAGE_COLOR_MATRIX_BIT |                 \
2692                                      IMAGE_POST_COLOR_MATRIX_COLOR_TABLE_BIT |\
2693                                      IMAGE_HISTOGRAM_BIT |                    \
2694                                      IMAGE_MIN_MAX_BIT)
2695 /*@}*/
2696
2697
2698 /**
2699  * \name Bits to indicate what state has changed.
2700  *
2701  * 4 unused flags.
2702  */
2703 /*@{*/
2704 #define _NEW_MODELVIEW          0x1        /**< __GLcontextRec::ModelView */
2705 #define _NEW_PROJECTION         0x2        /**< __GLcontextRec::Projection */
2706 #define _NEW_TEXTURE_MATRIX     0x4        /**< __GLcontextRec::TextureMatrix */
2707 #define _NEW_COLOR_MATRIX       0x8        /**< __GLcontextRec::ColorMatrix */
2708 #define _NEW_ACCUM              0x10       /**< __GLcontextRec::Accum */
2709 #define _NEW_COLOR              0x20       /**< __GLcontextRec::Color */
2710 #define _NEW_DEPTH              0x40       /**< __GLcontextRec::Depth */
2711 #define _NEW_EVAL               0x80       /**< __GLcontextRec::Eval, __GLcontextRec::EvalMap */
2712 #define _NEW_FOG                0x100      /**< __GLcontextRec::Fog */
2713 #define _NEW_HINT               0x200      /**< __GLcontextRec::Hint */
2714 #define _NEW_LIGHT              0x400      /**< __GLcontextRec::Light */
2715 #define _NEW_LINE               0x800      /**< __GLcontextRec::Line */
2716 #define _NEW_PIXEL              0x1000     /**< __GLcontextRec::Pixel */
2717 #define _NEW_POINT              0x2000     /**< __GLcontextRec::Point */
2718 #define _NEW_POLYGON            0x4000     /**< __GLcontextRec::Polygon */
2719 #define _NEW_POLYGONSTIPPLE     0x8000     /**< __GLcontextRec::PolygonStipple */
2720 #define _NEW_SCISSOR            0x10000    /**< __GLcontextRec::Scissor */
2721 #define _NEW_STENCIL            0x20000    /**< __GLcontextRec::Stencil */
2722 #define _NEW_TEXTURE            0x40000    /**< __GLcontextRec::Texture */
2723 #define _NEW_TRANSFORM          0x80000    /**< __GLcontextRec::Transform */
2724 #define _NEW_VIEWPORT           0x100000   /**< __GLcontextRec::Viewport */
2725 #define _NEW_PACKUNPACK         0x200000   /**< __GLcontextRec::Pack, __GLcontextRec::Unpack */
2726 #define _NEW_ARRAY              0x400000   /**< __GLcontextRec::Array */
2727 #define _NEW_RENDERMODE         0x800000   /**< __GLcontextRec::RenderMode, __GLcontextRec::Feedback, __GLcontextRec::Select */
2728 #define _NEW_BUFFERS            0x1000000  /**< __GLcontextRec::Visual, __GLcontextRec::DrawBuffer, */
2729 #define _NEW_MULTISAMPLE        0x2000000  /**< __GLcontextRec::Multisample */
2730 #define _NEW_TRACK_MATRIX       0x4000000  /**< __GLcontextRec::VertexProgram */
2731 #define _NEW_PROGRAM            0x8000000  /**< __GLcontextRec::VertexProgram */
2732 #define _NEW_ALL ~0
2733 /*@}*/
2734
2735
2736 /**
2737  * \name Bits to track array state changes
2738  *
2739  * Also used to summarize array enabled.
2740  */
2741 /*@{*/
2742 #define _NEW_ARRAY_VERTEX           VERT_BIT_POS
2743 #define _NEW_ARRAY_WEIGHT           VERT_BIT_WEIGHT
2744 #define _NEW_ARRAY_NORMAL           VERT_BIT_NORMAL
2745 #define _NEW_ARRAY_COLOR0           VERT_BIT_COLOR0
2746 #define _NEW_ARRAY_COLOR1           VERT_BIT_COLOR1
2747 #define _NEW_ARRAY_FOGCOORD         VERT_BIT_FOG
2748 #define _NEW_ARRAY_INDEX            VERT_BIT_COLOR_INDEX
2749 #define _NEW_ARRAY_EDGEFLAG         VERT_BIT_EDGEFLAG
2750 #define _NEW_ARRAY_POINT_SIZE       VERT_BIT_COLOR_INDEX  /* aliased */
2751 #define _NEW_ARRAY_TEXCOORD_0       VERT_BIT_TEX0
2752 #define _NEW_ARRAY_TEXCOORD_1       VERT_BIT_TEX1
2753 #define _NEW_ARRAY_TEXCOORD_2       VERT_BIT_TEX2
2754 #define _NEW_ARRAY_TEXCOORD_3       VERT_BIT_TEX3
2755 #define _NEW_ARRAY_TEXCOORD_4       VERT_BIT_TEX4
2756 #define _NEW_ARRAY_TEXCOORD_5       VERT_BIT_TEX5
2757 #define _NEW_ARRAY_TEXCOORD_6       VERT_BIT_TEX6
2758 #define _NEW_ARRAY_TEXCOORD_7       VERT_BIT_TEX7
2759 #define _NEW_ARRAY_ATTRIB_0         VERT_BIT_GENERIC0  /* start at bit 16 */
2760 #define _NEW_ARRAY_ALL              0xffffffff
2761
2762
2763 #define _NEW_ARRAY_TEXCOORD(i) (_NEW_ARRAY_TEXCOORD_0 << (i))
2764 #define _NEW_ARRAY_ATTRIB(i) (_NEW_ARRAY_ATTRIB_0 << (i))
2765 /*@}*/
2766
2767
2768
2769 /**
2770  * \name A bunch of flags that we think might be useful to drivers.
2771  *
2772  * Set in the __GLcontextRec::_TriangleCaps bitfield.
2773  */
2774 /*@{*/
2775 #define DD_FLATSHADE                0x1
2776 #define DD_SEPARATE_SPECULAR        0x2
2777 #define DD_TRI_CULL_FRONT_BACK      0x4 /* special case on some hw */
2778 #define DD_TRI_LIGHT_TWOSIDE        0x8
2779 #define DD_TRI_UNFILLED             0x10
2780 #define DD_TRI_SMOOTH               0x20
2781 #define DD_TRI_STIPPLE              0x40
2782 #define DD_TRI_OFFSET               0x80
2783 #define DD_LINE_SMOOTH              0x100
2784 #define DD_LINE_STIPPLE             0x200
2785 #define DD_LINE_WIDTH               0x400
2786 #define DD_POINT_SMOOTH             0x800
2787 #define DD_POINT_SIZE               0x1000
2788 #define DD_POINT_ATTEN              0x2000
2789 #define DD_TRI_TWOSTENCIL           0x4000
2790 /*@}*/
2791
2792
2793 /**
2794  * \name Define the state changes under which each of these bits might change
2795  */
2796 /*@{*/
2797 #define _DD_NEW_FLATSHADE                _NEW_LIGHT
2798 #define _DD_NEW_SEPARATE_SPECULAR        (_NEW_LIGHT | _NEW_FOG | _NEW_PROGRAM)
2799 #define _DD_NEW_TRI_CULL_FRONT_BACK      _NEW_POLYGON
2800 #define _DD_NEW_TRI_LIGHT_TWOSIDE        _NEW_LIGHT
2801 #define _DD_NEW_TRI_UNFILLED             _NEW_POLYGON
2802 #define _DD_NEW_TRI_SMOOTH               _NEW_POLYGON
2803 #define _DD_NEW_TRI_STIPPLE              _NEW_POLYGON
2804 #define _DD_NEW_TRI_OFFSET               _NEW_POLYGON
2805 #define _DD_NEW_LINE_SMOOTH              _NEW_LINE
2806 #define _DD_NEW_LINE_STIPPLE             _NEW_LINE
2807 #define _DD_NEW_LINE_WIDTH               _NEW_LINE
2808 #define _DD_NEW_POINT_SMOOTH             _NEW_POINT
2809 #define _DD_NEW_POINT_SIZE               _NEW_POINT
2810 #define _DD_NEW_POINT_ATTEN              _NEW_POINT
2811 /*@}*/
2812
2813
2814 #define _MESA_NEW_NEED_EYE_COORDS         (_NEW_LIGHT |         \
2815                                            _NEW_TEXTURE |       \
2816                                            _NEW_POINT |         \
2817                                            _NEW_PROGRAM |       \
2818                                            _NEW_MODELVIEW)
2819
2820 #define _MESA_NEW_NEED_NORMALS            (_NEW_LIGHT |         \
2821                                            _NEW_TEXTURE)
2822
2823 #define _IMAGE_NEW_TRANSFER_STATE         (_NEW_PIXEL | _NEW_COLOR_MATRIX)
2824
2825
2826
2827
2828 /*
2829  * Forward declaration of display list data types:
2830  */
2831 union node;
2832 typedef union node Node;
2833
2834
2835 /* This has to be included here. */
2836 #include "dd.h"
2837
2838
2839 #define NUM_VERTEX_FORMAT_ENTRIES (sizeof(GLvertexformat) / sizeof(void *))
2840
2841 /**
2842  * Core Mesa's support for tnl modules:
2843  */
2844 struct gl_tnl_module
2845 {
2846    /**
2847     * Vertex format to be lazily swapped into current dispatch.
2848     */
2849    const GLvertexformat *Current;
2850
2851    /**
2852     * \name Record of functions swapped out.
2853     * On restore, only need to swap these functions back in.
2854     */
2855    /*@{*/
2856    struct {
2857        _glapi_proc * location;
2858        _glapi_proc function;
2859    } Swapped[NUM_VERTEX_FORMAT_ENTRIES];
2860    GLuint SwapCount;
2861    /*@}*/
2862 };
2863
2864 /* Strictly this is a tnl/ private concept, but it doesn't seem
2865  * worthwhile adding a tnl private structure just to hold this one bit
2866  * of information:
2867  */
2868 #define MESA_DLIST_DANGLING_REFS     0x1
2869
2870 /* Provide a location where information about a display list can be
2871  * collected.  Could be extended with driverPrivate structures,
2872  * etc. in the future.
2873  */
2874 struct mesa_display_list
2875 {
2876    Node *node;
2877    GLuint id;
2878    GLbitfield flags;
2879 };
2880
2881
2882 /**
2883  * State used during display list compilation and execution.
2884  */
2885 struct gl_dlist_state
2886 {
2887    GLuint CallDepth;            /**< Current recursion calling depth */
2888
2889    struct mesa_display_list *CurrentList;
2890    Node *CurrentListPtr;        /**< Head of list being compiled */
2891    GLuint CurrentListNum;       /**< Number of the list being compiled */
2892    Node *CurrentBlock;          /**< Pointer to current block of nodes */
2893    GLuint CurrentPos;           /**< Index into current block of nodes */
2894
2895    GLvertexformat ListVtxfmt;
2896
2897    GLubyte ActiveAttribSize[VERT_ATTRIB_MAX];
2898    GLfloat CurrentAttrib[VERT_ATTRIB_MAX][4];
2899
2900    GLubyte ActiveMaterialSize[MAT_ATTRIB_MAX];
2901    GLfloat CurrentMaterial[MAT_ATTRIB_MAX][4];
2902
2903    GLubyte ActiveIndex;
2904    GLfloat CurrentIndex;
2905
2906    GLubyte ActiveEdgeFlag;
2907    GLboolean CurrentEdgeFlag;
2908 };
2909
2910
2911 /**
2912  * Mesa rendering context.
2913  *
2914  * This is the central context data structure for Mesa.  Almost all
2915  * OpenGL state is contained in this structure.
2916  * Think of this as a base class from which device drivers will derive
2917  * sub classes.
2918  *
2919  * The GLcontext typedef names this structure.
2920  */
2921 struct __GLcontextRec
2922 {
2923    /** State possibly shared with other contexts in the address space */
2924    struct gl_shared_state *Shared;
2925
2926    /** \name API function pointer tables */
2927    /*@{*/
2928    struct _glapi_table *Save;   /**< Display list save functions */
2929    struct _glapi_table *Exec;   /**< Execute functions */
2930    struct _glapi_table *CurrentDispatch;  /**< == Save or Exec !! */
2931    /*@}*/
2932
2933    GLvisual Visual;
2934    GLframebuffer *DrawBuffer;   /**< buffer for writing */
2935    GLframebuffer *ReadBuffer;   /**< buffer for reading */
2936    GLframebuffer *WinSysDrawBuffer;  /**< set with MakeCurrent */
2937    GLframebuffer *WinSysReadBuffer;  /**< set with MakeCurrent */
2938
2939    /**
2940     * Device driver function pointer table
2941     */
2942    struct dd_function_table Driver;
2943
2944    void *DriverCtx;     /**< Points to device driver context/state */
2945
2946    /** Core/Driver constants */
2947    struct gl_constants Const;
2948
2949    /** \name The various 4x4 matrix stacks */
2950    /*@{*/
2951    struct gl_matrix_stack ModelviewMatrixStack;
2952    struct gl_matrix_stack ProjectionMatrixStack;
2953    struct gl_matrix_stack ColorMatrixStack;
2954    struct gl_matrix_stack TextureMatrixStack[MAX_TEXTURE_UNITS];
2955    struct gl_matrix_stack ProgramMatrixStack[MAX_PROGRAM_MATRICES];
2956    struct gl_matrix_stack *CurrentStack; /**< Points to one of the above stacks */
2957    /*@}*/
2958
2959    /** Combined modelview and projection matrix */
2960    GLmatrix _ModelProjectMatrix;
2961
2962    /** \name Display lists */
2963    struct gl_dlist_state ListState;
2964
2965    GLboolean ExecuteFlag;       /**< Execute GL commands? */
2966    GLboolean CompileFlag;       /**< Compile GL commands into display list? */
2967
2968    /** Extension information */
2969    struct gl_extensions Extensions;
2970
2971    /** \name State attribute stack (for glPush/PopAttrib) */
2972    /*@{*/
2973    GLuint AttribStackDepth;
2974    struct gl_attrib_node *AttribStack[MAX_ATTRIB_STACK_DEPTH];
2975    /*@}*/
2976
2977    /** \name Renderer attribute groups
2978     *
2979     * We define a struct for each attribute group to make pushing and popping
2980     * attributes easy.  Also it's a good organization.
2981     */
2982    /*@{*/
2983    struct gl_accum_attrib       Accum;          /**< Accum buffer attributes */
2984    struct gl_colorbuffer_attrib Color;          /**< Color buffer attributes */
2985    struct gl_current_attrib     Current;        /**< Current attributes */
2986    struct gl_depthbuffer_attrib Depth;          /**< Depth buffer attributes */
2987    struct gl_eval_attrib        Eval;           /**< Eval attributes */
2988    struct gl_fog_attrib         Fog;            /**< Fog attributes */
2989    struct gl_hint_attrib        Hint;           /**< Hint attributes */
2990    struct gl_light_attrib       Light;          /**< Light attributes */
2991    struct gl_line_attrib        Line;           /**< Line attributes */
2992    struct gl_list_attrib        List;           /**< List attributes */
2993    struct gl_multisample_attrib Multisample;
2994    struct gl_pixel_attrib       Pixel;          /**< Pixel attributes */
2995    struct gl_point_attrib       Point;          /**< Point attributes */
2996    struct gl_polygon_attrib     Polygon;        /**< Polygon attributes */
2997    GLuint PolygonStipple[32];                   /**< Polygon stipple */
2998    struct gl_scissor_attrib     Scissor;        /**< Scissor attributes */
2999    struct gl_stencil_attrib     Stencil;        /**< Stencil buffer attributes */
3000    struct gl_texture_attrib     Texture;        /**< Texture attributes */
3001    struct gl_transform_attrib   Transform;      /**< Transformation attributes */
3002    struct gl_viewport_attrib    Viewport;       /**< Viewport attributes */
3003    /*@}*/
3004
3005    /** \name Client attribute stack */
3006    /*@{*/
3007    GLuint ClientAttribStackDepth;
3008    struct gl_attrib_node *ClientAttribStack[MAX_CLIENT_ATTRIB_STACK_DEPTH];
3009    /*@}*/
3010
3011    /** \name Client attribute groups */
3012    /*@{*/
3013    struct gl_array_attrib       Array;  /**< Vertex arrays */
3014    struct gl_pixelstore_attrib  Pack;   /**< Pixel packing */
3015    struct gl_pixelstore_attrib  Unpack; /**< Pixel unpacking */
3016    struct gl_pixelstore_attrib  DefaultPacking; /**< Default params */
3017    /*@}*/
3018
3019    /** \name Other assorted state (not pushed/popped on attribute stack) */
3020    /*@{*/
3021    struct gl_pixelmaps          PixelMaps;
3022    struct gl_histogram_attrib   Histogram;
3023    struct gl_minmax_attrib      MinMax;
3024    struct gl_convolution_attrib Convolution1D;
3025    struct gl_convolution_attrib Convolution2D;
3026    struct gl_convolution_attrib Separable2D;
3027
3028    struct gl_evaluators EvalMap;   /**< All evaluators */
3029    struct gl_feedback   Feedback;  /**< Feedback */
3030    struct gl_selection  Select;    /**< Selection */
3031
3032    struct gl_color_table ColorTable[COLORTABLE_MAX];
3033    struct gl_color_table ProxyColorTable[COLORTABLE_MAX];
3034 #if 0
3035    struct gl_color_table PostConvolutionColorTable;
3036    struct gl_color_table ProxyPostConvolutionColorTable;
3037    struct gl_color_table PostColorMatrixColorTable;
3038    struct gl_color_table ProxyPostColorMatrixColorTable;
3039 #endif
3040
3041    struct gl_program_state Program;        /**< for vertex or fragment progs */
3042    struct gl_vertex_program_state VertexProgram;   /**< GL_ARB/NV_vertex_program */
3043    struct gl_fragment_program_state FragmentProgram;  /**< GL_ARB/NV_vertex_program */
3044    struct gl_ati_fragment_shader_state ATIFragmentShader;  /**< GL_ATI_fragment_shader */
3045
3046    struct gl_query_state Query;  /**< GL_ARB_occlusion_query */
3047
3048    struct gl_shader_state Shader; /**< GLSL shader object state */
3049    /*@}*/
3050
3051 #if FEATURE_EXT_framebuffer_object
3052    struct gl_renderbuffer *CurrentRenderbuffer;
3053 #endif
3054
3055    GLenum ErrorValue;        /**< Last error code */
3056    GLenum RenderMode;        /**< either GL_RENDER, GL_SELECT, GL_FEEDBACK */
3057    GLbitfield NewState;      /**< bitwise-or of _NEW_* flags */
3058
3059    /** \name Derived state */
3060    /*@{*/
3061    /** Bitwise-or of DD_* flags.  Note that this bitfield may be used before
3062     * state validation so they need to always be current.
3063     */
3064    GLbitfield _TriangleCaps;
3065    GLbitfield _ImageTransferState;/**< bitwise-or of IMAGE_*_BIT flags */
3066    GLfloat _EyeZDir[3];
3067    GLfloat _ModelViewInvScale;
3068    GLboolean _NeedEyeCoords;
3069    GLboolean _ForceEyeCoords;
3070    GLenum _CurrentProgram;    /* currently executing program */
3071
3072    GLuint TextureStateTimestamp; /* detect changes to shared state */
3073
3074    struct gl_shine_tab *_ShineTable[2]; /**< Active shine tables */
3075    struct gl_shine_tab *_ShineTabList;  /**< MRU list of inactive shine tables */
3076    /**@}*/
3077
3078    struct gl_list_extensions ListExt; /**< driver dlist extensions */
3079
3080    /** \name For debugging/development only */
3081    /*@{*/
3082    GLboolean FirstTimeCurrent;
3083    /*@}*/
3084
3085    /** Dither disable via MESA_NO_DITHER env var */
3086    GLboolean NoDither;
3087
3088    /** software compression/decompression supported or not */
3089    GLboolean Mesa_DXTn;
3090
3091    /** Core tnl module support */
3092    struct gl_tnl_module TnlModule;
3093
3094    /**
3095     * \name Hooks for module contexts.
3096     *
3097     * These will eventually live in the driver or elsewhere.
3098     */
3099    /*@{*/
3100    void *swrast_context;
3101    void *swsetup_context;
3102    void *swtnl_context;
3103    void *swtnl_im;
3104    void *acache_context;
3105    void *aelt_context;
3106    /*@}*/
3107 };
3108
3109
3110 /** The string names for GL_POINT, GL_LINE_LOOP, etc */
3111 extern const char *_mesa_prim_name[GL_POLYGON+4];
3112
3113
3114 #ifdef DEBUG
3115 extern int MESA_VERBOSE;
3116 extern int MESA_DEBUG_FLAGS;
3117 # define MESA_FUNCTION __FUNCTION__
3118 #else
3119 # define MESA_VERBOSE 0
3120 # define MESA_DEBUG_FLAGS 0
3121 # define MESA_FUNCTION "a function"
3122 # ifndef NDEBUG
3123 #  define NDEBUG
3124 # endif
3125 #endif
3126
3127
3128 enum _verbose
3129 {
3130    VERBOSE_VARRAY               = 0x0001,
3131    VERBOSE_TEXTURE              = 0x0002,
3132    VERBOSE_IMMEDIATE            = 0x0004,
3133    VERBOSE_PIPELINE             = 0x0008,
3134    VERBOSE_DRIVER               = 0x0010,
3135    VERBOSE_STATE                = 0x0020,
3136    VERBOSE_API                  = 0x0040,
3137    VERBOSE_DISPLAY_LIST         = 0x0100,
3138    VERBOSE_LIGHTING             = 0x0200,
3139    VERBOSE_PRIMS                = 0x0400,
3140    VERBOSE_VERTS                = 0x0800,
3141    VERBOSE_DISASSEM             = 0x1000,
3142    VERBOSE_GLSL                 = 0x2000,
3143    VERBOSE_GLSL_DUMP            = 0x4000
3144 };
3145
3146
3147 enum _debug
3148 {
3149    DEBUG_ALWAYS_FLUSH           = 0x1
3150 };
3151
3152
3153
3154 #define Elements(x) sizeof(x)/sizeof(*(x))
3155
3156
3157 #endif /* TYPES_H */