src/mesa/swrast/s_context.h

   1 /*
   2  * Mesa 3-D graphics library
   3  * Version:  6.5.3
   4  *
   5  * Copyright (C) 1999-2007  Brian Paul   All Rights Reserved.
   6  *
   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:
  13  *
  14  * The above copyright notice and this permission notice shall be included
  15  * in all copies or substantial portions of the Software.
  16  *
  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.
  23  */
  24
  25
  26 /**
  27  * \file swrast/s_context.h
  28  * \brief Software rasterization context and private types.
  29  * \author Keith Whitwell <keith@tungstengraphics.com>
  30  */
  31
  32 /**
  33  * \mainpage swrast module
  34  *
  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.
  40  */
  41
  42
  43 #ifndef S_CONTEXT_H
  44 #define S_CONTEXT_H
  45
  46 #include "main/compiler.h"
  47 #include "main/mtypes.h"
  48 #include "program/prog_execute.h"
  49 #include "swrast.h"
  50 #include "s_span.h"
  51
  52
  53 typedef void (*texture_sample_func)(struct gl_context *ctx,
  54                                     const struct gl_texture_object *tObj,
  55                                     GLuint n, const GLfloat texcoords[][4],
  56                                     const GLfloat lambda[], GLfloat rgba[][4]);
  57
  58 typedef void (_ASMAPIP blend_func)( struct gl_context *ctx, GLuint n,
  59                                     const GLubyte mask[],
  60                                     GLvoid *src, const GLvoid *dst,
  61                                     GLenum chanType);
  62
  63 typedef void (*swrast_point_func)( struct gl_context *ctx, const SWvertex *);
  64
  65 typedef void (*swrast_line_func)( struct gl_context *ctx,
  66                                   const SWvertex *, const SWvertex *);
  67
  68 typedef void (*swrast_tri_func)( struct gl_context *ctx, const SWvertex *,
  69                                  const SWvertex *, const SWvertex *);
  70
  71
  72 typedef void (*validate_texture_image_func)(struct gl_context *ctx,
  73                                             struct gl_texture_object *texObj,
  74                                             GLuint face, GLuint level);
  75
  76
  77 /**
  78  * \defgroup Bitmasks
  79  * Bitmasks to indicate which rasterization options are enabled
  80  * (RasterMask)
  81  */
  82 /*@{*/
  83 #define ALPHATEST_BIT           0x001   /**< Alpha-test pixels */
  84 #define BLEND_BIT               0x002   /**< Blend pixels */
  85 #define DEPTH_BIT               0x004   /**< Depth-test pixels */
  86 #define FOG_BIT                 0x008   /**< Fog pixels */
  87 #define LOGIC_OP_BIT            0x010   /**< Apply logic op in software */
  88 #define CLIP_BIT                0x020   /**< Scissor or window clip pixels */
  89 #define STENCIL_BIT             0x040   /**< Stencil pixels */
  90 #define MASKING_BIT             0x080   /**< Do glColorMask or glIndexMask */
  91 #define MULTI_DRAW_BIT          0x400   /**< Write to more than one color- */
  92                                         /**< buffer or no buffers. */
  93 #define OCCLUSION_BIT           0x800   /**< GL_HP_occlusion_test enabled */
  94 #define TEXTURE_BIT             0x1000  /**< Texturing really enabled */
  95 #define FRAGPROG_BIT            0x2000  /**< Fragment program enabled */
  96 #define ATIFRAGSHADER_BIT       0x4000  /**< ATI Fragment shader enabled */
  97 #define CLAMPING_BIT            0x8000  /**< Clamp colors to [0,1] */
  98 /*@}*/
  99
 100 #define _SWRAST_NEW_RASTERMASK (_NEW_BUFFERS|   \
 101                                 _NEW_SCISSOR|   \
 102                                 _NEW_COLOR|     \
 103                                 _NEW_DEPTH|     \
 104                                 _NEW_FOG|       \
 105                                 _NEW_PROGRAM|   \
 106                                 _NEW_STENCIL|   \
 107                                 _NEW_TEXTURE|   \
 108                                 _NEW_VIEWPORT|  \
 109                                 _NEW_DEPTH)
 110
 111
 112 struct swrast_texture_image;
 113
 114
 115 /**
 116  * Fetch a texel from texture image at given position.
 117  */
 118 typedef void (*FetchTexelFunc)(const struct swrast_texture_image *texImage,
 119                                GLint col, GLint row, GLint img,
 120                                GLfloat *texelOut);
 121
 122
 123 typedef void (*StoreTexelFunc)(struct swrast_texture_image *texImage,
 124                                GLint col, GLint row, GLint img,
 125                                const void *texel);
 126
 127 /**
 128  * Subclass of gl_texture_image.
 129  * We need extra fields/info to keep tracking of mapped texture buffers,
 130  * strides and Fetch/Store functions.
 131  */
 132 struct swrast_texture_image
 133 {
 134    struct gl_texture_image Base;
 135
 136    GLboolean _IsPowerOfTwo;  /**< Are all dimensions powers of two? */
 137
 138    /** used for mipmap LOD computation */
 139    GLfloat WidthScale, HeightScale, DepthScale;
 140
 141    /** These fields only valid when texture memory is mapped */
 142    GLint RowStride;             /**< Padded width in units of texels */
 143    GLuint *ImageOffsets;        /**< if 3D texture: array [Depth] of offsets to
 144                                      each 2D slice in 'Data', in texels */
 145    GLubyte *Data;               /**< Image data, accessed via FetchTexel() */
 146
 147    /** Malloc'd texture memory */
 148    GLubyte *Buffer;
 149
 150    FetchTexelFunc FetchTexel;
 151    StoreTexelFunc Store;
 152 };
 153
 154
 155 /** cast wrapper */
 156 static inline struct swrast_texture_image *
 157 swrast_texture_image(struct gl_texture_image *img)
 158 {
 159    return (struct swrast_texture_image *) img;
 160 }
 161
 162 /** cast wrapper */
 163 static inline const struct swrast_texture_image *
 164 swrast_texture_image_const(const struct gl_texture_image *img)
 165 {
 166    return (const struct swrast_texture_image *) img;
 167 }
 168
 169
 170 /**
 171  * \struct SWcontext
 172  * \brief  Per-context state that's private to the software rasterizer module.
 173  */
 174 typedef struct
 175 {
 176    /** Driver interface:
 177     */
 178    struct swrast_device_driver Driver;
 179
 180    /** Configuration mechanisms to make software rasterizer match
 181     * characteristics of the hardware rasterizer (if present):
 182     */
 183    GLboolean AllowVertexFog;
 184    GLboolean AllowPixelFog;
 185
 186    /** Derived values, invalidated on statechanges, updated from
 187     * _swrast_validate_derived():
 188     */
 189    GLbitfield _RasterMask;
 190    GLfloat _BackfaceSign;      /** +1 or -1 */
 191    GLfloat _BackfaceCullSign;  /** +1, 0, or -1 */
 192    GLboolean _PreferPixelFog;    /* Compute fog blend factor per fragment? */
 193    GLboolean _TextureCombinePrimary;
 194    GLboolean _FogEnabled;
 195    GLboolean _DeferredTexture;
 196
 197    /** List/array of the fragment attributes to interpolate */
 198    GLuint _ActiveAttribs[FRAG_ATTRIB_MAX];
 199    /** Same info, but as a bitmask */
 200    GLbitfield _ActiveAttribMask;
 201    /** Number of fragment attributes to interpolate */
 202    GLuint _NumActiveAttribs;
 203    /** Indicates how each attrib is to be interpolated (lines/tris) */
 204    GLenum _InterpMode[FRAG_ATTRIB_MAX]; /* GL_FLAT or GL_SMOOTH (for now) */
 205
 206    /* Working values:
 207     */
 208    GLuint StippleCounter;    /**< Line stipple counter */
 209    GLuint PointLineFacing;
 210    GLbitfield NewState;
 211    GLuint StateChanges;
 212    GLenum Primitive;    /* current primitive being drawn (ala glBegin) */
 213    GLboolean SpecularVertexAdd; /**< Add specular/secondary color per vertex */
 214
 215    void (*InvalidateState)( struct gl_context *ctx, GLbitfield new_state );
 216
 217    /**
 218     * When the NewState mask intersects these masks, we invalidate the
 219     * Point/Line/Triangle function pointers below.
 220     */
 221    /*@{*/
 222    GLbitfield InvalidatePointMask;
 223    GLbitfield InvalidateLineMask;
 224    GLbitfield InvalidateTriangleMask;
 225    /*@}*/
 226
 227    /**
 228     * Device drivers plug in functions for these callbacks.
 229     * Will be called when the GL state change mask intersects the above masks.
 230     */
 231    /*@{*/
 232    void (*choose_point)( struct gl_context * );
 233    void (*choose_line)( struct gl_context * );
 234    void (*choose_triangle)( struct gl_context * );
 235    /*@}*/
 236
 237    /**
 238     * Current point, line and triangle drawing functions.
 239     */
 240    /*@{*/
 241    swrast_point_func Point;
 242    swrast_line_func Line;
 243    swrast_tri_func Triangle;
 244    /*@}*/
 245
 246    /**
 247     * Placeholders for when separate specular (or secondary color) is
 248     * enabled but texturing is not.
 249     */
 250    /*@{*/
 251    swrast_point_func SpecPoint;
 252    swrast_line_func SpecLine;
 253    swrast_tri_func SpecTriangle;
 254    /*@}*/
 255
 256    /**
 257     * Typically, we'll allocate a sw_span structure as a local variable
 258     * and set its 'array' pointer to point to this object.  The reason is
 259     * this object is big and causes problems when allocated on the stack
 260     * on some systems.
 261     */
 262    SWspanarrays *SpanArrays;
 263    SWspanarrays *ZoomedArrays;  /**< For pixel zooming */
 264
 265    /**
 266     * Used to buffer N GL_POINTS, instead of rendering one by one.
 267     */
 268    SWspan PointSpan;
 269
 270    /** Internal hooks, kept up to date by the same mechanism as above.
 271     */
 272    blend_func BlendFunc;
 273    texture_sample_func TextureSample[MAX_TEXTURE_IMAGE_UNITS];
 274
 275    /** Buffer for saving the sampled texture colors.
 276     * Needed for GL_ARB_texture_env_crossbar implementation.
 277     */
 278    GLfloat *TexelBuffer;
 279
 280    validate_texture_image_func ValidateTextureImage;
 281
 282    /** State used during execution of fragment programs */
 283    struct gl_program_machine FragProgMachine;
 284
 285 } SWcontext;
 286
 287
 288 extern void
 289 _swrast_validate_derived( struct gl_context *ctx );
 290
 291 extern void
 292 _swrast_update_texture_samplers(struct gl_context *ctx);
 293
 294
 295 /** Return SWcontext for the given struct gl_context */
 296 static inline SWcontext *
 297 SWRAST_CONTEXT(struct gl_context *ctx)
 298 {
 299    return (SWcontext *) ctx->swrast_context;
 300 }
 301
 302 /** const version of above */
 303 static inline const SWcontext *
 304 CONST_SWRAST_CONTEXT(const struct gl_context *ctx)
 305 {
 306    return (const SWcontext *) ctx->swrast_context;
 307 }
 308
 309
 310 /**
 311  * Called prior to framebuffer reading/writing.
 312  * For drivers that rely on swrast for fallback rendering, this is the
 313  * driver's opportunity to map renderbuffers and textures.
 314  */
 315 static inline void
 316 swrast_render_start(struct gl_context *ctx)
 317 {
 318    SWcontext *swrast = SWRAST_CONTEXT(ctx);
 319    if (swrast->Driver.SpanRenderStart)
 320       swrast->Driver.SpanRenderStart(ctx);
 321 }
 322
 323
 324 /** Called after framebuffer reading/writing */
 325 static inline void
 326 swrast_render_finish(struct gl_context *ctx)
 327 {
 328    SWcontext *swrast = SWRAST_CONTEXT(ctx);
 329    if (swrast->Driver.SpanRenderFinish)
 330       swrast->Driver.SpanRenderFinish(ctx);
 331 }
 332
 333
 334 extern void
 335 _swrast_span_render_start(struct gl_context *ctx);
 336
 337 extern void
 338 _swrast_span_render_finish(struct gl_context *ctx);
 339
 340 extern void
 341 _swrast_map_textures(struct gl_context *ctx);
 342
 343 extern void
 344 _swrast_unmap_textures(struct gl_context *ctx);
 345
 346 extern void
 347 _swrast_map_texture(struct gl_context *ctx, struct gl_texture_object *texObj);
 348
 349 extern void
 350 _swrast_unmap_texture(struct gl_context *ctx, struct gl_texture_object *texObj);
 351
 352
 353 extern void
 354 _swrast_map_renderbuffers(struct gl_context *ctx);
 355
 356 extern void
 357 _swrast_unmap_renderbuffers(struct gl_context *ctx);
 358
 359
 360 /**
 361  * Size of an RGBA pixel, in bytes, for given datatype.
 362  */
 363 #define RGBA_PIXEL_SIZE(TYPE)                                     \
 364          ((TYPE == GL_UNSIGNED_BYTE) ? 4 * sizeof(GLubyte) :      \
 365           ((TYPE == GL_UNSIGNED_SHORT) ? 4 * sizeof(GLushort)     \
 366            : 4 * sizeof(GLfloat)))
 367
 368
 369
 370 /*
 371  * Fixed point arithmetic macros
 372  */
 373 #ifndef FIXED_FRAC_BITS
 374 #define FIXED_FRAC_BITS 11
 375 #endif
 376
 377 #define FIXED_SHIFT     FIXED_FRAC_BITS
 378 #define FIXED_ONE       (1 << FIXED_SHIFT)
 379 #define FIXED_HALF      (1 << (FIXED_SHIFT-1))
 380 #define FIXED_FRAC_MASK (FIXED_ONE - 1)
 381 #define FIXED_INT_MASK  (~FIXED_FRAC_MASK)
 382 #define FIXED_EPSILON   1
 383 #define FIXED_SCALE     ((float) FIXED_ONE)
 384 #define FIXED_DBL_SCALE ((double) FIXED_ONE)
 385 #define FloatToFixed(X) (IROUND((X) * FIXED_SCALE))
 386 #define FixedToDouble(X) ((X) * (1.0 / FIXED_DBL_SCALE))
 387 #define IntToFixed(I)   ((I) << FIXED_SHIFT)
 388 #define FixedToInt(X)   ((X) >> FIXED_SHIFT)
 389 #define FixedToUns(X)   (((unsigned int)(X)) >> FIXED_SHIFT)
 390 #define FixedCeil(X)    (((X) + FIXED_ONE - FIXED_EPSILON) & FIXED_INT_MASK)
 391 #define FixedFloor(X)   ((X) & FIXED_INT_MASK)
 392 #define FixedToFloat(X) ((X) * (1.0F / FIXED_SCALE))
 393 #define PosFloatToFixed(X)      FloatToFixed(X)
 394 #define SignedFloatToFixed(X)   FloatToFixed(X)
 395
 396
 397
 398 /*
 399  * XXX these macros are just bandages for now in order to make
 400  * CHAN_BITS==32 compile cleanly.
 401  * These should probably go elsewhere at some point.
 402  */
 403 #if CHAN_TYPE == GL_FLOAT
 404 #define ChanToFixed(X)  (X)
 405 #define FixedToChan(X)  (X)
 406 #else
 407 #define ChanToFixed(X)  IntToFixed(X)
 408 #define FixedToChan(X)  FixedToInt(X)
 409 #endif
 410
 411
 412 /**
 413  * For looping over fragment attributes in the pointe, line
 414  * triangle rasterizers.
 415  */
 416 #define ATTRIB_LOOP_BEGIN                                \
 417    {                                                     \
 418       GLuint a;                                          \
 419       for (a = 0; a < swrast->_NumActiveAttribs; a++) {  \
 420          const GLuint attr = swrast->_ActiveAttribs[a];
 421
 422 #define ATTRIB_LOOP_END } }
 423
 424
 425 /**
 426  * Return the address of a pixel value in a mapped renderbuffer.
 427  */
 428 static inline GLubyte *
 429 _swrast_pixel_address(struct gl_renderbuffer *rb, GLint x, GLint y)
 430 {
 431    const GLint bpp = _mesa_get_format_bytes(rb->Format);
 432    const GLint rowStride = rb->RowStride * bpp;
 433    return (GLubyte *) rb->Data + y * rowStride + x * bpp;
 434 }
 435
 436
 437
 438 #endif