src/mesa/tnl/t_context.h

   1 /* $Id: t_context.h,v 1.10 2001/01/13 05:48:26 keithw Exp $ */
   2
   3 /*
   4  * Mesa 3-D graphics library
   5  * Version:  3.5
   6  *
   7  * Copyright (C) 1999  Brian Paul   All Rights Reserved.
   8  *
   9  * Permission is hereby granted, free of charge, to any person obtaining a
  10  * copy of this software and associated documentation files (the "Software"),
  11  * to deal in the Software without restriction, including without limitation
  12  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
  13  * and/or sell copies of the Software, and to permit persons to whom the
  14  * Software is furnished to do so, subject to the following conditions:
  15  *
  16  * The above copyright notice and this permission notice shall be included
  17  * in all copies or substantial portions of the Software.
  18  *
  19  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
  20  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  21  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  22  * BRIAN PAUL BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
  23  * AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  24  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  25  *
  26  * Author:
  27  *    Keith Whitwell <keithw@valinux.com>
  28  */
  29
  30 #ifndef _T_CONTEXT_H
  31 #define _T_CONTEXT_H
  32
  33 #include "glheader.h"
  34 #include "mtypes.h"
  35
  36 #include "math/m_matrix.h"
  37 #include "math/m_vector.h"
  38 #include "math/m_xform.h"
  39
  40
  41 #define MAX_PIPELINE_STAGES     30
  42
  43
  44 /* Numbers for sizing immediate structs.
  45  */
  46 #define IMM_MAX_COPIED_VERTS  3
  47 #define IMM_MAXDATA          (216 + IMM_MAX_COPIED_VERTS)
  48 #define IMM_SIZE             (IMM_MAXDATA + MAX_CLIPPED_VERTICES)
  49
  50
  51 /* Values for IM->BeginState
  52  */
  53 #define VERT_BEGIN_0    0x1        /* glBegin (if initially inside beg/end) */
  54 #define VERT_BEGIN_1    0x2        /* glBegin (if initially outside beg/end) */
  55 #define VERT_ERROR_0    0x4        /* invalid_operation in initial state 0 */
  56 #define VERT_ERROR_1    0x8        /* invalid_operation in initial state 1 */
  57
  58
  59 /* Flags to be added to the primitive enum in VB->Primitive.
  60  */
  61 #define PRIM_MODE_MASK  0xff    /* Extract the actual primitive */
  62 #define PRIM_BEGIN      0x100   /* The prim starts here (not wrapped) */
  63 #define PRIM_END        0x200   /* The prim ends in this VB (does not wrap) */
  64 #define PRIM_PARITY     0x400   /* The prim wrapped on an odd number of verts */
  65 #define PRIM_LAST       0x800   /* No more prims in the VB */
  66
  67
  68 /* Flags that describe the inputs and outputs of pipeline stages, and
  69  * the contents of a vertex-cassette.
  70  *
  71  * 5 spare flags, rearrangement of eval flags can secure at least 3
  72  * more.
  73  */
  74 #define VERT_OBJ             _NEW_ARRAY_VERTEX
  75 #define VERT_RGBA            _NEW_ARRAY_COLOR
  76 #define VERT_NORM            _NEW_ARRAY_NORMAL
  77 #define VERT_INDEX           _NEW_ARRAY_INDEX
  78 #define VERT_EDGE            _NEW_ARRAY_EDGEFLAG
  79 #define VERT_SPEC_RGB        _NEW_ARRAY_SECONDARYCOLOR
  80 #define VERT_FOG_COORD       _NEW_ARRAY_FOGCOORD
  81 #define VERT_TEX0            _NEW_ARRAY_TEXCOORD_0
  82 #define VERT_TEX1            _NEW_ARRAY_TEXCOORD_1
  83 #define VERT_TEX2            _NEW_ARRAY_TEXCOORD_2
  84 #define VERT_TEX3            _NEW_ARRAY_TEXCOORD_3
  85 #define VERT_TEX4            _NEW_ARRAY_TEXCOORD_4
  86 #define VERT_TEX5            _NEW_ARRAY_TEXCOORD_5
  87 #define VERT_TEX6            _NEW_ARRAY_TEXCOORD_6
  88 #define VERT_TEX7            _NEW_ARRAY_TEXCOORD_7
  89 #define VERT_EVAL_C1         0x8000     /* imm only */
  90 #define VERT_EVAL_C2         0x10000    /* imm only */
  91 #define VERT_EVAL_P1         0x20000    /* imm only */
  92 #define VERT_EVAL_P2         0x40000    /* imm only */
  93 #define VERT_OBJ_3           0x80000    /* imm only */
  94 #define VERT_OBJ_4           0x100000   /* imm only */
  95 #define VERT_MATERIAL        0x200000   /* imm only, but tested in vb code */
  96 #define VERT_ELT             0x400000   /* imm only */
  97 #define VERT_BEGIN           0x800000   /* imm only, but tested in vb code */
  98 #define VERT_END             0x1000000  /* imm only, but tested in vb code */
  99 #define VERT_END_VB          0x2000000  /* imm only, but tested in vb code */
 100 #define VERT_POINT_SIZE      0x4000000  /* vb only, could reuse a bit */
 101 #define VERT_EYE             VERT_BEGIN /* vb only, reuse imm bit */
 102 #define VERT_CLIP            VERT_END   /* vb only, reuse imm bit*/
 103
 104
 105 /* Flags for IM->TexCoordSize.  Enough flags for 16 units.
 106  */
 107 #define TEX_0_SIZE_3          0x1
 108 #define TEX_0_SIZE_4          0x1000
 109 #define TEX_SIZE_3(unit)      (TEX_0_SIZE_3<<unit)
 110 #define TEX_SIZE_4(unit)      (TEX_0_SIZE_4<<unit)
 111
 112
 113 /* Shorthands.
 114  */
 115 #define VERT_EVAL_ANY      (VERT_EVAL_C1|VERT_EVAL_P1|  \
 116                             VERT_EVAL_C2|VERT_EVAL_P2)
 117
 118 #define VERT_OBJ_23       (VERT_OBJ_3|VERT_OBJ)
 119 #define VERT_OBJ_234      (VERT_OBJ_4|VERT_OBJ_23)
 120
 121 #define VERT_TEX0_SHIFT 11
 122
 123 #define VERT_TEX(i)        (VERT_TEX0 << i)
 124
 125 #define VERT_TEX_ANY       (VERT_TEX0 |         \
 126                             VERT_TEX1 |         \
 127                             VERT_TEX2 |         \
 128                             VERT_TEX3 |         \
 129                             VERT_TEX4 |         \
 130                             VERT_TEX5 |         \
 131                             VERT_TEX6 |         \
 132                             VERT_TEX7)
 133
 134 #define VERT_FIXUP        (VERT_TEX_ANY |       \
 135                            VERT_RGBA |          \
 136                            VERT_SPEC_RGB |      \
 137                            VERT_FOG_COORD |     \
 138                            VERT_INDEX |         \
 139                            VERT_EDGE |          \
 140                            VERT_NORM)
 141
 142 #define VERT_CURRENT_DATA  (VERT_FIXUP |        \
 143                             VERT_MATERIAL)
 144
 145 #define VERT_DATA          (VERT_TEX_ANY |      \
 146                             VERT_RGBA |         \
 147                             VERT_SPEC_RGB |     \
 148                             VERT_FOG_COORD |    \
 149                             VERT_INDEX |        \
 150                             VERT_EDGE |         \
 151                             VERT_NORM |         \
 152                             VERT_OBJ |  \
 153                             VERT_MATERIAL |     \
 154                             VERT_ELT |          \
 155                             VERT_EVAL_ANY)
 156
 157
 158 /* KW: Represents everything that can take place between a begin and
 159  * end, and can represent multiple begin/end pairs.  Can be used to
 160  * losslessly encode this information in display lists.
 161  */
 162 struct immediate
 163 {
 164    struct __GLcontextRec *backref;
 165    GLuint id, ref_count;
 166
 167    /* This must be saved when immediates are shared in display lists.
 168     */
 169    GLuint CopyStart, Start, Count;
 170    GLuint LastData;             /* count or count+1 */
 171    GLuint AndFlag, OrFlag;
 172    GLuint TexSize;              /* keep track of texcoord sizes */
 173    GLuint BeginState, SavedBeginState;
 174    GLuint LastPrimitive;
 175
 176    GLuint ArrayEltFlags;        /* precalc'ed for glArrayElt */
 177    GLuint ArrayEltIncr;
 178    GLuint ArrayEltFlush;
 179    GLuint FlushElt;
 180
 181    GLuint MaxTextureUnits;      /* precalc'ed for glMultiTexCoordARB */
 182
 183    /* Temporary values created when vertices are copied into the
 184     * first 3 slots of the struct:
 185     */
 186    GLuint CopyOrFlag;
 187    GLuint CopyAndFlag;
 188    GLuint CopyTexSize;
 189
 190
 191    /* allocate storage for these on demand:
 192     */
 193    struct gl_material (*Material)[2];
 194    GLuint *MaterialMask;
 195    GLfloat *NormalLengths;
 196    GLfloat (*TexCoord[MAX_TEXTURE_UNITS])[4];
 197
 198    GLuint  Primitive[IMM_SIZE];     /* BEGIN/END */
 199    GLuint  PrimitiveLength[IMM_SIZE]; /* BEGIN/END */
 200    GLuint  Flag[IMM_SIZE];          /* VERT_* flags */
 201    GLchan  Color[IMM_SIZE][4];
 202    GLfloat Obj[IMM_SIZE][4];
 203    GLfloat Normal[IMM_SIZE][3];
 204    GLfloat TexCoord0[IMM_SIZE][4];  /* just VERT_TEX0 */
 205    GLuint  Elt[IMM_SIZE];
 206    GLubyte EdgeFlag[IMM_SIZE];
 207    GLuint  Index[IMM_SIZE];
 208    GLubyte SecondaryColor[IMM_SIZE][4];
 209    GLfloat FogCoord[IMM_SIZE];
 210 };
 211
 212
 213 struct vertex_arrays
 214 {
 215    GLvector4f  Obj;
 216    GLvector3f  Normal;
 217    GLvector4ub Color;
 218    GLvector1ui Index;
 219    GLvector1ub EdgeFlag;
 220    GLvector4f  TexCoord[MAX_TEXTURE_UNITS];
 221    GLvector1ui Elt;
 222    GLvector4ub SecondaryColor;
 223    GLvector1f  FogCoord;
 224 };
 225
 226
 227 typedef struct gl_material GLmaterial;
 228
 229 typedef void (*interp_func)( GLcontext *ctx,
 230                              GLfloat t, GLuint dst, GLuint in, GLuint out,
 231                              GLboolean force_boundary );
 232
 233 typedef void (*copy_pv_func)( GLcontext *ctx, GLuint dst, GLuint src );
 234
 235 /* Contains the current state of a running pipeline.
 236  */
 237 typedef struct vertex_buffer
 238 {
 239    /* Constant over life of the vertex_buffer.
 240     */
 241    GLuint Size;
 242
 243    /* Constant over the pipeline.
 244     */
 245    GLuint     Count;                            /* for everything except Elts */
 246    GLuint     FirstClipped;                     /* temp verts for clipping */
 247    GLuint     FirstPrimitive;                   /* usually zero */
 248
 249    /* Pointers to current data.
 250     */
 251    GLuint      *Elts;                           /* VERT_ELT */
 252    GLvector4f  *ObjPtr;                         /* VERT_OBJ */
 253    GLvector4f  *EyePtr;                         /* VERT_EYE */
 254    GLvector4f  *ClipPtr;                        /* VERT_CLIP */
 255    GLvector4f  *ProjectedClipPtr;               /* VERT_CLIP (2) */
 256    GLubyte     ClipOrMask;                      /* VERT_CLIP (3) */
 257    GLubyte     *ClipMask;                       /* VERT_CLIP (4) */
 258    GLvector3f  *NormalPtr;                      /* VERT_NORM */
 259    GLfloat     *NormalLengthPtr;                /* VERT_NORM (optional) */
 260    GLboolean   *EdgeFlag;                       /* VERT_EDGE */
 261    GLvector4f  *TexCoordPtr[MAX_TEXTURE_UNITS]; /* VERT_TEX_0..n */
 262    GLvector1ui *IndexPtr[2];                    /* VERT_INDEX */
 263    GLvector4ub *ColorPtr[2];                    /* VERT_RGBA */
 264    GLvector4ub *SecondaryColorPtr[2];           /* VERT_SPEC_RGB */
 265    GLvector1f  *FogCoordPtr;                    /* VERT_FOG_COORD */
 266    GLvector1f  *PointSizePtr;                   /* VERT_POINT_SIZE */
 267    GLmaterial (*Material)[2];                   /* VERT_MATERIAL, optional */
 268    GLuint      *MaterialMask;                   /* VERT_MATERIAL, optional */
 269    GLuint      *Flag;                           /* VERT_* flags, optional */
 270    GLuint      *Primitive;                      /* GL_(mode)|PRIM_* flags */
 271    GLuint      *PrimitiveLength;                /* integers */
 272
 273
 274    GLuint importable_data;
 275    void (*import_data)( GLcontext *ctx, GLuint flags, GLuint vecflags );
 276    /* Callback to the provider of the untransformed input for the
 277     * render stage (or other stages) to call if they need to write into
 278     * write-protected arrays, or fixup the stride on input arrays.
 279     *
 280     * This is currently only necessary for client arrays that make it
 281     * as far down the pipeline as the render stage.
 282     */
 283
 284    GLuint LastClipped;
 285    interp_func interpfunc;
 286    copy_pv_func copypvfunc;
 287    /* Private data from _tnl_render_stage that has no business being
 288     * in this struct.
 289     */
 290
 291 } TNLvertexbuffer;
 292
 293
 294
 295 /* Describes an individual operation on the pipeline.
 296  */
 297 struct gl_pipeline_stage {
 298    const char *name;
 299    GLuint check_state;          /* All state referenced in check() --
 300                                  * When is the pipeline_stage struct
 301                                  * itself invalidated?  Must be
 302                                  * constant.
 303                                  */
 304
 305    /* Usually constant or set by the 'check' callback:
 306     */
 307    GLuint run_state;            /* All state referenced in run() --
 308                                  * When is the cached output of the
 309                                  * stage invalidated?
 310                                  */
 311
 312    GLboolean active;            /* True if runnable in current state */
 313    GLuint inputs;               /* VERT_* inputs to the stage */
 314    GLuint outputs;              /* VERT_* outputs of the stage */
 315
 316    /* Set in _tnl_run_pipeline():
 317     */
 318    GLuint changed_inputs;       /* Generated value -- inputs to the
 319                                  * stage that have changed since last
 320                                  * call to 'run'.
 321                                  */
 322
 323    /* Private data for the pipeline stage:
 324     */
 325    void *private;
 326
 327    /* Free private data.  May not be null.
 328     */
 329    void (*destroy)( struct gl_pipeline_stage * );
 330
 331    /* Called from _tnl_validate_pipeline().  Must update all fields in
 332     * the pipeline_stage struct for the current state.
 333     */
 334    void (*check)( GLcontext *ctx, struct gl_pipeline_stage * );
 335
 336    /* Called from _tnl_run_pipeline().  The stage.changed_inputs value
 337     * encodes all inputs to thee struct which have changed.  If
 338     * non-zero, recompute all affected outputs of the stage, otherwise
 339     * execute any 'sideeffects' of the stage.
 340     *
 341     * Return value: GL_TRUE - keep going
 342     *               GL_FALSE - finished pipeline
 343     */
 344    GLboolean (*run)( GLcontext *ctx, struct gl_pipeline_stage * );
 345 };
 346
 347
 348 struct gl_pipeline {
 349    GLuint build_state_trigger;    /* state changes which require build */
 350    GLuint build_state_changes;    /* state changes since last build */
 351    GLuint run_state_changes;      /* state changes since last run */
 352    GLuint run_input_changes;      /* VERT_* changes since last run */
 353    GLuint inputs;                 /* VERT_* inputs to pipeline */
 354    struct gl_pipeline_stage stages[MAX_PIPELINE_STAGES];
 355    GLuint nr_stages;
 356 };
 357
 358
 359 struct tnl_eval_store {
 360    GLuint EvalMap1Flags;
 361    GLuint EvalMap2Flags;
 362    GLuint EvalNewState;
 363
 364    GLfloat Coord[IMM_SIZE][4];
 365    GLfloat Obj[IMM_SIZE][4];
 366    GLfloat TexCoord[IMM_SIZE][4];
 367    GLfloat Normal[IMM_SIZE][3];
 368    GLchan  Color[IMM_SIZE][4];
 369    GLuint  Index[IMM_SIZE];
 370    GLuint  Flag[IMM_SIZE];
 371    GLuint  Elts[IMM_SIZE];
 372 };
 373
 374 typedef struct {
 375
 376    /* Track whether the module is active.
 377     */
 378    GLboolean bound_exec;
 379
 380    /* Display list extensions
 381     */
 382    GLuint opcode_vertex_cassette;
 383
 384    /* Pipeline
 385     */
 386    struct gl_pipeline pipeline;
 387    struct vertex_buffer vb;
 388
 389    /* GLvectors for binding to vb:
 390     */
 391    struct vertex_arrays imm_inputs;
 392    struct vertex_arrays array_inputs;
 393    GLuint *tmp_primitive;
 394    GLuint *tmp_primitive_length;
 395
 396    /* Set when executing an internally generated immediate.
 397     */
 398    GLboolean ReplayHardBeginEnd;
 399    GLenum CurrentPrimitive;
 400
 401    /* Note which vertices need copying over succesive immediates.
 402     * Will add save versions to precompute vertex copying where
 403     * possible.
 404     */
 405    struct immediate *ExecCopySource;
 406    GLuint ExecCopyCount;
 407    GLuint ExecCopyElts[IMM_MAX_COPIED_VERTS];
 408    GLuint ExecCopyTexSize;
 409    GLuint ExecParity;
 410
 411    GLuint DlistPrimitive;
 412    GLuint DlistPrimitiveLength;
 413    GLuint DlistLastPrimitive;
 414
 415    /* Probably need a better configuration mechanism:
 416     */
 417    GLboolean NeedProjCoords;
 418
 419    /* Derived state and storage for _tnl_eval_vb:
 420     */
 421    struct tnl_eval_store eval;
 422
 423    /* Functions to be plugged into dispatch when tnl is active.
 424     */
 425    GLvertexformat vtxfmt;
 426
 427 } TNLcontext;
 428
 429
 430
 431 #define TNL_CONTEXT(ctx) ((TNLcontext *)(ctx->swtnl_context))
 432 #define TNL_CURRENT_IM(ctx) ((struct immediate *)(ctx->swtnl_im))
 433
 434
 435 #define TYPE_IDX(t) ((t) & 0xf)
 436 #define MAX_TYPES TYPE_IDX(GL_DOUBLE)+1      /* 0xa + 1 */
 437
 438 extern void _tnl_MakeCurrent( GLcontext *ctx,
 439                               GLframebuffer *drawBuffer,
 440                               GLframebuffer *readBuffer );
 441
 442
 443 /*
 444  * Macros for fetching current input buffer.
 445  */
 446 #ifdef THREADS
 447 #define GET_IMMEDIATE  struct immediate *IM = TNL_CURRENT_IM(((GLcontext *) (_glapi_Context ? _glapi_Context : _glapi_get_context())))
 448 #define SET_IMMEDIATE(ctx, im)  ctx->swtnl_im = (void *)im
 449 #else
 450 extern struct immediate *_tnl_CurrentInput;
 451 #define GET_IMMEDIATE struct immediate *IM = _tnl_CurrentInput
 452 #define SET_IMMEDIATE(ctx, im)                  \
 453 do {                                            \
 454    ctx->swtnl_im = (void *)im;                  \
 455    _tnl_CurrentInput = im;                      \
 456 } while (0)
 457 #endif
 458
 459
 460 #endif