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.
55 #include "math/m_matrix.h"
56 #include "math/m_vector.h"
57 #include "math/m_xform.h"
61 #define MAX_PIPELINE_STAGES 30
64 * Note: The first attributes match the VERT_ATTRIB_* definitions
65 * in mtypes.h. However, the tnl module has additional attributes
66 * for materials, color indexes, edge flags, etc.
68 /* Although it's nice to use these as bit indexes in a DWORD flag, we
69 * could manage without if necessary. Another limit currently is the
70 * number of bits allocated for these numbers in places like vertex
71 * program instruction formats and register layouts.
73 /* The bit space exhaustion is a fact now, done by _TNL_ATTRIB_ATTRIBUTE* for
74 * GLSL vertex shader which cannot be aliased with conventional vertex attribs.
75 * Compacting _TNL_ATTRIB_MAT_* attribs would not work, they would not give
76 * as many free bits (11 plus already 1 free bit) as _TNL_ATTRIB_ATTRIBUTE*
81 _TNL_ATTRIB_WEIGHT
= 1,
82 _TNL_ATTRIB_NORMAL
= 2,
83 _TNL_ATTRIB_COLOR0
= 3,
84 _TNL_ATTRIB_COLOR1
= 4,
86 _TNL_ATTRIB_COLOR_INDEX
= 6,
87 _TNL_ATTRIB_EDGEFLAG
= 7,
90 _TNL_ATTRIB_TEX2
= 10,
91 _TNL_ATTRIB_TEX3
= 11,
92 _TNL_ATTRIB_TEX4
= 12,
93 _TNL_ATTRIB_TEX5
= 13,
94 _TNL_ATTRIB_TEX6
= 14,
95 _TNL_ATTRIB_TEX7
= 15,
97 _TNL_ATTRIB_GENERIC0
= 16, /* doesn't really exist! */
98 _TNL_ATTRIB_GENERIC1
= 17,
99 _TNL_ATTRIB_GENERIC2
= 18,
100 _TNL_ATTRIB_GENERIC3
= 19,
101 _TNL_ATTRIB_GENERIC4
= 20,
102 _TNL_ATTRIB_GENERIC5
= 21,
103 _TNL_ATTRIB_GENERIC6
= 22,
104 _TNL_ATTRIB_GENERIC7
= 23,
105 _TNL_ATTRIB_GENERIC8
= 24,
106 _TNL_ATTRIB_GENERIC9
= 25,
107 _TNL_ATTRIB_GENERIC10
= 26,
108 _TNL_ATTRIB_GENERIC11
= 27,
109 _TNL_ATTRIB_GENERIC12
= 28,
110 _TNL_ATTRIB_GENERIC13
= 29,
111 _TNL_ATTRIB_GENERIC14
= 30,
112 _TNL_ATTRIB_GENERIC15
= 31,
114 /* These alias with the generics, but they are not active
115 * concurrently, so it's not a problem. The TNL module
116 * doesn't have to do anything about this as this is how they
117 * are passed into the _draw_prims callback.
119 * When we generate fixed-function replacement programs (in
120 * t_vp_build.c currently), they refer to the appropriate
121 * generic attribute in order to pick up per-vertex material
124 _TNL_ATTRIB_MAT_FRONT_AMBIENT
= 16,
125 _TNL_ATTRIB_MAT_BACK_AMBIENT
= 17,
126 _TNL_ATTRIB_MAT_FRONT_DIFFUSE
= 18,
127 _TNL_ATTRIB_MAT_BACK_DIFFUSE
= 19,
128 _TNL_ATTRIB_MAT_FRONT_SPECULAR
= 20,
129 _TNL_ATTRIB_MAT_BACK_SPECULAR
= 21,
130 _TNL_ATTRIB_MAT_FRONT_EMISSION
= 22,
131 _TNL_ATTRIB_MAT_BACK_EMISSION
= 23,
132 _TNL_ATTRIB_MAT_FRONT_SHININESS
= 24,
133 _TNL_ATTRIB_MAT_BACK_SHININESS
= 25,
134 _TNL_ATTRIB_MAT_FRONT_INDEXES
= 26,
135 _TNL_ATTRIB_MAT_BACK_INDEXES
= 27,
137 /* This is really a VERT_RESULT, not an attrib. Need to fix
138 * tnl to understand the difference.
140 _TNL_ATTRIB_POINTSIZE
= 16,
145 #define _TNL_ATTRIB_TEX(u) (_TNL_ATTRIB_TEX0 + (u))
146 #define _TNL_ATTRIB_GENERIC(n) (_TNL_ATTRIB_GENERIC0 + (n))
148 /* special index used for handing invalid glVertexAttribute() indices */
149 #define _TNL_ATTRIB_ERROR (_TNL_ATTRIB_GENERIC15 + 1)
152 * Handy attribute ranges:
154 #define _TNL_FIRST_PROG _TNL_ATTRIB_WEIGHT
155 #define _TNL_LAST_PROG _TNL_ATTRIB_TEX7
157 #define _TNL_FIRST_TEX _TNL_ATTRIB_TEX0
158 #define _TNL_LAST_TEX _TNL_ATTRIB_TEX7
160 #define _TNL_FIRST_GENERIC _TNL_ATTRIB_GENERIC0
161 #define _TNL_LAST_GENERIC _TNL_ATTRIB_GENERIC15
163 #define _TNL_FIRST_MAT _TNL_ATTRIB_MAT_FRONT_AMBIENT /* GENERIC0 */
164 #define _TNL_LAST_MAT _TNL_ATTRIB_MAT_BACK_INDEXES /* GENERIC11 */
166 /* Number of available generic attributes */
167 #define _TNL_NUM_GENERIC 16
169 /* Number of attributes used for evaluators */
170 #define _TNL_NUM_EVAL 16
173 #define PRIM_BEGIN 0x10
174 #define PRIM_END 0x20
175 #define PRIM_MODE_MASK 0x0f
177 static INLINE GLuint
_tnl_translate_prim( const struct _mesa_prim
*prim
)
181 if (prim
->begin
) flag
|= PRIM_BEGIN
;
182 if (prim
->end
) flag
|= PRIM_END
;
190 * Contains the current state of a running pipeline.
194 GLuint Size
; /**< Max vertices per vertex buffer, constant */
196 /* Constant over the pipeline.
198 GLuint Count
; /**< Number of vertices currently in buffer */
200 /* Pointers to current data.
201 * XXX some of these fields alias AttribPtr below and should be removed
202 * such as NormalPtr, TexCoordPtr, FogCoordPtr, etc.
205 GLvector4f
*ObjPtr
; /* _TNL_BIT_POS */
206 GLvector4f
*EyePtr
; /* _TNL_BIT_POS */
207 GLvector4f
*ClipPtr
; /* _TNL_BIT_POS */
208 GLvector4f
*NdcPtr
; /* _TNL_BIT_POS */
209 GLubyte ClipOrMask
; /* _TNL_BIT_POS */
210 GLubyte ClipAndMask
; /* _TNL_BIT_POS */
211 GLubyte
*ClipMask
; /* _TNL_BIT_POS */
212 GLvector4f
*NormalPtr
; /* _TNL_BIT_NORMAL */
213 GLfloat
*NormalLengthPtr
; /* _TNL_BIT_NORMAL */
214 GLboolean
*EdgeFlag
; /* _TNL_BIT_EDGEFLAG */
215 GLvector4f
*TexCoordPtr
[MAX_TEXTURE_COORD_UNITS
]; /* VERT_TEX_0..n */
216 GLvector4f
*IndexPtr
[2]; /* _TNL_BIT_INDEX */
217 GLvector4f
*ColorPtr
[2]; /* _TNL_BIT_COLOR0 */
218 GLvector4f
*SecondaryColorPtr
[2]; /* _TNL_BIT_COLOR1 */
219 GLvector4f
*FogCoordPtr
; /* _TNL_BIT_FOG */
220 GLvector4f
*VaryingPtr
[MAX_VARYING_VECTORS
];
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_cache_item
{
393 struct tnl_cache_item
*next
;
397 struct tnl_cache_item
**items
;
398 GLuint size
, n_items
;
402 struct tnl_device_driver
408 void (*RunPipeline
)(GLcontext
*ctx
);
409 /* Replaces PipelineStart/PipelineFinish -- intended to allow
410 * drivers to wrap _tnl_run_pipeline() with code to validate state
411 * and grab/release hardware locks.
414 void (*NotifyMaterialChange
)(GLcontext
*ctx
);
415 /* Alert tnl-aware drivers of changes to material.
418 void (*NotifyInputChanges
)(GLcontext
*ctx
, GLuint bitmask
);
419 /* Alert tnl-aware drivers of changes to size and stride of input
424 *** Rendering -- These functions called only from t_vb_render.c
428 void (*Start
)(GLcontext
*ctx
);
429 void (*Finish
)(GLcontext
*ctx
);
430 /* Called before and after all rendering operations, including DrawPixels,
431 * ReadPixels, Bitmap, span functions, and CopyTexImage, etc commands.
432 * These are a suitable place for grabbing/releasing hardware locks.
435 void (*PrimitiveNotify
)(GLcontext
*ctx
, GLenum mode
);
436 /* Called between RenderStart() and RenderFinish() to indicate the
437 * type of primitive we're about to draw. Mode will be one of the
438 * modes accepted by glBegin().
441 tnl_interp_func Interp
;
442 /* The interp function is called by the clipping routines when we need
443 * to generate an interpolated vertex. All pertinant vertex ancilliary
444 * data should be computed by interpolating between the 'in' and 'out'
448 tnl_copy_pv_func CopyPV
;
449 /* The copy function is used to make a copy of a vertex. All pertinant
450 * vertex attributes should be copied.
453 void (*ClippedPolygon
)( GLcontext
*ctx
, const GLuint
*elts
, GLuint n
);
454 /* Render a polygon with <n> vertices whose indexes are in the <elts>
458 void (*ClippedLine
)( GLcontext
*ctx
, GLuint v0
, GLuint v1
);
459 /* Render a line between the two vertices given by indexes v0 and v1. */
461 tnl_points_func Points
; /* must now respect vb->elts */
463 tnl_triangle_func Triangle
;
465 /* These functions are called in order to render points, lines,
466 * triangles and quads. These are only called via the T&L module.
469 tnl_render_func
*PrimTabVerts
;
470 tnl_render_func
*PrimTabElts
;
471 /* Render whole unclipped primitives (points, lines, linestrips,
472 * lineloops, etc). The tables are indexed by the GL enum of the
473 * primitive to be rendered. RenderTabVerts is used for non-indexed
474 * arrays of vertices. RenderTabElts is used for indexed arrays of
478 void (*ResetLineStipple
)( GLcontext
*ctx
);
479 /* Reset the hardware's line stipple counter.
482 tnl_setup_func BuildVertices
;
483 /* This function is called whenever new vertices are required for
484 * rendering. The vertices in question are those n such that start
485 * <= n < end. The new_inputs parameter indicates those fields of
486 * the vertex which need to be updated, if only a partial repair of
487 * the vertex is required.
489 * This function is called only from _tnl_render_stage in tnl/t_render.c.
493 GLboolean (*Multipass
)( GLcontext
*ctx
, GLuint passno
);
494 /* Driver may request additional render passes by returning GL_TRUE
495 * when this function is called. This function will be called
496 * after the first pass, and passes will be made until the function
497 * returns GL_FALSE. If no function is registered, only one pass
500 * This function will be first invoked with passno == 1.
506 #define DECLARE_RENDERINPUTS(name) BITSET64_DECLARE(name, _TNL_ATTRIB_MAX)
507 #define RENDERINPUTS_COPY BITSET64_COPY
508 #define RENDERINPUTS_EQUAL BITSET64_EQUAL
509 #define RENDERINPUTS_ZERO BITSET64_ZERO
510 #define RENDERINPUTS_ONES BITSET64_ONES
511 #define RENDERINPUTS_TEST BITSET64_TEST
512 #define RENDERINPUTS_SET BITSET64_SET
513 #define RENDERINPUTS_CLEAR BITSET64_CLEAR
514 #define RENDERINPUTS_TEST_RANGE BITSET64_TEST_RANGE
515 #define RENDERINPUTS_SET_RANGE BITSET64_SET_RANGE
516 #define RENDERINPUTS_CLEAR_RANGE BITSET64_CLEAR_RANGE
520 * Context state for T&L context.
526 struct tnl_device_driver Driver
;
530 struct tnl_pipeline pipeline
;
531 struct vertex_buffer vb
;
533 /* Clipspace/ndc/window vertex managment:
535 struct tnl_clipspace clipspace
;
537 /* Probably need a better configuration mechanism:
539 GLboolean NeedNdcCoords
;
540 GLboolean AllowVertexFog
;
541 GLboolean AllowPixelFog
;
542 GLboolean _DoVertexFog
; /* eval fog function at each vertex? */
544 DECLARE_RENDERINPUTS(render_inputs_bitset
);
546 GLvector4f tmp_inputs
[VERT_ATTRIB_MAX
];
548 /* Temp storage for t_draw.c:
550 GLubyte
*block
[VERT_ATTRIB_MAX
];
553 /* Cache of fixed-function-replacing vertex programs:
555 struct tnl_cache
*vp_cache
;
561 #define TNL_CONTEXT(ctx) ((TNLcontext *)((ctx)->swtnl_context))
564 #define TYPE_IDX(t) ((t) & 0xf)
565 #define MAX_TYPES TYPE_IDX(GL_DOUBLE)+1 /* 0xa + 1 */