2 * mesa 3-D graphics library
5 * Copyright (C) 1999-2006 Brian Paul All Rights Reserved.
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:
14 * The above copyright notice and this permission notice shall be included
15 * in all copies or substantial portions of the Software.
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.
27 * \brief TnL module datatypes and definitions.
28 * \author Keith Whitwell
33 * \mainpage The TNL-module
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.
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.
52 #include "main/glheader.h"
53 #include "main/bitset.h"
54 #include "main/mtypes.h"
56 #include "math/m_matrix.h"
57 #include "math/m_vector.h"
58 #include "math/m_xform.h"
62 #define MAX_PIPELINE_STAGES 30
65 * Note: The first attributes match the VERT_ATTRIB_* definitions
66 * in mtypes.h. However, the tnl module has additional attributes
67 * for materials, color indexes, edge flags, etc.
69 /* Although it's nice to use these as bit indexes in a DWORD flag, we
70 * could manage without if necessary. Another limit currently is the
71 * number of bits allocated for these numbers in places like vertex
72 * program instruction formats and register layouts.
74 /* The bit space exhaustion is a fact now, done by _TNL_ATTRIB_ATTRIBUTE* for
75 * GLSL vertex shader which cannot be aliased with conventional vertex attribs.
76 * Compacting _TNL_ATTRIB_MAT_* attribs would not work, they would not give
77 * as many free bits (11 plus already 1 free bit) as _TNL_ATTRIB_ATTRIBUTE*
82 _TNL_ATTRIB_WEIGHT = 1,
83 _TNL_ATTRIB_NORMAL = 2,
84 _TNL_ATTRIB_COLOR0 = 3,
85 _TNL_ATTRIB_COLOR1 = 4,
87 _TNL_ATTRIB_COLOR_INDEX = 6,
88 _TNL_ATTRIB_EDGEFLAG = 7,
91 _TNL_ATTRIB_TEX2 = 10,
92 _TNL_ATTRIB_TEX3 = 11,
93 _TNL_ATTRIB_TEX4 = 12,
94 _TNL_ATTRIB_TEX5 = 13,
95 _TNL_ATTRIB_TEX6 = 14,
96 _TNL_ATTRIB_TEX7 = 15,
98 _TNL_ATTRIB_GENERIC0 = 16, /* doesn't really exist! */
99 _TNL_ATTRIB_GENERIC1 = 17,
100 _TNL_ATTRIB_GENERIC2 = 18,
101 _TNL_ATTRIB_GENERIC3 = 19,
102 _TNL_ATTRIB_GENERIC4 = 20,
103 _TNL_ATTRIB_GENERIC5 = 21,
104 _TNL_ATTRIB_GENERIC6 = 22,
105 _TNL_ATTRIB_GENERIC7 = 23,
106 _TNL_ATTRIB_GENERIC8 = 24,
107 _TNL_ATTRIB_GENERIC9 = 25,
108 _TNL_ATTRIB_GENERIC10 = 26,
109 _TNL_ATTRIB_GENERIC11 = 27,
110 _TNL_ATTRIB_GENERIC12 = 28,
111 _TNL_ATTRIB_GENERIC13 = 29,
112 _TNL_ATTRIB_GENERIC14 = 30,
113 _TNL_ATTRIB_GENERIC15 = 31,
115 /* These alias with the generics, but they are not active
116 * concurrently, so it's not a problem. The TNL module
117 * doesn't have to do anything about this as this is how they
118 * are passed into the _draw_prims callback.
120 * When we generate fixed-function replacement programs (in
121 * t_vp_build.c currently), they refer to the appropriate
122 * generic attribute in order to pick up per-vertex material
125 _TNL_ATTRIB_MAT_FRONT_AMBIENT = 16,
126 _TNL_ATTRIB_MAT_BACK_AMBIENT = 17,
127 _TNL_ATTRIB_MAT_FRONT_DIFFUSE = 18,
128 _TNL_ATTRIB_MAT_BACK_DIFFUSE = 19,
129 _TNL_ATTRIB_MAT_FRONT_SPECULAR = 20,
130 _TNL_ATTRIB_MAT_BACK_SPECULAR = 21,
131 _TNL_ATTRIB_MAT_FRONT_EMISSION = 22,
132 _TNL_ATTRIB_MAT_BACK_EMISSION = 23,
133 _TNL_ATTRIB_MAT_FRONT_SHININESS = 24,
134 _TNL_ATTRIB_MAT_BACK_SHININESS = 25,
135 _TNL_ATTRIB_MAT_FRONT_INDEXES = 26,
136 _TNL_ATTRIB_MAT_BACK_INDEXES = 27,
138 /* This is really a VERT_RESULT, not an attrib. Need to fix
139 * tnl to understand the difference.
141 _TNL_ATTRIB_POINTSIZE = 16,
146 #define _TNL_ATTRIB_TEX(u) (_TNL_ATTRIB_TEX0 + (u))
147 #define _TNL_ATTRIB_GENERIC(n) (_TNL_ATTRIB_GENERIC0 + (n))
149 /* special index used for handing invalid glVertexAttribute() indices */
150 #define _TNL_ATTRIB_ERROR (_TNL_ATTRIB_GENERIC15 + 1)
153 * Handy attribute ranges:
155 #define _TNL_FIRST_PROG _TNL_ATTRIB_WEIGHT
156 #define _TNL_LAST_PROG _TNL_ATTRIB_TEX7
158 #define _TNL_FIRST_TEX _TNL_ATTRIB_TEX0
159 #define _TNL_LAST_TEX _TNL_ATTRIB_TEX7
161 #define _TNL_FIRST_GENERIC _TNL_ATTRIB_GENERIC0
162 #define _TNL_LAST_GENERIC _TNL_ATTRIB_GENERIC15
164 #define _TNL_FIRST_MAT _TNL_ATTRIB_MAT_FRONT_AMBIENT /* GENERIC0 */
165 #define _TNL_LAST_MAT _TNL_ATTRIB_MAT_BACK_INDEXES /* GENERIC11 */
167 /* Number of available generic attributes */
168 #define _TNL_NUM_GENERIC 16
170 /* Number of attributes used for evaluators */
171 #define _TNL_NUM_EVAL 16
174 #define PRIM_BEGIN 0x10
175 #define PRIM_END 0x20
176 #define PRIM_MODE_MASK 0x0f
178 static INLINE GLuint _tnl_translate_prim( const struct _mesa_prim *prim )
182 if (prim->begin) flag |= PRIM_BEGIN;
183 if (prim->end) flag |= PRIM_END;
191 * Contains the current state of a running pipeline.
195 GLuint Size; /**< Max vertices per vertex buffer, constant */
197 /* Constant over the pipeline.
199 GLuint Count; /**< Number of vertices currently in buffer */
201 /* Pointers to current data.
202 * XXX some of these fields alias AttribPtr below and should be removed
203 * such as NormalPtr, TexCoordPtr, FogCoordPtr, etc.
206 GLvector4f *ObjPtr; /* _TNL_BIT_POS */
207 GLvector4f *EyePtr; /* _TNL_BIT_POS */
208 GLvector4f *ClipPtr; /* _TNL_BIT_POS */
209 GLvector4f *NdcPtr; /* _TNL_BIT_POS */
210 GLubyte ClipOrMask; /* _TNL_BIT_POS */
211 GLubyte ClipAndMask; /* _TNL_BIT_POS */
212 GLubyte *ClipMask; /* _TNL_BIT_POS */
213 GLvector4f *NormalPtr; /* _TNL_BIT_NORMAL */
214 GLfloat *NormalLengthPtr; /* _TNL_BIT_NORMAL */
215 GLboolean *EdgeFlag; /* _TNL_BIT_EDGEFLAG */
216 GLvector4f *TexCoordPtr[MAX_TEXTURE_COORD_UNITS]; /* VERT_TEX_0..n */
217 GLvector4f *IndexPtr[2]; /* _TNL_BIT_INDEX */
218 GLvector4f *ColorPtr[2]; /* _TNL_BIT_COLOR0 */
219 GLvector4f *SecondaryColorPtr[2]; /* _TNL_BIT_COLOR1 */
220 GLvector4f *FogCoordPtr; /* _TNL_BIT_FOG */
222 const struct _mesa_prim *Primitive;
223 GLuint PrimitiveCount;
225 /* Inputs to the vertex program stage */
226 GLvector4f *AttribPtr[_TNL_ATTRIB_MAX]; /* GL_NV_vertex_program */
231 * Describes an individual operation on the pipeline.
233 struct tnl_pipeline_stage
237 /* Private data for the pipeline stage:
241 /* Allocate private data
243 GLboolean (*create)( GLcontext *ctx, struct tnl_pipeline_stage * );
245 /* Free private data.
247 void (*destroy)( struct tnl_pipeline_stage * );
249 /* Called on any statechange or input array size change or
250 * input array change to/from zero stride.
252 void (*validate)( GLcontext *ctx, struct tnl_pipeline_stage * );
254 /* Called from _tnl_run_pipeline(). The stage.changed_inputs value
255 * encodes all inputs to thee struct which have changed. If
256 * non-zero, recompute all affected outputs of the stage, otherwise
257 * execute any 'sideeffects' of the stage.
259 * Return value: GL_TRUE - keep going
260 * GL_FALSE - finished pipeline
262 GLboolean (*run)( GLcontext *ctx, struct tnl_pipeline_stage * );
267 /** Contains the array of all pipeline stages.
268 * The default values are defined at the end of t_pipeline.c
270 struct tnl_pipeline {
272 GLuint last_attrib_stride[_TNL_ATTRIB_MAX];
273 GLuint last_attrib_size[_TNL_ATTRIB_MAX];
274 GLuint input_changes;
277 struct tnl_pipeline_stage stages[MAX_PIPELINE_STAGES+1];
281 struct tnl_clipspace;
282 struct tnl_clipspace_attr;
284 typedef void (*tnl_extract_func)( const struct tnl_clipspace_attr *a,
288 typedef void (*tnl_insert_func)( const struct tnl_clipspace_attr *a,
292 typedef void (*tnl_emit_func)( GLcontext *ctx,
298 * Describes how to convert/move a vertex attribute from a vertex array
299 * to a vertex structure.
301 struct tnl_clipspace_attr
303 GLuint attrib; /* which vertex attrib (0=position, etc) */
305 GLuint vertoffset; /* position of the attrib in the vertex struct */
306 GLuint vertattrsize; /* size of the attribute in bytes */
310 const tnl_insert_func *insert;
311 tnl_insert_func emit;
312 tnl_extract_func extract;
313 const GLfloat *vp; /* NDC->Viewport mapping matrix */
319 typedef void (*tnl_points_func)( GLcontext *ctx, GLuint first, GLuint last );
320 typedef void (*tnl_line_func)( GLcontext *ctx, GLuint v1, GLuint v2 );
321 typedef void (*tnl_triangle_func)( GLcontext *ctx,
322 GLuint v1, GLuint v2, GLuint v3 );
323 typedef void (*tnl_quad_func)( GLcontext *ctx, GLuint v1, GLuint v2,
324 GLuint v3, GLuint v4 );
325 typedef void (*tnl_render_func)( GLcontext *ctx, GLuint start, GLuint count,
327 typedef void (*tnl_interp_func)( GLcontext *ctx,
328 GLfloat t, GLuint dst, GLuint out, GLuint in,
329 GLboolean force_boundary );
330 typedef void (*tnl_copy_pv_func)( GLcontext *ctx, GLuint dst, GLuint src );
331 typedef void (*tnl_setup_func)( GLcontext *ctx,
332 GLuint start, GLuint end,
336 struct tnl_attr_type {
343 struct tnl_clipspace_fastpath {
346 GLboolean match_strides;
348 struct tnl_attr_type *attr;
351 struct tnl_clipspace_fastpath *next;
355 * Used to describe conversion of vertex arrays to vertex structures.
356 * I.e. Structure of arrays to arrays of structs.
360 GLboolean need_extras;
366 GLuint max_vertex_size;
368 struct tnl_clipspace_attr attr[_TNL_ATTRIB_MAX];
372 tnl_interp_func interp;
373 tnl_copy_pv_func copy_pv;
375 /* Parameters and constants for codegen:
377 GLboolean need_viewport;
380 GLfloat chan_scale[4];
383 struct tnl_clipspace_fastpath *fastpath;
385 void (*codegen_emit)( GLcontext *ctx );
389 struct tnl_device_driver
395 void (*RunPipeline)(GLcontext *ctx);
396 /* Replaces PipelineStart/PipelineFinish -- intended to allow
397 * drivers to wrap _tnl_run_pipeline() with code to validate state
398 * and grab/release hardware locks.
401 void (*NotifyMaterialChange)(GLcontext *ctx);
402 /* Alert tnl-aware drivers of changes to material.
405 void (*NotifyInputChanges)(GLcontext *ctx, GLuint bitmask);
406 /* Alert tnl-aware drivers of changes to size and stride of input
411 *** Rendering -- These functions called only from t_vb_render.c
415 void (*Start)(GLcontext *ctx);
416 void (*Finish)(GLcontext *ctx);
417 /* Called before and after all rendering operations, including DrawPixels,
418 * ReadPixels, Bitmap, span functions, and CopyTexImage, etc commands.
419 * These are a suitable place for grabbing/releasing hardware locks.
422 void (*PrimitiveNotify)(GLcontext *ctx, GLenum mode);
423 /* Called between RenderStart() and RenderFinish() to indicate the
424 * type of primitive we're about to draw. Mode will be one of the
425 * modes accepted by glBegin().
428 tnl_interp_func Interp;
429 /* The interp function is called by the clipping routines when we need
430 * to generate an interpolated vertex. All pertinant vertex ancilliary
431 * data should be computed by interpolating between the 'in' and 'out'
435 tnl_copy_pv_func CopyPV;
436 /* The copy function is used to make a copy of a vertex. All pertinant
437 * vertex attributes should be copied.
440 void (*ClippedPolygon)( GLcontext *ctx, const GLuint *elts, GLuint n );
441 /* Render a polygon with <n> vertices whose indexes are in the <elts>
445 void (*ClippedLine)( GLcontext *ctx, GLuint v0, GLuint v1 );
446 /* Render a line between the two vertices given by indexes v0 and v1. */
448 tnl_points_func Points; /* must now respect vb->elts */
450 tnl_triangle_func Triangle;
452 /* These functions are called in order to render points, lines,
453 * triangles and quads. These are only called via the T&L module.
456 tnl_render_func *PrimTabVerts;
457 tnl_render_func *PrimTabElts;
458 /* Render whole unclipped primitives (points, lines, linestrips,
459 * lineloops, etc). The tables are indexed by the GL enum of the
460 * primitive to be rendered. RenderTabVerts is used for non-indexed
461 * arrays of vertices. RenderTabElts is used for indexed arrays of
465 void (*ResetLineStipple)( GLcontext *ctx );
466 /* Reset the hardware's line stipple counter.
469 tnl_setup_func BuildVertices;
470 /* This function is called whenever new vertices are required for
471 * rendering. The vertices in question are those n such that start
472 * <= n < end. The new_inputs parameter indicates those fields of
473 * the vertex which need to be updated, if only a partial repair of
474 * the vertex is required.
476 * This function is called only from _tnl_render_stage in tnl/t_render.c.
480 GLboolean (*Multipass)( GLcontext *ctx, GLuint passno );
481 /* Driver may request additional render passes by returning GL_TRUE
482 * when this function is called. This function will be called
483 * after the first pass, and passes will be made until the function
484 * returns GL_FALSE. If no function is registered, only one pass
487 * This function will be first invoked with passno == 1.
493 #define DECLARE_RENDERINPUTS(name) BITSET64_DECLARE(name, _TNL_ATTRIB_MAX)
494 #define RENDERINPUTS_COPY BITSET64_COPY
495 #define RENDERINPUTS_EQUAL BITSET64_EQUAL
496 #define RENDERINPUTS_ZERO BITSET64_ZERO
497 #define RENDERINPUTS_ONES BITSET64_ONES
498 #define RENDERINPUTS_TEST BITSET64_TEST
499 #define RENDERINPUTS_SET BITSET64_SET
500 #define RENDERINPUTS_CLEAR BITSET64_CLEAR
501 #define RENDERINPUTS_TEST_RANGE BITSET64_TEST_RANGE
502 #define RENDERINPUTS_SET_RANGE BITSET64_SET_RANGE
503 #define RENDERINPUTS_CLEAR_RANGE BITSET64_CLEAR_RANGE
507 * Context state for T&L context.
513 struct tnl_device_driver Driver;
517 struct tnl_pipeline pipeline;
518 struct vertex_buffer vb;
520 /* Clipspace/ndc/window vertex managment:
522 struct tnl_clipspace clipspace;
524 /* Probably need a better configuration mechanism:
526 GLboolean NeedNdcCoords;
527 GLboolean AllowVertexFog;
528 GLboolean AllowPixelFog;
529 GLboolean _DoVertexFog; /* eval fog function at each vertex? */
531 DECLARE_RENDERINPUTS(render_inputs_bitset);
533 GLvector4f tmp_inputs[VERT_ATTRIB_MAX];
535 /* Temp storage for t_draw.c:
537 GLubyte *block[VERT_ATTRIB_MAX];
544 #define TNL_CONTEXT(ctx) ((TNLcontext *)((ctx)->swtnl_context))
547 #define TYPE_IDX(t) ((t) & 0xf)
548 #define MAX_TYPES TYPE_IDX(GL_DOUBLE)+1 /* 0xa + 1 */
552 tnl_clip_prepare(GLcontext *ctx);