src/mesa/tnl/t_context.h

   1 /*
   2  * mesa 3-D graphics library
   3  * Version:  5.1
   4  *
   5  * Copyright (C) 1999-2003  Brian Paul   All Rights Reserved.
   6  *
   7  * Permission is hereby granted, free of charge, to any person obtaining a
   8  * copy of this software and associated documentation files (the "Software"),
   9  * to deal in the Software without restriction, including without limitation
  10  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
  11  * and/or sell copies of the Software, and to permit persons to whom the
  12  * Software is furnished to do so, subject to the following conditions:
  13  *
  14  * The above copyright notice and this permission notice shall be included
  15  * in all copies or substantial portions of the Software.
  16  *
  17  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
  18  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  19  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  20  * BRIAN PAUL BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
  21  * AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  22  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  23  */
  24
  25 /**
  26  * \file t_context.h
  27  * \brief TnL module datatypes and definitions.
  28  * \author Keith Whitwell
  29  */
  30
  31
  32 /**
  33  * \mainpage The TNL-module
  34  *
  35  * TNL stands for "transform and lighting", i.e. this module implements
  36  * a pipeline that receives as input a buffer of vertices and does all
  37  * necessary transformations (rotations, clipping, vertex shader etc.)
  38  * and passes then the output to the rasterizer.
  39  *
  40  * The tnl_pipeline contains the array of all stages, which should be
  41  * applied. Each stage is a black-box, which is described by an
  42  * tnl_pipeline_stage. The function ::_tnl_run_pipeline applies all the
  43  * stages to the vertex_buffer TNLcontext::vb, where the vertex data
  44  * is stored. The last stage in the pipeline is the rasterizer.
  45  *
  46  * The initial vertex_buffer data may either come from an ::immediate
  47  * structure or client vertex_arrays or display lists:
  48  *
  49  *
  50  * - The ::immediate structure records all the GL commands issued between
  51  * glBegin and glEnd.  \n
  52  * The structure accumulates data, until it is either full or it is
  53  * flushed (usually by a state change). Before starting then the pipeline,
  54  * the collected vertex data in ::immediate has to be pushed into
  55  * TNLcontext::vb.
  56  * This happens in ::_tnl_vb_bind_immediate. The pipeline is then run by
  57  * calling tnl_device_driver::RunPipeline = ::_tnl_run_pipeline, which
  58  * is stored in TNLcontext::Driver.   \n
  59  * An ::immediate does (for performance reasons) usually not finish with a
  60  * glEnd, and hence it also does not need to start with a glBegin.
  61  * This means that the last vertices of one ::immediate may need to be
  62  * saved for the next one.
  63  *
  64  *
  65  * - NOT SURE ABOUT THIS: The vertex_arrays structure is used to handle
  66  * glDrawArrays etc.  \n
  67  * Here, the data of the vertex_arrays is copied by ::_tnl_vb_bind_arrays
  68  * into TNLcontext::vb, so that the pipeline can be started.
  69  */
  70
  71
  72 #ifndef _T_CONTEXT_H
  73 #define _T_CONTEXT_H
  74
  75 #include "glheader.h"
  76 #include "mtypes.h"
  77
  78 #include "math/m_matrix.h"
  79 #include "math/m_vector.h"
  80 #include "math/m_xform.h"
  81
  82
  83 #define MAX_PIPELINE_STAGES     30
  84
  85
  86 /*
  87  * Note: The first attributes match the VERT_ATTRIB_* definitions
  88  * in mtypes.h.  However, the tnl module has additional attributes
  89  * for materials, color indexes, edge flags, etc.
  90  */
  91 /* Note: These are currently being used to define both inputs and
  92  * outputs from the tnl pipeline.  A better solution (which would also
  93  * releive the congestion to slightly prolong the life of the bitmask
  94  * below) is to have the fixed function pipeline populate a set of
  95  * arrays named after those produced by the vertex program stage, and
  96  * have the rest the mesa backend work on those.
  97  */
  98 enum {
  99         _TNL_ATTRIB_POS = 0,
 100         _TNL_ATTRIB_WEIGHT = 1,
 101         _TNL_ATTRIB_NORMAL = 2,
 102         _TNL_ATTRIB_COLOR0 = 3,
 103         _TNL_ATTRIB_COLOR1 = 4,
 104         _TNL_ATTRIB_FOG = 5,
 105         _TNL_ATTRIB_SIX = 6,
 106         _TNL_ATTRIB_SEVEN = 7,
 107         _TNL_ATTRIB_TEX0 = 8,
 108         _TNL_ATTRIB_TEX1 = 9,
 109         _TNL_ATTRIB_TEX2 = 10,
 110         _TNL_ATTRIB_TEX3 = 11,
 111         _TNL_ATTRIB_TEX4 = 12,
 112         _TNL_ATTRIB_TEX5 = 13,
 113         _TNL_ATTRIB_TEX6 = 14,
 114         _TNL_ATTRIB_TEX7 = 15,
 115         _TNL_ATTRIB_MAT_FRONT_AMBIENT = 16,
 116         _TNL_ATTRIB_MAT_BACK_AMBIENT = 17,
 117         _TNL_ATTRIB_MAT_FRONT_DIFFUSE = 18,
 118         _TNL_ATTRIB_MAT_BACK_DIFFUSE = 19,
 119         _TNL_ATTRIB_MAT_FRONT_SPECULAR = 20,
 120         _TNL_ATTRIB_MAT_BACK_SPECULAR = 21,
 121         _TNL_ATTRIB_MAT_FRONT_EMISSION = 22,
 122         _TNL_ATTRIB_MAT_BACK_EMISSION = 23,
 123         _TNL_ATTRIB_MAT_FRONT_SHININESS = 24,
 124         _TNL_ATTRIB_MAT_BACK_SHININESS = 25,
 125         _TNL_ATTRIB_MAT_FRONT_INDEXES = 26,
 126         _TNL_ATTRIB_MAT_BACK_INDEXES = 27,
 127         _TNL_ATTRIB_INDEX = 28,
 128         _TNL_ATTRIB_EDGEFLAG = 29,
 129         _TNL_ATTRIB_POINTSIZE = 30,
 130         _TNL_ATTRIB_MAX = 31
 131 } ;
 132
 133 /* Will probably have to revise this scheme fairly shortly, eg. by
 134  * compacting all the MAT flags down to one bit, or by using two
 135  * dwords to store the flags.
 136  */
 137 #define _TNL_BIT_POS                 (1<<0)
 138 #define _TNL_BIT_WEIGHT              (1<<1)
 139 #define _TNL_BIT_NORMAL              (1<<2)
 140 #define _TNL_BIT_COLOR0              (1<<3)
 141 #define _TNL_BIT_COLOR1              (1<<4)
 142 #define _TNL_BIT_FOG                 (1<<5)
 143 #define _TNL_BIT_SIX                 (1<<6)
 144 #define _TNL_BIT_SEVEN               (1<<7)
 145 #define _TNL_BIT_TEX0                (1<<8)
 146 #define _TNL_BIT_TEX1                (1<<9)
 147 #define _TNL_BIT_TEX2                (1<<10)
 148 #define _TNL_BIT_TEX3                (1<<11)
 149 #define _TNL_BIT_TEX4                (1<<12)
 150 #define _TNL_BIT_TEX5                (1<<13)
 151 #define _TNL_BIT_TEX6                (1<<14)
 152 #define _TNL_BIT_TEX7                (1<<15)
 153 #define _TNL_BIT_MAT_FRONT_AMBIENT   (1<<16)
 154 #define _TNL_BIT_MAT_BACK_AMBIENT    (1<<17)
 155 #define _TNL_BIT_MAT_FRONT_DIFFUSE   (1<<18)
 156 #define _TNL_BIT_MAT_BACK_DIFFUSE    (1<<19)
 157 #define _TNL_BIT_MAT_FRONT_SPECULAR  (1<<20)
 158 #define _TNL_BIT_MAT_BACK_SPECULAR   (1<<21)
 159 #define _TNL_BIT_MAT_FRONT_EMISSION  (1<<22)
 160 #define _TNL_BIT_MAT_BACK_EMISSION   (1<<23)
 161 #define _TNL_BIT_MAT_FRONT_SHININESS (1<<24)
 162 #define _TNL_BIT_MAT_BACK_SHININESS  (1<<25)
 163 #define _TNL_BIT_MAT_FRONT_INDEXES   (1<<26)
 164 #define _TNL_BIT_MAT_BACK_INDEXES    (1<<27)
 165 #define _TNL_BIT_INDEX               (1<<28)
 166 #define _TNL_BIT_EDGEFLAG            (1<<29)
 167 #define _TNL_BIT_POINTSIZE           (1<<30)
 168
 169 #define _TNL_BIT_TEX(u)  (1 << (_TNL_ATTRIB_TEX0 + (u)))
 170
 171
 172
 173 #define _TNL_BITS_MAT_ANY  (_TNL_BIT_MAT_FRONT_AMBIENT   |      \
 174                             _TNL_BIT_MAT_BACK_AMBIENT    |      \
 175                             _TNL_BIT_MAT_FRONT_DIFFUSE   |      \
 176                             _TNL_BIT_MAT_BACK_DIFFUSE    |      \
 177                             _TNL_BIT_MAT_FRONT_SPECULAR  |      \
 178                             _TNL_BIT_MAT_BACK_SPECULAR   |      \
 179                             _TNL_BIT_MAT_FRONT_EMISSION  |      \
 180                             _TNL_BIT_MAT_BACK_EMISSION   |      \
 181                             _TNL_BIT_MAT_FRONT_SHININESS |      \
 182                             _TNL_BIT_MAT_BACK_SHININESS  |      \
 183                             _TNL_BIT_MAT_FRONT_INDEXES   |      \
 184                             _TNL_BIT_MAT_BACK_INDEXES)
 185
 186
 187 #define _TNL_BITS_TEX_ANY  (_TNL_BIT_TEX0 |     \
 188                             _TNL_BIT_TEX1 |     \
 189                             _TNL_BIT_TEX2 |     \
 190                             _TNL_BIT_TEX3 |     \
 191                             _TNL_BIT_TEX4 |     \
 192                             _TNL_BIT_TEX5 |     \
 193                             _TNL_BIT_TEX6 |     \
 194                             _TNL_BIT_TEX7)
 195
 196
 197 #define _TNL_BITS_PROG_ANY   (_TNL_BIT_POS    |         \
 198                               _TNL_BIT_WEIGHT |         \
 199                               _TNL_BIT_NORMAL |         \
 200                               _TNL_BIT_COLOR0 |         \
 201                               _TNL_BIT_COLOR1 |         \
 202                               _TNL_BIT_FOG    |         \
 203                               _TNL_BIT_SIX    |         \
 204                               _TNL_BIT_SEVEN  |         \
 205                               _TNL_BITS_TEX_ANY)
 206
 207
 208
 209 #define PRIM_BEGIN     0x10
 210 #define PRIM_END       0x20
 211 #define PRIM_WEAK      0x40
 212 #define PRIM_MODE_MASK 0x0f
 213
 214 /*
 215  */
 216 struct tnl_prim {
 217    GLuint mode;
 218    GLuint start;
 219    GLuint count;
 220 };
 221
 222
 223
 224 struct tnl_eval1_map {
 225    struct gl_1d_map *map;
 226    GLuint sz;
 227 };
 228
 229 struct tnl_eval2_map {
 230    struct gl_2d_map *map;
 231    GLuint sz;
 232 };
 233
 234 struct tnl_eval {
 235    GLuint new_state;
 236    struct tnl_eval1_map map1[_TNL_ATTRIB_INDEX + 1];
 237    struct tnl_eval2_map map2[_TNL_ATTRIB_INDEX + 1];
 238 };
 239
 240
 241 #define TNL_MAX_PRIM 16
 242 #define TNL_MAX_COPIED_VERTS 3
 243
 244 struct tnl_copied_vtx {
 245    GLfloat buffer[_TNL_ATTRIB_MAX * 4 * TNL_MAX_COPIED_VERTS];
 246    GLuint nr;
 247 };
 248
 249 #define VERT_BUFFER_SIZE 2048   /* 8kbytes */
 250
 251
 252 typedef void (*attrfv_func)( const GLfloat * );
 253
 254 struct dynfn {
 255    struct dynfn *next, *prev;
 256    int key;
 257    char *code;
 258 };
 259
 260 struct dynfn_lists {
 261    struct dynfn Vertex[4];
 262    struct dynfn Attribute[4];
 263 };
 264
 265 struct dynfn_generators {
 266    struct dynfn *(*Vertex[4])( GLcontext *ctx, int key );
 267    struct dynfn *(*Attribute[4])( GLcontext *ctx, int key );
 268 };
 269
 270 #define _TNL_MAX_ATTR_CODEGEN 16
 271
 272
 273 /* The assembly of vertices in immediate mode is separated from
 274  * display list compilation.  This allows a simpler immediate mode
 275  * treatment and a display list compiler better suited to
 276  * hardware-acceleration.
 277  */
 278 struct tnl_vtx {
 279    GLfloat buffer[VERT_BUFFER_SIZE];
 280    GLubyte attrsz[_TNL_ATTRIB_MAX];
 281    GLuint vertex_size;
 282    struct tnl_prim prim[TNL_MAX_PRIM];
 283    GLuint prim_count;
 284    GLfloat *vbptr;                    /* cursor, points into buffer */
 285    GLfloat vertex[_TNL_ATTRIB_MAX*4]; /* current vertex */
 286    GLfloat *attrptr[_TNL_ATTRIB_MAX]; /* points into vertex */
 287    GLfloat *current[_TNL_ATTRIB_MAX]; /* points into ctx->Current, etc */
 288    GLuint counter, initial_counter;
 289    struct tnl_copied_vtx copied;
 290
 291    attrfv_func tabfv[_TNL_MAX_ATTR_CODEGEN+1][4]; /* plus 1 for ERROR_ATTRIB */
 292
 293    struct dynfn_lists cache;
 294    struct dynfn_generators gen;
 295
 296    struct tnl_eval eval;
 297    GLboolean *edgeflag_tmp;
 298    GLboolean have_materials;
 299 };
 300
 301
 302
 303
 304 /* For display lists, this structure holds a run of vertices of the
 305  * same format, and a strictly well-formed set of begin/end pairs,
 306  * starting on the first vertex and ending at the last.  Vertex
 307  * copying on buffer breaks is precomputed according to these
 308  * primitives, though there are situations where the copying will need
 309  * correction at execute-time, perhaps by replaying the list as
 310  * immediate mode commands.
 311  *
 312  * On executing this list, the 'current' values may be updated with
 313  * the values of the final vertex, and often no fixup of the start of
 314  * the vertex list is required.
 315  *
 316  * Eval and other commands that don't fit into these vertex lists are
 317  * compiled using the fallback opcode mechanism provided by dlist.c.
 318  */
 319 struct tnl_vertex_list {
 320    GLubyte attrsz[_TNL_ATTRIB_MAX];
 321    GLuint vertex_size;
 322
 323    GLfloat *buffer;
 324    GLuint count;
 325    GLuint wrap_count;           /* number of copied vertices at start */
 326    GLboolean have_materials;    /* bit of a hack - quick check for materials */
 327    GLboolean dangling_attr_ref; /* current attr implicitly referenced
 328                                    outside the list */
 329
 330    GLfloat *normal_lengths;
 331    struct tnl_prim *prim;
 332    GLuint prim_count;
 333
 334    struct tnl_vertex_store *vertex_store;
 335    struct tnl_primitive_store *prim_store;
 336 };
 337
 338 /* These buffers should be a reasonable size to support upload to
 339  * hardware?  Maybe drivers should stitch them back together, or
 340  * specify a desired size?
 341  */
 342 #define SAVE_BUFFER_SIZE (16*1024)
 343 #define SAVE_PRIM_SIZE   128
 344
 345 /* Storage to be shared among several vertex_lists.
 346  */
 347 struct tnl_vertex_store {
 348    GLfloat buffer[SAVE_BUFFER_SIZE];
 349    GLuint used;
 350    GLuint refcount;
 351 };
 352
 353 struct tnl_primitive_store {
 354    struct tnl_prim buffer[SAVE_PRIM_SIZE];
 355    GLuint used;
 356    GLuint refcount;
 357 };
 358
 359
 360 struct tnl_save {
 361    GLubyte attrsz[_TNL_ATTRIB_MAX];
 362    GLuint vertex_size;
 363
 364    GLfloat *buffer;
 365    GLuint count;
 366    GLuint wrap_count;
 367
 368    struct tnl_prim *prim;
 369    GLuint prim_count, prim_max;
 370
 371    struct tnl_vertex_store *vertex_store;
 372    struct tnl_primitive_store *prim_store;
 373
 374    GLfloat *vbptr;                 /* cursor, points into buffer */
 375    GLfloat vertex[_TNL_ATTRIB_MAX*4];      /* current values */
 376    GLfloat *attrptr[_TNL_ATTRIB_MAX];
 377    GLuint counter, initial_counter;
 378    GLboolean dangling_attr_ref;
 379    GLboolean have_materials;
 380
 381    GLuint opcode_vertex_list;
 382
 383    struct tnl_copied_vtx copied;
 384
 385    GLfloat *current[_TNL_ATTRIB_MAX]; /* points into ctx->ListState */
 386    GLubyte *currentsz[_TNL_ATTRIB_MAX];
 387
 388    void (*tabfv[_TNL_ATTRIB_MAX][4])( const GLfloat * );
 389 };
 390
 391
 392 struct tnl_vertex_arrays
 393 {
 394    /* Conventional vertex attribute arrays */
 395    GLvector4f  Obj;
 396    GLvector4f  Normal;
 397    GLvector4f  Color;
 398    GLvector4f  SecondaryColor;
 399    GLvector4f  FogCoord;
 400    GLvector4f  TexCoord[MAX_TEXTURE_COORD_UNITS];
 401    GLvector4f  Index;
 402
 403    GLubyte     *EdgeFlag;
 404    GLuint      *Elt;
 405
 406    /* These attributes don't alias with the conventional attributes.
 407     * The GL_NV_vertex_program extension defines 16 extra sets of vertex
 408     * arrays which have precedent over the conventional arrays when enabled.
 409     */
 410    GLvector4f  Attribs[_TNL_ATTRIB_MAX];
 411 };
 412
 413
 414 /**
 415  * Contains the current state of a running pipeline.
 416  */
 417 struct vertex_buffer
 418 {
 419    /* Constant over life of the vertex_buffer.
 420     */
 421    GLuint      Size;
 422
 423    /* Constant over the pipeline.
 424     */
 425    GLuint      Count;                         /* for everything except Elts */
 426
 427    /* Pointers to current data.
 428     */
 429    GLuint      *Elts;
 430    GLvector4f  *ObjPtr;                         /* _TNL_BIT_POS */
 431    GLvector4f  *EyePtr;                         /* _TNL_BIT_POS */
 432    GLvector4f  *ClipPtr;                        /* _TNL_BIT_POS */
 433    GLvector4f  *NdcPtr;                         /* _TNL_BIT_POS */
 434    GLubyte     ClipOrMask;                      /* _TNL_BIT_POS */
 435    GLubyte     *ClipMask;                       /* _TNL_BIT_POS */
 436    GLvector4f  *NormalPtr;                      /* _TNL_BIT_NORMAL */
 437    GLfloat     *NormalLengthPtr;                /* _TNL_BIT_NORMAL */
 438    GLboolean   *EdgeFlag;                       /* _TNL_BIT_EDGEFLAG */
 439    GLvector4f  *TexCoordPtr[MAX_TEXTURE_COORD_UNITS]; /* VERT_TEX_0..n */
 440    GLvector4f  *IndexPtr[2];                    /* _TNL_BIT_INDEX */
 441    GLvector4f  *ColorPtr[2];                    /* _TNL_BIT_COLOR0 */
 442    GLvector4f  *SecondaryColorPtr[2];           /* _TNL_BIT_COLOR1 */
 443    GLvector4f  *PointSizePtr;                   /* _TNL_BIT_POS */
 444    GLvector4f  *FogCoordPtr;                    /* _TNL_BIT_FOG */
 445
 446    struct tnl_prim  *Primitive;
 447    GLuint      PrimitiveCount;
 448
 449    /* Inputs to the vertex program stage */
 450    GLvector4f *AttribPtr[_TNL_ATTRIB_MAX];      /* GL_NV_vertex_program */
 451
 452    GLuint LastClipped;
 453    /* Private data from _tnl_render_stage that has no business being
 454     * in this struct.
 455     */
 456 };
 457
 458
 459 /** Describes an individual operation on the pipeline.
 460  */
 461 struct tnl_pipeline_stage
 462 {
 463    const char *name;
 464    GLuint check_state;          /* All state referenced in check() --
 465                                  * When is the pipeline_stage struct
 466                                  * itself invalidated?  Must be
 467                                  * constant.
 468                                  */
 469
 470    /* Usually constant or set by the 'check' callback:
 471     */
 472    GLuint run_state;            /* All state referenced in run() --
 473                                  * When is the cached output of the
 474                                  * stage invalidated?
 475                                  */
 476
 477    GLboolean active;            /* True if runnable in current state */
 478    GLuint inputs;               /* VERT_* inputs to the stage */
 479    GLuint outputs;              /* VERT_* outputs of the stage */
 480
 481    /* Set in _tnl_run_pipeline():
 482     */
 483    GLuint changed_inputs;       /* Generated value -- inputs to the
 484                                  * stage that have changed since last
 485                                  * call to 'run'.
 486                                  */
 487
 488
 489    /* Private data for the pipeline stage:
 490     */
 491    void *privatePtr;
 492
 493    /* Free private data.  May not be null.
 494     */
 495    void (*destroy)( struct tnl_pipeline_stage * );
 496
 497    /* Called from _tnl_validate_pipeline().  Must update all fields in
 498     * the pipeline_stage struct for the current state.
 499     */
 500    void (*check)( GLcontext *ctx, struct tnl_pipeline_stage * );
 501
 502    /* Called from _tnl_run_pipeline().  The stage.changed_inputs value
 503     * encodes all inputs to thee struct which have changed.  If
 504     * non-zero, recompute all affected outputs of the stage, otherwise
 505     * execute any 'sideeffects' of the stage.
 506     *
 507     * Return value: GL_TRUE - keep going
 508     *               GL_FALSE - finished pipeline
 509     */
 510    GLboolean (*run)( GLcontext *ctx, struct tnl_pipeline_stage * );
 511 };
 512
 513 /** Contains the array of all pipeline stages.
 514  * The default values are defined at the end of t_pipeline.c */
 515 struct tnl_pipeline {
 516    GLuint build_state_trigger;    /**< state changes which require build */
 517    GLuint build_state_changes;    /**< state changes since last build */
 518    GLuint run_state_changes;      /**< state changes since last run */
 519    GLuint run_input_changes;      /**< VERT_* changes since last run */
 520    GLuint inputs;                 /**< VERT_* inputs to pipeline */
 521    /** This array has to end with a NULL-pointer. */
 522    struct tnl_pipeline_stage stages[MAX_PIPELINE_STAGES+1];
 523    GLuint nr_stages;
 524 };
 525
 526 struct tnl_clipspace_attr;
 527
 528 typedef void (*extract_func)( const struct tnl_clipspace_attr *a, GLfloat *out,
 529                               const GLubyte *v );
 530
 531 typedef void (*insert_func)( const struct tnl_clipspace_attr *a, GLubyte *v,
 532                              const GLfloat *in );
 533
 534
 535 /**
 536  * Describes how to convert/move a vertex attribute from a vertex array
 537  * to a vertex structure.
 538  */
 539 struct tnl_clipspace_attr
 540 {
 541    GLuint attrib;          /* which vertex attrib (0=position, etc) */
 542    GLuint vertoffset;      /* position of the attrib in the vertex struct */
 543    GLuint vertattrsize;    /* size of the attribute in bytes */
 544    GLubyte *inputptr;
 545    GLuint inputstride;
 546    insert_func *insert;
 547    insert_func emit;
 548    extract_func extract;
 549    const GLfloat *vp;   /* NDC->Viewport mapping matrix */
 550 };
 551
 552
 553
 554 typedef void (*points_func)( GLcontext *ctx, GLuint first, GLuint last );
 555 typedef void (*line_func)( GLcontext *ctx, GLuint v1, GLuint v2 );
 556 typedef void (*triangle_func)( GLcontext *ctx,
 557                                GLuint v1, GLuint v2, GLuint v3 );
 558 typedef void (*quad_func)( GLcontext *ctx, GLuint v1, GLuint v2,
 559                            GLuint v3, GLuint v4 );
 560 typedef void (*render_func)( GLcontext *ctx, GLuint start, GLuint count,
 561                              GLuint flags );
 562 typedef void (*interp_func)( GLcontext *ctx,
 563                              GLfloat t, GLuint dst, GLuint out, GLuint in,
 564                              GLboolean force_boundary );
 565 typedef void (*copy_pv_func)( GLcontext *ctx, GLuint dst, GLuint src );
 566 typedef void (*setup_func)( GLcontext *ctx,
 567                             GLuint start, GLuint end,
 568                             GLuint new_inputs);
 569
 570
 571 /**
 572  * Used to describe conversion of vertex arrays to vertex structures.
 573  * I.e. Structure of arrays to arrays of structs.
 574  */
 575 struct tnl_clipspace
 576 {
 577    GLboolean need_extras;
 578
 579    GLuint new_inputs;
 580
 581    GLubyte *vertex_buf;
 582    GLuint vertex_size;
 583    GLuint max_vertex_size;
 584
 585    struct tnl_clipspace_attr attr[_TNL_ATTRIB_MAX];
 586    GLuint attr_count;
 587
 588    void (*emit)( GLcontext *ctx, GLuint start, GLuint end, void *dest );
 589    interp_func interp;
 590    copy_pv_func copy_pv;
 591 };
 592
 593
 594 struct tnl_device_driver
 595 {
 596    /***
 597     *** TNL Pipeline
 598     ***/
 599
 600    void (*RunPipeline)(GLcontext *ctx);
 601    /* Replaces PipelineStart/PipelineFinish -- intended to allow
 602     * drivers to wrap _tnl_run_pipeline() with code to validate state
 603     * and grab/release hardware locks.
 604     */
 605
 606    void (*NotifyMaterialChange)(GLcontext *ctx);
 607    /* Alert tnl-aware drivers of changes to material.
 608     */
 609
 610    GLboolean (*NotifyBegin)(GLcontext *ctx, GLenum p);
 611    /* Allow drivers to hook in optimized begin/end engines.
 612     * Return value:  GL_TRUE - driver handled the begin
 613     *                GL_FALSE - driver didn't handle the begin
 614     */
 615
 616    /***
 617     *** Rendering -- These functions called only from t_vb_render.c
 618     ***/
 619    struct
 620    {
 621       void (*Start)(GLcontext *ctx);
 622       void (*Finish)(GLcontext *ctx);
 623       /* Called before and after all rendering operations, including DrawPixels,
 624        * ReadPixels, Bitmap, span functions, and CopyTexImage, etc commands.
 625        * These are a suitable place for grabbing/releasing hardware locks.
 626        */
 627
 628       void (*PrimitiveNotify)(GLcontext *ctx, GLenum mode);
 629       /* Called between RenderStart() and RenderFinish() to indicate the
 630        * type of primitive we're about to draw.  Mode will be one of the
 631        * modes accepted by glBegin().
 632        */
 633
 634       interp_func Interp;
 635       /* The interp function is called by the clipping routines when we need
 636        * to generate an interpolated vertex.  All pertinant vertex ancilliary
 637        * data should be computed by interpolating between the 'in' and 'out'
 638        * vertices.
 639        */
 640
 641       copy_pv_func CopyPV;
 642       /* The copy function is used to make a copy of a vertex.  All pertinant
 643        * vertex attributes should be copied.
 644        */
 645
 646       void (*ClippedPolygon)( GLcontext *ctx, const GLuint *elts, GLuint n );
 647       /* Render a polygon with <n> vertices whose indexes are in the <elts>
 648        * array.
 649        */
 650
 651       void (*ClippedLine)( GLcontext *ctx, GLuint v0, GLuint v1 );
 652       /* Render a line between the two vertices given by indexes v0 and v1. */
 653
 654       points_func           Points; /* must now respect vb->elts */
 655       line_func             Line;
 656       triangle_func         Triangle;
 657       quad_func             Quad;
 658       /* These functions are called in order to render points, lines,
 659        * triangles and quads.  These are only called via the T&L module.
 660        */
 661
 662       render_func          *PrimTabVerts;
 663       render_func          *PrimTabElts;
 664       /* Render whole unclipped primitives (points, lines, linestrips,
 665        * lineloops, etc).  The tables are indexed by the GL enum of the
 666        * primitive to be rendered.  RenderTabVerts is used for non-indexed
 667        * arrays of vertices.  RenderTabElts is used for indexed arrays of
 668        * vertices.
 669        */
 670
 671       void (*ResetLineStipple)( GLcontext *ctx );
 672       /* Reset the hardware's line stipple counter.
 673        */
 674
 675       setup_func BuildVertices;
 676       /* This function is called whenever new vertices are required for
 677        * rendering.  The vertices in question are those n such that start
 678        * <= n < end.  The new_inputs parameter indicates those fields of
 679        * the vertex which need to be updated, if only a partial repair of
 680        * the vertex is required.
 681        *
 682        * This function is called only from _tnl_render_stage in tnl/t_render.c.
 683        */
 684
 685
 686       GLboolean (*Multipass)( GLcontext *ctx, GLuint passno );
 687       /* Driver may request additional render passes by returning GL_TRUE
 688        * when this function is called.  This function will be called
 689        * after the first pass, and passes will be made until the function
 690        * returns GL_FALSE.  If no function is registered, only one pass
 691        * is made.
 692        *
 693        * This function will be first invoked with passno == 1.
 694        */
 695    } Render;
 696 };
 697
 698
 699 /**
 700  * Context state for T&L context.
 701  */
 702 typedef struct
 703 {
 704    /* Driver interface.
 705     */
 706    struct tnl_device_driver Driver;
 707
 708    /* Execute:
 709     */
 710    struct tnl_vtx vtx;
 711
 712    /* Compile:
 713     */
 714    struct tnl_save save;
 715
 716    /* Pipeline
 717     */
 718    struct tnl_pipeline pipeline;
 719    struct vertex_buffer vb;
 720
 721    /* GLvectors for binding to vb:
 722     */
 723    struct tnl_vertex_arrays vtx_inputs;
 724    struct tnl_vertex_arrays save_inputs;
 725    struct tnl_vertex_arrays current;
 726    struct tnl_vertex_arrays array_inputs;
 727
 728    /* Clipspace/ndc/window vertex managment:
 729     */
 730    struct tnl_clipspace clipspace;
 731
 732    /* Probably need a better configuration mechanism:
 733     */
 734    GLboolean NeedNdcCoords;
 735    GLboolean LoopbackDListCassettes;
 736    GLboolean CalcDListNormalLengths;
 737    GLboolean IsolateMaterials;
 738    GLboolean AllowVertexFog;
 739    GLboolean AllowPixelFog;
 740    GLboolean AllowCodegen;
 741
 742    GLboolean _DoVertexFog;  /* eval fog function at each vertex? */
 743
 744    GLuint render_inputs;
 745
 746    GLvertexformat exec_vtxfmt;
 747    GLvertexformat save_vtxfmt;
 748
 749 } TNLcontext;
 750
 751
 752
 753 #define TNL_CONTEXT(ctx) ((TNLcontext *)(ctx->swtnl_context))
 754
 755
 756 #define TYPE_IDX(t) ((t) & 0xf)
 757 #define MAX_TYPES TYPE_IDX(GL_DOUBLE)+1      /* 0xa + 1 */
 758
 759 extern void _tnl_MakeCurrent( GLcontext *ctx,
 760                               GLframebuffer *drawBuffer,
 761                               GLframebuffer *readBuffer );
 762
 763
 764
 765
 766 #endif