reactos/dll/opengl/mesa/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 TEXTURE_BIT             0x1000  /**< Texturing really enabled */
  94 #define FRAGPROG_BIT            0x2000  /**< Fragment program enabled */
  95 #define CLAMPING_BIT            0x8000  /**< Clamp colors to [0,1] */
  96 /*@}*/
  97
  98 #define _SWRAST_NEW_RASTERMASK (_NEW_BUFFERS|   \
  99                                 _NEW_SCISSOR|   \
 100                                 _NEW_COLOR|     \
 101                                 _NEW_DEPTH|     \
 102                                 _NEW_FOG|       \
 103                                 _NEW_PROGRAM|   \
 104                                 _NEW_STENCIL|   \
 105                                 _NEW_TEXTURE|   \
 106                                 _NEW_VIEWPORT|  \
 107                                 _NEW_DEPTH)
 108
 109
 110 struct swrast_texture_image;
 111
 112
 113 /**
 114  * Fetch a texel from texture image at given position.
 115  */
 116 typedef void (*FetchTexelFunc)(const struct swrast_texture_image *texImage,
 117                                GLint col, GLint row, GLint img,
 118                                GLfloat *texelOut);
 119
 120
 121 /**
 122  * Subclass of gl_texture_image.
 123  * We need extra fields/info to keep tracking of mapped texture buffers,
 124  * strides and Fetch functions.
 125  */
 126 struct swrast_texture_image
 127 {
 128    struct gl_texture_image Base;
 129
 130    GLboolean _IsPowerOfTwo;  /**< Are all dimensions powers of two? */
 131
 132    /** used for mipmap LOD computation */
 133    GLfloat WidthScale, HeightScale, DepthScale;
 134
 135    /** These fields only valid when texture memory is mapped */
 136    GLint RowStride;             /**< Padded width in units of texels */
 137    GLuint *ImageOffsets;        /**< if 3D texture: array [Depth] of offsets to
 138                                      each 2D slice in 'Data', in texels */
 139    GLubyte *Map;                /**< Pointer to mapped image memory */
 140
 141    /** Malloc'd texture memory */
 142    GLubyte *Buffer;
 143
 144    FetchTexelFunc FetchTexel;
 145 };
 146
 147
 148 /** cast wrapper */
 149 static inline struct swrast_texture_image *
 150 swrast_texture_image(struct gl_texture_image *img)
 151 {
 152    return (struct swrast_texture_image *) img;
 153 }
 154
 155 /** cast wrapper */
 156 static inline const struct swrast_texture_image *
 157 swrast_texture_image_const(const struct gl_texture_image *img)
 158 {
 159    return (const struct swrast_texture_image *) img;
 160 }
 161
 162
 163 /**
 164  * Subclass of gl_renderbuffer with extra fields needed for software
 165  * rendering.
 166  */
 167 struct swrast_renderbuffer
 168 {
 169    struct gl_renderbuffer Base;
 170
 171    GLubyte *Buffer;     /**< The malloc'd memory for buffer */
 172
 173    /** These fields are only valid while buffer is mapped for rendering */
 174    GLubyte *Map;
 175    GLint RowStride;    /**< in bytes */
 176
 177    /** For span rendering */
 178    GLenum ColorType;
 179 };
 180
 181
 182 /** cast wrapper */
 183 static inline struct swrast_renderbuffer *
 184 swrast_renderbuffer(struct gl_renderbuffer *img)
 185 {
 186    return (struct swrast_renderbuffer *) img;
 187 }
 188
 189
 190
 191 /**
 192  * \struct SWcontext
 193  * \brief  Per-context state that's private to the software rasterizer module.
 194  */
 195 typedef struct
 196 {
 197    /** Driver interface:
 198     */
 199    struct swrast_device_driver Driver;
 200
 201    /** Configuration mechanisms to make software rasterizer match
 202     * characteristics of the hardware rasterizer (if present):
 203     */
 204    GLboolean AllowVertexFog;
 205    GLboolean AllowPixelFog;
 206
 207    /** Derived values, invalidated on statechanges, updated from
 208     * _swrast_validate_derived():
 209     */
 210    GLbitfield _RasterMask;
 211    GLfloat _BackfaceSign;      /** +1 or -1 */
 212    GLfloat _BackfaceCullSign;  /** +1, 0, or -1 */
 213    GLboolean _PreferPixelFog;    /* Compute fog blend factor per fragment? */
 214    GLboolean _TextureCombinePrimary;
 215    GLboolean _FogEnabled;
 216    GLboolean _DeferredTexture;
 217
 218    /** List/array of the fragment attributes to interpolate */
 219    GLuint _ActiveAttribs[FRAG_ATTRIB_MAX];
 220    /** Same info, but as a bitmask of FRAG_BIT_x bits */
 221    GLbitfield64 _ActiveAttribMask;
 222    /** Number of fragment attributes to interpolate */
 223    GLuint _NumActiveAttribs;
 224    /** Indicates how each attrib is to be interpolated (lines/tris) */
 225    GLenum _InterpMode[FRAG_ATTRIB_MAX]; /* GL_FLAT or GL_SMOOTH (for now) */
 226
 227    /* Working values:
 228     */
 229    GLuint StippleCounter;    /**< Line stipple counter */
 230    GLuint PointLineFacing;
 231    GLbitfield NewState;
 232    GLuint StateChanges;
 233    GLenum Primitive;    /* current primitive being drawn (ala glBegin) */
 234    GLboolean SpecularVertexAdd; /**< Add specular/secondary color per vertex */
 235
 236    void (*InvalidateState)( struct gl_context *ctx, GLbitfield new_state );
 237
 238    /**
 239     * When the NewState mask intersects these masks, we invalidate the
 240     * Point/Line/Triangle function pointers below.
 241     */
 242    /*@{*/
 243    GLbitfield InvalidatePointMask;
 244    GLbitfield InvalidateLineMask;
 245    GLbitfield InvalidateTriangleMask;
 246    /*@}*/
 247
 248    /**
 249     * Device drivers plug in functions for these callbacks.
 250     * Will be called when the GL state change mask intersects the above masks.
 251     */
 252    /*@{*/
 253    void (*choose_point)( struct gl_context * );
 254    void (*choose_line)( struct gl_context * );
 255    void (*choose_triangle)( struct gl_context * );
 256    /*@}*/
 257
 258    /**
 259     * Current point, line and triangle drawing functions.
 260     */
 261    /*@{*/
 262    swrast_point_func Point;
 263    swrast_line_func Line;
 264    swrast_tri_func Triangle;
 265    /*@}*/
 266
 267    /**
 268     * Placeholders for when separate specular (or secondary color) is
 269     * enabled but texturing is not.
 270     */
 271    /*@{*/
 272    swrast_point_func SpecPoint;
 273    swrast_line_func SpecLine;
 274    swrast_tri_func SpecTriangle;
 275    /*@}*/
 276
 277    /**
 278     * Typically, we'll allocate a sw_span structure as a local variable
 279     * and set its 'array' pointer to point to this object.  The reason is
 280     * this object is big and causes problems when allocated on the stack
 281     * on some systems.
 282     */
 283    SWspanarrays *SpanArrays;
 284    SWspanarrays *ZoomedArrays;  /**< For pixel zooming */
 285
 286    /**
 287     * Used to buffer N GL_POINTS, instead of rendering one by one.
 288     */
 289    SWspan PointSpan;
 290
 291    /** Internal hooks, kept up to date by the same mechanism as above.
 292     */
 293    blend_func BlendFunc;
 294    texture_sample_func TextureSample[MAX_TEXTURE_IMAGE_UNITS];
 295
 296    /** Buffer for saving the sampled texture colors.
 297     * Needed for GL_ARB_texture_env_crossbar implementation.
 298     */
 299    GLfloat *TexelBuffer;
 300
 301    validate_texture_image_func ValidateTextureImage;
 302
 303    /** State used during execution of fragment programs */
 304    struct gl_program_machine FragProgMachine;
 305
 306 } SWcontext;
 307
 308
 309 extern void
 310 _swrast_validate_derived( struct gl_context *ctx );
 311
 312 extern void
 313 _swrast_update_texture_samplers(struct gl_context *ctx);
 314
 315
 316 /** Return SWcontext for the given struct gl_context */
 317 static inline SWcontext *
 318 SWRAST_CONTEXT(struct gl_context *ctx)
 319 {
 320    return (SWcontext *) ctx->swrast_context;
 321 }
 322
 323 /** const version of above */
 324 static inline const SWcontext *
 325 CONST_SWRAST_CONTEXT(const struct gl_context *ctx)
 326 {
 327    return (const SWcontext *) ctx->swrast_context;
 328 }
 329
 330
 331 /**
 332  * Called prior to framebuffer reading/writing.
 333  * For drivers that rely on swrast for fallback rendering, this is the
 334  * driver's opportunity to map renderbuffers and textures.
 335  */
 336 static inline void
 337 swrast_render_start(struct gl_context *ctx)
 338 {
 339    SWcontext *swrast = SWRAST_CONTEXT(ctx);
 340    if (swrast->Driver.SpanRenderStart)
 341       swrast->Driver.SpanRenderStart(ctx);
 342 }
 343
 344
 345 /** Called after framebuffer reading/writing */
 346 static inline void
 347 swrast_render_finish(struct gl_context *ctx)
 348 {
 349    SWcontext *swrast = SWRAST_CONTEXT(ctx);
 350    if (swrast->Driver.SpanRenderFinish)
 351       swrast->Driver.SpanRenderFinish(ctx);
 352 }
 353
 354
 355 extern void
 356 _swrast_span_render_start(struct gl_context *ctx);
 357
 358 extern void
 359 _swrast_span_render_finish(struct gl_context *ctx);
 360
 361 extern void
 362 _swrast_map_textures(struct gl_context *ctx);
 363
 364 extern void
 365 _swrast_unmap_textures(struct gl_context *ctx);
 366
 367 extern void
 368 _swrast_map_texture(struct gl_context *ctx, struct gl_texture_object *texObj);
 369
 370 extern void
 371 _swrast_unmap_texture(struct gl_context *ctx, struct gl_texture_object *texObj);
 372
 373
 374 extern void
 375 _swrast_map_renderbuffers(struct gl_context *ctx);
 376
 377 extern void
 378 _swrast_unmap_renderbuffers(struct gl_context *ctx);
 379
 380
 381 /**
 382  * Size of an RGBA pixel, in bytes, for given datatype.
 383  */
 384 #define RGBA_PIXEL_SIZE(TYPE)                                     \
 385          ((TYPE == GL_UNSIGNED_BYTE) ? 4 * sizeof(GLubyte) :      \
 386           ((TYPE == GL_UNSIGNED_SHORT) ? 4 * sizeof(GLushort)     \
 387            : 4 * sizeof(GLfloat)))
 388
 389
 390
 391 /*
 392  * Fixed point arithmetic macros
 393  */
 394 #ifndef FIXED_FRAC_BITS
 395 #define FIXED_FRAC_BITS 11
 396 #endif
 397
 398 #define FIXED_SHIFT     FIXED_FRAC_BITS
 399 #define FIXED_ONE       (1 << FIXED_SHIFT)
 400 #define FIXED_HALF      (1 << (FIXED_SHIFT-1))
 401 #define FIXED_FRAC_MASK (FIXED_ONE - 1)
 402 #define FIXED_INT_MASK  (~FIXED_FRAC_MASK)
 403 #define FIXED_EPSILON   1
 404 #define FIXED_SCALE     ((float) FIXED_ONE)
 405 #define FIXED_DBL_SCALE ((double) FIXED_ONE)
 406 #define FloatToFixed(X) (IROUND((X) * FIXED_SCALE))
 407 #define FixedToDouble(X) ((X) * (1.0 / FIXED_DBL_SCALE))
 408 #define IntToFixed(I)   ((I) << FIXED_SHIFT)
 409 #define FixedToInt(X)   ((X) >> FIXED_SHIFT)
 410 #define FixedToUns(X)   (((unsigned int)(X)) >> FIXED_SHIFT)
 411 #define FixedCeil(X)    (((X) + FIXED_ONE - FIXED_EPSILON) & FIXED_INT_MASK)
 412 #define FixedFloor(X)   ((X) & FIXED_INT_MASK)
 413 #define FixedToFloat(X) ((X) * (1.0F / FIXED_SCALE))
 414 #define PosFloatToFixed(X)      FloatToFixed(X)
 415 #define SignedFloatToFixed(X)   FloatToFixed(X)
 416
 417
 418
 419 /*
 420  * XXX these macros are just bandages for now in order to make
 421  * CHAN_BITS==32 compile cleanly.
 422  * These should probably go elsewhere at some point.
 423  */
 424 #if CHAN_TYPE == GL_FLOAT
 425 #define ChanToFixed(X)  (X)
 426 #define FixedToChan(X)  (X)
 427 #else
 428 #define ChanToFixed(X)  IntToFixed(X)
 429 #define FixedToChan(X)  FixedToInt(X)
 430 #endif
 431
 432
 433 /**
 434  * For looping over fragment attributes in the pointe, line
 435  * triangle rasterizers.
 436  */
 437 #define ATTRIB_LOOP_BEGIN                                \
 438    {                                                     \
 439       GLuint a;                                          \
 440       for (a = 0; a < swrast->_NumActiveAttribs; a++) {  \
 441          const GLuint attr = swrast->_ActiveAttribs[a];
 442
 443 #define ATTRIB_LOOP_END } }
 444
 445
 446 /**
 447  * Return the address of a pixel value in a mapped renderbuffer.
 448  */
 449 static inline GLubyte *
 450 _swrast_pixel_address(struct gl_renderbuffer *rb, GLint x, GLint y)
 451 {
 452    struct swrast_renderbuffer *srb = swrast_renderbuffer(rb);
 453    const GLint bpp = _mesa_get_format_bytes(rb->Format);
 454    const GLint rowStride = srb->RowStride;
 455    assert(x >= 0);
 456    assert(y >= 0);
 457    /* NOTE: using <= only because of s_tritemp.h which gets a pixel
 458     * address but doesn't necessarily access it.
 459     */
 460    assert(x <= (GLint) rb->Width);
 461    assert(y <= (GLint) rb->Height);
 462    assert(srb->Map);
 463    return (GLubyte *) srb->Map + y * rowStride + x * bpp;
 464 }
 465
 466
 467
 468 #endif