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