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 * \file swrast/s_context.h
28 * \brief Software rasterization context and private types.
29 * \author Keith Whitwell <keith@tungstengraphics.com>
33 * \mainpage swrast module
35 * This module, software rasterization, contains the software fallback
36 * routines for drawing points, lines, triangles, bitmaps and images.
37 * All rendering boils down to writing spans (arrays) of pixels with
38 * particular colors. The span-writing routines must be implemented
39 * by the device driver.
51 typedef void (*texture_sample_func
)(GLcontext
*ctx
,
52 const struct gl_texture_object
*tObj
,
53 GLuint n
, const GLfloat texcoords
[][4],
54 const GLfloat lambda
[], GLchan rgba
[][4]);
56 typedef void (_ASMAPIP blend_func
)( GLcontext
*ctx
, GLuint n
,
58 GLvoid
*src
, const GLvoid
*dst
,
61 typedef void (*swrast_point_func
)( GLcontext
*ctx
, const SWvertex
*);
63 typedef void (*swrast_line_func
)( GLcontext
*ctx
,
64 const SWvertex
*, const SWvertex
*);
66 typedef void (*swrast_tri_func
)( GLcontext
*ctx
, const SWvertex
*,
67 const SWvertex
*, const SWvertex
*);
70 typedef void (*validate_texture_image_func
)(GLcontext
*ctx
,
71 struct gl_texture_object
*texObj
,
72 GLuint face
, GLuint level
);
77 * Bitmasks to indicate which rasterization options are enabled
81 #define ALPHATEST_BIT 0x001 /**< Alpha-test pixels */
82 #define BLEND_BIT 0x002 /**< Blend pixels */
83 #define DEPTH_BIT 0x004 /**< Depth-test pixels */
84 #define FOG_BIT 0x008 /**< Fog pixels */
85 #define LOGIC_OP_BIT 0x010 /**< Apply logic op in software */
86 #define CLIP_BIT 0x020 /**< Scissor or window clip pixels */
87 #define STENCIL_BIT 0x040 /**< Stencil pixels */
88 #define MASKING_BIT 0x080 /**< Do glColorMask or glIndexMask */
89 #define MULTI_DRAW_BIT 0x400 /**< Write to more than one color- */
90 /**< buffer or no buffers. */
91 #define OCCLUSION_BIT 0x800 /**< GL_HP_occlusion_test enabled */
92 #define TEXTURE_BIT 0x1000 /**< Texturing really enabled */
93 #define FRAGPROG_BIT 0x2000 /**< Fragment program enabled */
94 #define ATIFRAGSHADER_BIT 0x4000 /**< ATI Fragment shader enabled */
95 #define CLAMPING_BIT 0x8000 /**< Clamp colors to [0,1] */
98 #define _SWRAST_NEW_RASTERMASK (_NEW_BUFFERS| \
112 * \brief Per-context state that's private to the software rasterizer module.
116 /** Driver interface:
118 struct swrast_device_driver Driver
;
120 /** Configuration mechanisms to make software rasterizer match
121 * characteristics of the hardware rasterizer (if present):
123 GLboolean AllowVertexFog
;
124 GLboolean AllowPixelFog
;
126 /** Derived values, invalidated on statechanges, updated from
127 * _swrast_validate_derived():
129 GLbitfield _RasterMask
;
130 GLfloat _BackfaceSign
;
131 GLboolean _PreferPixelFog
; /* Compute fog blend factor per fragment? */
132 GLboolean _AnyTextureCombine
;
133 GLboolean _FogEnabled
;
134 GLenum _FogMode
; /* either GL_FOG_MODE or fragment program's fog mode */
136 /** Multiple render targets */
137 GLbitfield _ColorOutputsMask
;
138 GLuint _NumColorOutputs
;
140 /** Fragment attributes to compute during rasterization.
141 * Mask of FRAG_BIT_* flags.
143 GLbitfield _FragmentAttribs
;
144 GLuint _MinFragmentAttrib
; /**< Lowest bit set in _FragmentAttribs */
145 GLuint _MaxFragmentAttrib
; /**< Highest bit set in _FragmentAttribs + 1 */
147 /* Accum buffer temporaries.
149 GLboolean _IntegerAccumMode
; /**< Storing unscaled integers? */
150 GLfloat _IntegerAccumScaler
; /**< Implicit scale factor */
154 GLuint StippleCounter
; /**< Line stipple counter */
157 GLenum Primitive
; /* current primitive being drawn (ala glBegin) */
159 void (*InvalidateState
)( GLcontext
*ctx
, GLbitfield new_state
);
162 * When the NewState mask intersects these masks, we invalidate the
163 * Point/Line/Triangle function pointers below.
166 GLbitfield InvalidatePointMask
;
167 GLbitfield InvalidateLineMask
;
168 GLbitfield InvalidateTriangleMask
;
172 * Device drivers plug in functions for these callbacks.
173 * Will be called when the GL state change mask intersects the above masks.
176 void (*choose_point
)( GLcontext
* );
177 void (*choose_line
)( GLcontext
* );
178 void (*choose_triangle
)( GLcontext
* );
182 * Current point, line and triangle drawing functions.
185 swrast_point_func Point
;
186 swrast_line_func Line
;
187 swrast_tri_func Triangle
;
191 * Placeholders for when separate specular (or secondary color) is
192 * enabled but texturing is not.
195 swrast_point_func SpecPoint
;
196 swrast_line_func SpecLine
;
197 swrast_tri_func SpecTriangle
;
201 * Typically, we'll allocate a sw_span structure as a local variable
202 * and set its 'array' pointer to point to this object. The reason is
203 * this object is big and causes problems when allocated on the stack
206 SWspanarrays
*SpanArrays
;
209 * Used to buffer N GL_POINTS, instead of rendering one by one.
213 /** Internal hooks, kept up to date by the same mechanism as above.
215 blend_func BlendFunc
;
216 texture_sample_func TextureSample
[MAX_TEXTURE_IMAGE_UNITS
];
218 /** Buffer for saving the sampled texture colors.
219 * Needed for GL_ARB_texture_env_crossbar implementation.
223 validate_texture_image_func ValidateTextureImage
;
229 _swrast_validate_derived( GLcontext
*ctx
);
232 #define SWRAST_CONTEXT(ctx) ((SWcontext *)ctx->swrast_context)
234 #define RENDER_START(SWctx, GLctx) \
236 if ((SWctx)->Driver.SpanRenderStart) { \
237 (*(SWctx)->Driver.SpanRenderStart)(GLctx); \
241 #define RENDER_FINISH(SWctx, GLctx) \
243 if ((SWctx)->Driver.SpanRenderFinish) { \
244 (*(SWctx)->Driver.SpanRenderFinish)(GLctx); \
251 * Size of an RGBA pixel, in bytes, for given datatype.
253 #define RGBA_PIXEL_SIZE(TYPE) \
254 ((TYPE == GL_UNSIGNED_BYTE) ? 4 * sizeof(GLubyte) : \
255 ((TYPE == GL_UNSIGNED_SHORT) ? 4 * sizeof(GLushort) \
256 : 4 * sizeof(GLfloat)))
261 * XXX these macros are just bandages for now in order to make
262 * CHAN_BITS==32 compile cleanly.
263 * These should probably go elsewhere at some point.
265 #if CHAN_TYPE == GL_FLOAT
266 #define ChanToFixed(X) (X)
267 #define FixedToChan(X) (X)
269 #define ChanToFixed(X) IntToFixed(X)
270 #define FixedToChan(X) FixedToInt(X)