2 * mesa 3-D graphics library
5 * Copyright (C) 1999-2003 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.
46 * The initial vertex_buffer data may either come from an ::immediate
47 * structure or client vertex_arrays or display lists:
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
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.
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.
78 #include "math/m_matrix.h"
79 #include "math/m_vector.h"
80 #include "math/m_xform.h"
83 #define MAX_PIPELINE_STAGES 30
88 _TNL_ATTRIB_WEIGHT
= 1,
89 _TNL_ATTRIB_NORMAL
= 2,
90 _TNL_ATTRIB_COLOR0
= 3,
91 _TNL_ATTRIB_COLOR1
= 4,
94 _TNL_ATTRIB_SEVEN
= 7,
97 _TNL_ATTRIB_TEX2
= 10,
98 _TNL_ATTRIB_TEX3
= 11,
99 _TNL_ATTRIB_TEX4
= 12,
100 _TNL_ATTRIB_TEX5
= 13,
101 _TNL_ATTRIB_TEX6
= 14,
102 _TNL_ATTRIB_TEX7
= 15,
103 _TNL_ATTRIB_MAT_FRONT_AMBIENT
= 16,
104 _TNL_ATTRIB_MAT_BACK_AMBIENT
= 17,
105 _TNL_ATTRIB_MAT_FRONT_DIFFUSE
= 18,
106 _TNL_ATTRIB_MAT_BACK_DIFFUSE
= 19,
107 _TNL_ATTRIB_MAT_FRONT_SPECULAR
= 20,
108 _TNL_ATTRIB_MAT_BACK_SPECULAR
= 21,
109 _TNL_ATTRIB_MAT_FRONT_EMISSION
= 22,
110 _TNL_ATTRIB_MAT_BACK_EMISSION
= 23,
111 _TNL_ATTRIB_MAT_FRONT_SHININESS
= 24,
112 _TNL_ATTRIB_MAT_BACK_SHININESS
= 25,
113 _TNL_ATTRIB_MAT_FRONT_INDEXES
= 26,
114 _TNL_ATTRIB_MAT_BACK_INDEXES
= 27,
115 _TNL_ATTRIB_INDEX
= 28,
116 _TNL_ATTRIB_EDGEFLAG
= 29,
120 /* Will probably have to revise this scheme fairly shortly, eg. by
121 * compacting all the MAT flags down to one bit, or by using two
122 * dwords to store the flags.
124 #define _TNL_BIT_POS (1<<0)
125 #define _TNL_BIT_WEIGHT (1<<1)
126 #define _TNL_BIT_NORMAL (1<<2)
127 #define _TNL_BIT_COLOR0 (1<<3)
128 #define _TNL_BIT_COLOR1 (1<<4)
129 #define _TNL_BIT_FOG (1<<5)
130 #define _TNL_BIT_SIX (1<<6)
131 #define _TNL_BIT_SEVEN (1<<7)
132 #define _TNL_BIT_TEX0 (1<<8)
133 #define _TNL_BIT_TEX1 (1<<9)
134 #define _TNL_BIT_TEX2 (1<<10)
135 #define _TNL_BIT_TEX3 (1<<11)
136 #define _TNL_BIT_TEX4 (1<<12)
137 #define _TNL_BIT_TEX5 (1<<13)
138 #define _TNL_BIT_TEX6 (1<<14)
139 #define _TNL_BIT_TEX7 (1<<15)
140 #define _TNL_BIT_MAT_FRONT_AMBIENT (1<<16)
141 #define _TNL_BIT_MAT_BACK_AMBIENT (1<<17)
142 #define _TNL_BIT_MAT_FRONT_DIFFUSE (1<<18)
143 #define _TNL_BIT_MAT_BACK_DIFFUSE (1<<19)
144 #define _TNL_BIT_MAT_FRONT_SPECULAR (1<<20)
145 #define _TNL_BIT_MAT_BACK_SPECULAR (1<<21)
146 #define _TNL_BIT_MAT_FRONT_EMISSION (1<<22)
147 #define _TNL_BIT_MAT_BACK_EMISSION (1<<23)
148 #define _TNL_BIT_MAT_FRONT_SHININESS (1<<24)
149 #define _TNL_BIT_MAT_BACK_SHININESS (1<<25)
150 #define _TNL_BIT_MAT_FRONT_INDEXES (1<<26)
151 #define _TNL_BIT_MAT_BACK_INDEXES (1<<27)
152 #define _TNL_BIT_INDEX (1<<28)
153 #define _TNL_BIT_EDGEFLAG (1<<29)
155 #define _TNL_BIT_TEX(u) (1 << (_TNL_ATTRIB_TEX0 + (u)))
158 #define _TNL_BITS_MAT_ANY (_TNL_BIT_MAT_FRONT_AMBIENT | \
159 _TNL_BIT_MAT_BACK_AMBIENT | \
160 _TNL_BIT_MAT_FRONT_DIFFUSE | \
161 _TNL_BIT_MAT_BACK_DIFFUSE | \
162 _TNL_BIT_MAT_FRONT_SPECULAR | \
163 _TNL_BIT_MAT_BACK_SPECULAR | \
164 _TNL_BIT_MAT_FRONT_EMISSION | \
165 _TNL_BIT_MAT_BACK_EMISSION | \
166 _TNL_BIT_MAT_FRONT_SHININESS | \
167 _TNL_BIT_MAT_BACK_SHININESS | \
168 _TNL_BIT_MAT_FRONT_INDEXES | \
169 _TNL_BIT_MAT_BACK_INDEXES)
172 #define _TNL_BITS_TEX_ANY (_TNL_BIT_TEX0 | \
182 #define _TNL_BITS_PROG_ANY (_TNL_BIT_POS | \
194 #define PRIM_BEGIN 0x10
195 #define PRIM_END 0x20
196 #define PRIM_WEAK 0x40
197 #define PRIM_MODE_MASK 0x0f
209 struct tnl_eval1_map
{
210 struct gl_1d_map
*map
;
214 struct tnl_eval2_map
{
215 struct gl_2d_map
*map
;
221 struct tnl_eval1_map map1
[_TNL_ATTRIB_INDEX
+ 1];
222 struct tnl_eval2_map map2
[_TNL_ATTRIB_INDEX
+ 1];
226 #define TNL_MAX_PRIM 16
227 #define TNL_MAX_COPIED_VERTS 3
229 struct tnl_copied_vtx
{
230 GLfloat buffer
[_TNL_ATTRIB_MAX
* 4 * TNL_MAX_COPIED_VERTS
];
234 #define VERT_BUFFER_SIZE 2048 /* 8kbytes */
236 typedef void (*attrfv_func
)( const GLfloat
* );
238 /* The assembly of vertices in immediate mode is separated from
239 * display list compilation. This allows a simpler immediate mode
240 * treatment and a display list compiler better suited to
241 * hardware-acceleration.
244 GLfloat buffer
[VERT_BUFFER_SIZE
];
245 GLubyte attrsz
[_TNL_ATTRIB_MAX
];
247 struct tnl_prim prim
[TNL_MAX_PRIM
];
249 GLfloat
*vbptr
; /* cursor, points into buffer */
250 GLfloat vertex
[_TNL_ATTRIB_MAX
*4]; /* current vertex */
251 GLfloat
*attrptr
[_TNL_ATTRIB_MAX
]; /* points into vertex */
252 GLfloat
*current
[_TNL_ATTRIB_MAX
]; /* points into ctx->Current, etc */
253 GLuint counter
, initial_counter
;
254 struct tnl_copied_vtx copied
;
255 attrfv_func tabfv
[_TNL_ATTRIB_MAX
][4];
256 struct tnl_eval eval
;
257 GLboolean
*edgeflag_tmp
;
263 /* For display lists, this structure holds a run of vertices of the
264 * same format, and a strictly well-formed set of begin/end pairs,
265 * starting on the first vertex and ending at the last. Vertex
266 * copying on buffer breaks is precomputed according to these
267 * primitives, though there are situations where the copying will need
268 * correction at execute-time, perhaps by replaying the list as
269 * immediate mode commands.
271 * On executing this list, the 'current' values may be updated with
272 * the values of the final vertex, and often no fixup of the start of
273 * the vertex list is required.
275 * Eval and other commands that don't fit into these vertex lists are
276 * compiled using the fallback opcode mechanism provided by dlist.c.
278 struct tnl_vertex_list
{
279 GLubyte attrsz
[_TNL_ATTRIB_MAX
];
284 GLuint wrap_count
; /* number of copied vertices at start */
285 GLuint dangling_attr_ref
; /* current attr implicitly referenced
288 GLfloat
*normal_lengths
;
289 struct tnl_prim
*prim
;
292 struct tnl_vertex_store
*vertex_store
;
293 struct tnl_primitive_store
*prim_store
;
296 /* These buffers should be a reasonable size to support upload to
297 * hardware? Maybe drivers should stitch them back together, or
298 * specify a desired size?
300 #define SAVE_BUFFER_SIZE (16*1024)
301 #define SAVE_PRIM_SIZE 128
303 /* Storage to be shared among several vertex_lists.
305 struct tnl_vertex_store
{
306 GLfloat buffer
[SAVE_BUFFER_SIZE
];
311 struct tnl_primitive_store
{
312 struct tnl_prim buffer
[SAVE_PRIM_SIZE
];
319 GLubyte attrsz
[_TNL_ATTRIB_MAX
];
326 struct tnl_prim
*prim
;
327 GLuint prim_count
, prim_max
;
329 struct tnl_vertex_store
*vertex_store
;
330 struct tnl_primitive_store
*prim_store
;
332 GLfloat
*vbptr
; /* cursor, points into buffer */
333 GLfloat vertex
[_TNL_ATTRIB_MAX
*4]; /* current values */
334 GLfloat
*attrptr
[_TNL_ATTRIB_MAX
];
335 GLuint counter
, initial_counter
;
336 GLuint dangling_attr_ref
;
338 GLuint opcode_vertex_list
;
340 struct tnl_copied_vtx copied
;
342 GLfloat
*current
[_TNL_ATTRIB_MAX
]; /* points into ctx->ListState */
343 GLubyte
*currentsz
[_TNL_ATTRIB_MAX
];
345 void (*tabfv
[_TNL_ATTRIB_MAX
][4])( const GLfloat
* );
354 struct tnl_vertex_arrays
356 /* Conventional vertex attribute arrays */
360 GLvector4f SecondaryColor
;
362 GLvector4f TexCoord
[MAX_TEXTURE_COORD_UNITS
];
368 /* These attributes don't alias with the conventional attributes.
369 * The GL_NV_vertex_program extension defines 16 extra sets of vertex
370 * arrays which have precedent over the conventional arrays when enabled.
372 GLvector4f Attribs
[_TNL_ATTRIB_MAX
];
377 * Contains the current state of a running pipeline.
381 /* Constant over life of the vertex_buffer.
385 /* Constant over the pipeline.
387 GLuint Count
; /* for everything except Elts */
389 /* Pointers to current data.
392 GLvector4f
*ObjPtr
; /* _TNL_BIT_POS */
393 GLvector4f
*EyePtr
; /* _TNL_BIT_POS */
394 GLvector4f
*ClipPtr
; /* _TNL_BIT_POS */
395 GLvector4f
*NdcPtr
; /* _TNL_BIT_POS */
396 GLubyte ClipOrMask
; /* _TNL_BIT_POS */
397 GLubyte
*ClipMask
; /* _TNL_BIT_POS */
398 GLvector4f
*NormalPtr
; /* _TNL_BIT_NORMAL */
399 GLfloat
*NormalLengthPtr
; /* _TNL_BIT_NORMAL */
400 GLboolean
*EdgeFlag
; /* _TNL_BIT_EDGEFLAG */
401 GLvector4f
*TexCoordPtr
[MAX_TEXTURE_COORD_UNITS
]; /* VERT_TEX_0..n */
402 GLvector4f
*IndexPtr
[2]; /* _TNL_BIT_INDEX */
403 GLvector4f
*ColorPtr
[2]; /* _TNL_BIT_COLOR0 */
404 GLvector4f
*SecondaryColorPtr
[2]; /* _TNL_BIT_COLOR1 */
405 GLvector4f
*PointSizePtr
; /* _TNL_BIT_POS */
406 GLvector4f
*FogCoordPtr
; /* _TNL_BIT_FOG */
408 struct tnl_prim
*Primitive
;
409 GLuint PrimitiveCount
;
411 /* Inputs to the vertex program stage */
412 GLvector4f
*AttribPtr
[_TNL_ATTRIB_MAX
]; /* GL_NV_vertex_program */
415 /* Private data from _tnl_render_stage that has no business being
423 /** Describes an individual operation on the pipeline.
425 struct tnl_pipeline_stage
{
427 GLuint check_state
; /* All state referenced in check() --
428 * When is the pipeline_stage struct
429 * itself invalidated? Must be
433 /* Usually constant or set by the 'check' callback:
435 GLuint run_state
; /* All state referenced in run() --
436 * When is the cached output of the
440 GLboolean active
; /* True if runnable in current state */
441 GLuint inputs
; /* VERT_* inputs to the stage */
442 GLuint outputs
; /* VERT_* outputs of the stage */
444 /* Set in _tnl_run_pipeline():
446 GLuint changed_inputs
; /* Generated value -- inputs to the
447 * stage that have changed since last
451 /* Private data for the pipeline stage:
455 /* Free private data. May not be null.
457 void (*destroy
)( struct tnl_pipeline_stage
* );
459 /* Called from _tnl_validate_pipeline(). Must update all fields in
460 * the pipeline_stage struct for the current state.
462 void (*check
)( GLcontext
*ctx
, struct tnl_pipeline_stage
* );
464 /* Called from _tnl_run_pipeline(). The stage.changed_inputs value
465 * encodes all inputs to thee struct which have changed. If
466 * non-zero, recompute all affected outputs of the stage, otherwise
467 * execute any 'sideeffects' of the stage.
469 * Return value: GL_TRUE - keep going
470 * GL_FALSE - finished pipeline
472 GLboolean (*run
)( GLcontext
*ctx
, struct tnl_pipeline_stage
* );
475 /** Contains the array of all pipeline stages.
476 * The default values are defined at the end of t_pipeline.c */
477 struct tnl_pipeline
{
478 GLuint build_state_trigger
; /**< state changes which require build */
479 GLuint build_state_changes
; /**< state changes since last build */
480 GLuint run_state_changes
; /**< state changes since last run */
481 GLuint run_input_changes
; /**< VERT_* changes since last run */
482 GLuint inputs
; /**< VERT_* inputs to pipeline */
483 /** This array has to end with a NULL-pointer. */
484 struct tnl_pipeline_stage stages
[MAX_PIPELINE_STAGES
+1];
491 typedef void (*points_func
)( GLcontext
*ctx
, GLuint first
, GLuint last
);
492 typedef void (*line_func
)( GLcontext
*ctx
, GLuint v1
, GLuint v2
);
493 typedef void (*triangle_func
)( GLcontext
*ctx
,
494 GLuint v1
, GLuint v2
, GLuint v3
);
495 typedef void (*quad_func
)( GLcontext
*ctx
, GLuint v1
, GLuint v2
,
496 GLuint v3
, GLuint v4
);
497 typedef void (*render_func
)( GLcontext
*ctx
, GLuint start
, GLuint count
,
499 typedef void (*interp_func
)( GLcontext
*ctx
,
500 GLfloat t
, GLuint dst
, GLuint out
, GLuint in
,
501 GLboolean force_boundary
);
502 typedef void (*copy_pv_func
)( GLcontext
*ctx
, GLuint dst
, GLuint src
);
503 typedef void (*setup_func
)( GLcontext
*ctx
,
504 GLuint start
, GLuint end
,
508 struct tnl_device_driver
{
513 void (*RunPipeline
)(GLcontext
*ctx
);
514 /* Replaces PipelineStart/PipelineFinish -- intended to allow
515 * drivers to wrap _tnl_run_pipeline() with code to validate state
516 * and grab/release hardware locks.
519 void (*NotifyMaterialChange
)(GLcontext
*ctx
);
520 /* Alert tnl-aware drivers of changes to material.
523 GLboolean (*NotifyBegin
)(GLcontext
*ctx
, GLenum p
);
524 /* Allow drivers to hook in optimized begin/end engines.
525 * Return value: GL_TRUE - driver handled the begin
526 * GL_FALSE - driver didn't handle the begin
530 *** Rendering -- These functions called only from t_vb_render.c
533 void (*Start
)(GLcontext
*ctx
);
534 void (*Finish
)(GLcontext
*ctx
);
535 /* Called before and after all rendering operations, including DrawPixels,
536 * ReadPixels, Bitmap, span functions, and CopyTexImage, etc commands.
537 * These are a suitable place for grabbing/releasing hardware locks.
540 void (*PrimitiveNotify
)(GLcontext
*ctx
, GLenum mode
);
541 /* Called between RenderStart() and RenderFinish() to indicate the
542 * type of primitive we're about to draw. Mode will be one of the
543 * modes accepted by glBegin().
547 /* The interp function is called by the clipping routines when we need
548 * to generate an interpolated vertex. All pertinant vertex ancilliary
549 * data should be computed by interpolating between the 'in' and 'out'
554 /* The copy function is used to make a copy of a vertex. All pertinant
555 * vertex attributes should be copied.
558 void (*ClippedPolygon
)( GLcontext
*ctx
, const GLuint
*elts
, GLuint n
);
559 /* Render a polygon with <n> vertices whose indexes are in the <elts>
563 void (*ClippedLine
)( GLcontext
*ctx
, GLuint v0
, GLuint v1
);
564 /* Render a line between the two vertices given by indexes v0 and v1. */
566 points_func Points
; /* must now respect vb->elts */
568 triangle_func Triangle
;
570 /* These functions are called in order to render points, lines,
571 * triangles and quads. These are only called via the T&L module.
574 render_func
*PrimTabVerts
;
575 render_func
*PrimTabElts
;
576 /* Render whole unclipped primitives (points, lines, linestrips,
577 * lineloops, etc). The tables are indexed by the GL enum of the
578 * primitive to be rendered. RenderTabVerts is used for non-indexed
579 * arrays of vertices. RenderTabElts is used for indexed arrays of
583 void (*ResetLineStipple
)( GLcontext
*ctx
);
584 /* Reset the hardware's line stipple counter.
587 setup_func BuildVertices
;
588 /* This function is called whenever new vertices are required for
589 * rendering. The vertices in question are those n such that start
590 * <= n < end. The new_inputs parameter indicates those fields of
591 * the vertex which need to be updated, if only a partial repair of
592 * the vertex is required.
594 * This function is called only from _tnl_render_stage in tnl/t_render.c.
598 GLboolean (*Multipass
)( GLcontext
*ctx
, GLuint passno
);
599 /* Driver may request additional render passes by returning GL_TRUE
600 * when this function is called. This function will be called
601 * after the first pass, and passes will be made until the function
602 * returns GL_FALSE. If no function is registered, only one pass
605 * This function will be first invoked with passno == 1.
615 struct tnl_device_driver Driver
;
623 struct tnl_save save
;
627 struct tnl_pipeline pipeline
;
628 struct vertex_buffer vb
;
630 /* GLvectors for binding to vb:
632 struct tnl_vertex_arrays vtx_inputs
;
633 struct tnl_vertex_arrays save_inputs
;
634 struct tnl_vertex_arrays current
;
635 struct tnl_vertex_arrays array_inputs
;
638 /* Probably need a better configuration mechanism:
640 GLboolean NeedNdcCoords
;
641 GLboolean LoopbackDListCassettes
;
642 GLboolean CalcDListNormalLengths
;
643 GLboolean IsolateMaterials
;
646 GLvertexformat exec_vtxfmt
;
647 GLvertexformat save_vtxfmt
;
653 #define TNL_CONTEXT(ctx) ((TNLcontext *)(ctx->swtnl_context))
656 #define TYPE_IDX(t) ((t) & 0xf)
657 #define MAX_TYPES TYPE_IDX(GL_DOUBLE)+1 /* 0xa + 1 */
659 extern void _tnl_MakeCurrent( GLcontext
*ctx
,
660 GLframebuffer
*drawBuffer
,
661 GLframebuffer
*readBuffer
);