1 /* $Id: t_context.h,v 1.28 2001/06/04 16:09:28 keithw Exp $ */
4 * Mesa 3-D graphics library
7 * Copyright (C) 1999-2001 Brian Paul All Rights Reserved.
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:
16 * The above copyright notice and this permission notice shall be included
17 * in all copies or substantial portions of the Software.
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.
27 * Keith Whitwell <keithw@valinux.com>
36 #include "math/m_matrix.h"
37 #include "math/m_vector.h"
38 #include "math/m_xform.h"
41 #define MAX_PIPELINE_STAGES 30
44 /* Numbers for sizing immediate structs.
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)
51 /* Values for IM->BeginState
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 */
59 /* Flags to be added to the primitive enum in VB->Primitive.
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 */
68 /* Flags that describe the inputs and outputs of pipeline stages, and
69 * the contents of a vertex-cassette.
71 * 5 spare flags, rearrangement of eval flags can secure at least 3
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*/
105 /* Flags for IM->TexCoordSize. Enough flags for 16 units.
107 #define TEX_0_SIZE_3 0x1
108 #define TEX_0_SIZE_4 0x1001
109 #define TEX_SIZE_3(unit) (TEX_0_SIZE_3<<unit)
110 #define TEX_SIZE_4(unit) (TEX_0_SIZE_4<<unit)
115 #define VERT_EVAL_ANY (VERT_EVAL_C1|VERT_EVAL_P1| \
116 VERT_EVAL_C2|VERT_EVAL_P2)
118 #define VERT_OBJ_23 (VERT_OBJ_3|VERT_OBJ)
119 #define VERT_OBJ_234 (VERT_OBJ_4|VERT_OBJ_23)
121 #define VERT_TEX0_SHIFT 11
123 #define VERT_TEX(i) (VERT_TEX0 << i)
125 #define VERT_TEX_ANY (VERT_TEX0 | \
134 #define VERT_FIXUP (VERT_TEX_ANY | \
142 #define VERT_CURRENT_DATA (VERT_FIXUP | \
145 #define VERT_DATA (VERT_TEX_ANY | \
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.
164 struct __GLcontextRec
*backref
;
165 GLuint id
, ref_count
;
167 /* This must be saved when immediates are shared in display lists.
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
;
176 GLuint ArrayEltFlags
; /* precalc'ed for glArrayElt */
178 GLuint ArrayEltFlush
;
180 #define FLUSH_ELT_EAGER 0x1
181 #define FLUSH_ELT_LAZY 0x2
184 GLuint MaxTextureUnits
; /* precalc'ed for glMultiTexCoordARB */
186 /* Temporary values created when vertices are copied into the
187 * first 3 slots of the struct:
194 /* allocate storage for these on demand:
196 struct gl_material (*Material
)[2];
197 GLuint
*MaterialMask
;
199 GLuint MaterialOrMask
;
200 GLuint MaterialAndMask
;
202 GLfloat (*TexCoord
[MAX_TEXTURE_UNITS
])[4];
204 GLuint Primitive
[IMM_SIZE
]; /* BEGIN/END */
205 GLuint PrimitiveLength
[IMM_SIZE
]; /* BEGIN/END */
206 GLuint Flag
[IMM_SIZE
]; /* VERT_* flags */
207 GLfloat Color
[IMM_SIZE
][4];
208 GLfloat Obj
[IMM_SIZE
][4];
209 GLfloat Normal
[IMM_SIZE
][3];
210 GLfloat TexCoord0
[IMM_SIZE
][4]; /* just VERT_TEX0 */
211 GLuint Elt
[IMM_SIZE
];
212 GLubyte EdgeFlag
[IMM_SIZE
];
213 GLuint Index
[IMM_SIZE
];
214 GLfloat SecondaryColor
[IMM_SIZE
][4];
215 GLfloat FogCoord
[IMM_SIZE
];
223 struct gl_client_array Color
;
224 struct gl_client_array SecondaryColor
;
226 GLvector1ub EdgeFlag
;
227 GLvector4f TexCoord
[MAX_TEXTURE_UNITS
];
233 typedef struct gl_material GLmaterial
;
235 /* Contains the current state of a running pipeline.
237 typedef struct vertex_buffer
239 /* Constant over life of the vertex_buffer.
243 /* Constant over the pipeline.
245 GLuint Count
; /* for everything except Elts */
246 GLuint FirstClipped
; /* temp verts for clipping */
247 GLuint FirstPrimitive
; /* usually zero */
249 /* Pointers to current data.
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 GLboolean
*EdgeFlag
; /* VERT_EDGE */
260 GLvector4f
*TexCoordPtr
[MAX_TEXTURE_UNITS
]; /* VERT_TEX_0..n */
261 GLvector1ui
*IndexPtr
[2]; /* VERT_INDEX */
262 struct gl_client_array
*ColorPtr
[2]; /* VERT_RGBA */
263 struct gl_client_array
*SecondaryColorPtr
[2]; /* VERT_SPEC_RGB */
264 GLvector1f
*FogCoordPtr
; /* VERT_FOG_COORD */
265 GLvector1f
*PointSizePtr
; /* VERT_POINT_SIZE */
266 GLmaterial (*Material
)[2]; /* VERT_MATERIAL, optional */
267 GLuint
*MaterialMask
; /* VERT_MATERIAL, optional */
268 GLuint
*Flag
; /* VERT_* flags, optional */
269 GLuint
*Primitive
; /* GL_(mode)|PRIM_* flags */
270 GLuint
*PrimitiveLength
; /* integers */
273 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.
280 * This is currently only necessary for client arrays that make it
281 * as far down the pipeline as the render stage.
285 /* Private data from _tnl_render_stage that has no business being
293 /* Describes an individual operation on the pipeline.
295 struct gl_pipeline_stage
{
297 GLuint check_state
; /* All state referenced in check() --
298 * When is the pipeline_stage struct
299 * itself invalidated? Must be
303 /* Usually constant or set by the 'check' callback:
305 GLuint run_state
; /* All state referenced in run() --
306 * When is the cached output of the
310 GLboolean active
; /* True if runnable in current state */
311 GLuint inputs
; /* VERT_* inputs to the stage */
312 GLuint outputs
; /* VERT_* outputs of the stage */
314 /* Set in _tnl_run_pipeline():
316 GLuint changed_inputs
; /* Generated value -- inputs to the
317 * stage that have changed since last
321 /* Private data for the pipeline stage:
325 /* Free private data. May not be null.
327 void (*destroy
)( struct gl_pipeline_stage
* );
329 /* Called from _tnl_validate_pipeline(). Must update all fields in
330 * the pipeline_stage struct for the current state.
332 void (*check
)( GLcontext
*ctx
, struct gl_pipeline_stage
* );
334 /* Called from _tnl_run_pipeline(). The stage.changed_inputs value
335 * encodes all inputs to thee struct which have changed. If
336 * non-zero, recompute all affected outputs of the stage, otherwise
337 * execute any 'sideeffects' of the stage.
339 * Return value: GL_TRUE - keep going
340 * GL_FALSE - finished pipeline
342 GLboolean (*run
)( GLcontext
*ctx
, struct gl_pipeline_stage
* );
347 GLuint build_state_trigger
; /* state changes which require build */
348 GLuint build_state_changes
; /* state changes since last build */
349 GLuint run_state_changes
; /* state changes since last run */
350 GLuint run_input_changes
; /* VERT_* changes since last run */
351 GLuint inputs
; /* VERT_* inputs to pipeline */
352 struct gl_pipeline_stage stages
[MAX_PIPELINE_STAGES
+1];
357 struct tnl_eval_store
{
358 GLuint EvalMap1Flags
;
359 GLuint EvalMap2Flags
;
361 struct immediate
*im
; /* used for temporary data */
365 typedef void (*points_func
)( GLcontext
*ctx
, GLuint first
, GLuint last
);
366 typedef void (*line_func
)( GLcontext
*ctx
, GLuint v1
, GLuint v2
);
367 typedef void (*triangle_func
)( GLcontext
*ctx
,
368 GLuint v1
, GLuint v2
, GLuint v3
);
369 typedef void (*quad_func
)( GLcontext
*ctx
, GLuint v1
, GLuint v2
,
370 GLuint v3
, GLuint v4
);
371 typedef void (*render_func
)( GLcontext
*ctx
, GLuint start
, GLuint count
,
373 typedef void (*interp_func
)( GLcontext
*ctx
,
374 GLfloat t
, GLuint dst
, GLuint out
, GLuint in
,
375 GLboolean force_boundary
);
376 typedef void (*copy_pv_func
)( GLcontext
*ctx
, GLuint dst
, GLuint src
);
379 struct tnl_device_driver
{
384 void (*RunPipeline
)(GLcontext
*ctx
);
385 /* Replaces PipelineStart/PipelineFinish -- intended to allow
386 * drivers to wrap _tnl_run_pipeline() with code to validate state
387 * and grab/release hardware locks.
394 void (*RenderStart
)(GLcontext
*ctx
);
395 void (*RenderFinish
)(GLcontext
*ctx
);
396 /* Called before and after all rendering operations, including DrawPixels,
397 * ReadPixels, Bitmap, span functions, and CopyTexImage, etc commands.
398 * These are a suitable place for grabbing/releasing hardware locks.
401 void (*RenderPrimitive
)(GLcontext
*ctx
, GLenum mode
);
402 /* Called between RednerStart() and RenderFinish() to indicate the
403 * type of primitive we're about to draw. Mode will be one of the
404 * modes accepted by glBegin().
407 interp_func RenderInterp
;
408 /* The interp function is called by the clipping routines when we need
409 * to generate an interpolated vertex. All pertinant vertex ancilliary
410 * data should be computed by interpolating between the 'in' and 'out'
414 copy_pv_func RenderCopyPV
;
415 /* The copy function is used to make a copy of a vertex. All pertinant
416 * vertex attributes should be copied.
419 void (*RenderClippedPolygon
)( GLcontext
*ctx
, const GLuint
*elts
, GLuint n
);
420 /* Render a polygon with <n> vertices whose indexes are in the <elts>
424 void (*RenderClippedLine
)( GLcontext
*ctx
, GLuint v0
, GLuint v1
);
425 /* Render a line between the two vertices given by indexes v0 and v1. */
427 points_func PointsFunc
; /* must now respect vb->elts */
429 triangle_func TriangleFunc
;
431 /* These functions are called in order to render points, lines,
432 * triangles and quads. These are only called via the T&L module.
435 render_func
*RenderTabVerts
;
436 render_func
*RenderTabElts
;
437 /* Render whole unclipped primitives (points, lines, linestrips,
438 * lineloops, etc). The tables are indexed by the GL enum of the
439 * primitive to be rendered. RenderTabVerts is used for non-indexed
440 * arrays of vertices. RenderTabElts is used for indexed arrays of
444 void (*ResetLineStipple
)( GLcontext
*ctx
);
445 /* Reset the hardware's line stipple counter.
448 void (*BuildProjectedVertices
)( GLcontext
*ctx
,
449 GLuint start
, GLuint end
,
451 /* This function is called whenever new vertices are required for
452 * rendering. The vertices in question are those n such that start
453 * <= n < end. The new_inputs parameter indicates those fields of
454 * the vertex which need to be updated, if only a partial repair of
455 * the vertex is required.
457 * This function is called only from _tnl_render_stage in tnl/t_render.c.
461 GLboolean (*MultipassFunc
)( GLcontext
*ctx
, GLuint passno
);
462 /* Driver may request additional render passes by returning GL_TRUE
463 * when this function is called. This function will be called
464 * after the first pass, and passes will be made until the function
465 * returns GL_FALSE. If no function is registered, only one pass
468 * This function will be first invoked with passno == 1.
477 struct tnl_device_driver Driver
;
479 /* Track whether the module is active.
481 GLboolean bound_exec
;
483 /* Display list extensions
485 GLuint opcode_vertex_cassette
;
489 struct gl_pipeline pipeline
;
490 struct vertex_buffer vb
;
492 /* GLvectors for binding to vb:
494 struct vertex_arrays imm_inputs
;
495 struct vertex_arrays array_inputs
;
496 GLuint
*tmp_primitive
;
497 GLuint
*tmp_primitive_length
;
499 /* Set when executing an internally generated begin/end object. If
500 * such an object is encountered in a display list, it will be
501 * replayed only if the list is outside any existing begin/end
504 GLboolean ReplayHardBeginEnd
;
506 /* Note which vertices need copying over succesive immediates.
507 * Will add save versions to precompute vertex copying where
510 struct immediate
*ExecCopySource
;
511 GLuint ExecCopyCount
;
512 GLuint ExecCopyElts
[IMM_MAX_COPIED_VERTS
];
513 GLuint ExecCopyTexSize
;
516 GLuint DlistPrimitive
;
517 GLuint DlistPrimitiveLength
;
518 GLuint DlistLastPrimitive
;
520 /* Cache a single free immediate (refcount == 0)
522 struct immediate
*freed_immediate
;
524 /* Probably need a better configuration mechanism:
526 GLboolean NeedProjCoords
;
527 GLboolean LoopbackDListCassettes
;
529 /* Derived state and storage for _tnl_eval_vb:
531 struct tnl_eval_store eval
;
533 /* Functions to be plugged into dispatch when tnl is active.
535 GLvertexformat vtxfmt
;
541 #define TNL_CONTEXT(ctx) ((TNLcontext *)(ctx->swtnl_context))
542 #define TNL_CURRENT_IM(ctx) ((struct immediate *)(ctx->swtnl_im))
545 #define TYPE_IDX(t) ((t) & 0xf)
546 #define MAX_TYPES TYPE_IDX(GL_DOUBLE)+1 /* 0xa + 1 */
548 extern void _tnl_MakeCurrent( GLcontext
*ctx
,
549 GLframebuffer
*drawBuffer
,
550 GLframebuffer
*readBuffer
);
554 * Macros for fetching current input buffer.
557 #define GET_IMMEDIATE struct immediate *IM = TNL_CURRENT_IM(((GLcontext *) (_glapi_Context ? _glapi_Context : _glapi_get_context())))
558 #define SET_IMMEDIATE(ctx, im) ctx->swtnl_im = (void *)im
560 extern struct immediate
*_tnl_CurrentInput
;
561 #define GET_IMMEDIATE struct immediate *IM = _tnl_CurrentInput
562 #define SET_IMMEDIATE(ctx, im) \
564 ctx->swtnl_im = (void *)im; \
565 _tnl_CurrentInput = im; \