fix typo
[mesa.git] / src / mesa / swrast / swrast.h
index 93263ff20939646b42186f61dd32d28b5b3d1ad3..655c74077f182a069e430dfc197491bf3109f601 100644 (file)
@@ -1,10 +1,8 @@
-/* $Id: swrast.h,v 1.19 2002/01/28 04:25:56 brianp Exp $ */
-
 /*
  * Mesa 3-D graphics library
- * Version:  4.1
+ * Version:  5.1
  *
- * Copyright (C) 1999-2002  Brian Paul   All Rights Reserved.
+ * Copyright (C) 1999-2003  Brian Paul   All Rights Reserved.
  *
  * Permission is hereby granted, free of charge, to any person obtaining a
  * copy of this software and associated documentation files (the "Software"),
  * AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  *
- * Authors:
- *    Keith Whitwell <keithw@valinux.com>
+ */
+
+/**
+ * \file swrast/swrast.h
+ * \brief Public interface to the software rasterization functions.
+ * \author Keith Whitwell <keith@tungstengraphics.com>
  */
 
 #ifndef SWRAST_H
 
 #include "mtypes.h"
 
-
-/* The software rasterizer now uses this format for vertices.  Thus a
+/**
+ * \struct SWvertex
+ * \brief Data-structure to handle vertices in the software rasterizer.
+ * 
+ * The software rasterizer now uses this format for vertices.  Thus a
  * 'RasterSetup' stage or other translation is required between the
  * tnl module and the swrast rasterization functions.  This serves to
  * isolate the swrast module from the internals of the tnl module, and
  *     primitives unaccelerated), hook in swrast_setup instead.
  */
 typedef struct {
+   /** win[0], win[1] are the screen-coords of SWvertex. win[2] is the
+    * z-coord. what is win[3]? */
    GLfloat win[4];
-   GLfloat texcoord[MAX_TEXTURE_UNITS][4];
+   GLfloat texcoord[MAX_TEXTURE_COORD_UNITS][4];
    GLchan color[4];
    GLchan specular[4];
    GLfloat fog;
@@ -66,119 +73,19 @@ typedef struct {
 } SWvertex;
 
 
-/*
- * The sw_span structure describes the colors, Z, fogcoord, texcoords,
- * etc for a horizontal run of pixels.  We can either specify a base/step
- * to indicate interpolated values, or fill in arrays of values.
- * The interpMask and arrayMask bitfields indicate which are active.
- *
- * With this structure it's easy to hand-off span rasterization to
- * subroutines instead of doing it all inline in the triangle functions
- * like we used to do.
- * It also cleans up the local variable namespace a great deal.
- *
- * It would be interesting to experiment with multiprocessor rasterization
- * with this structure.  The triangle rasterizer could simply emit a
- * stream of these structures which would be consumed by one or more
- * span-processing threads which could run in parallel.
- */
-
-
-/* Values for interpMask and arrayMask */
-#define SPAN_RGBA         0x001
-#define SPAN_SPEC         0x002
-#define SPAN_INDEX        0x004
-#define SPAN_Z            0x008
-#define SPAN_FOG          0x010
-#define SPAN_TEXTURE      0x020
-#define SPAN_INT_TEXTURE  0x040
-#define SPAN_LAMBDA       0x080
-#define SPAN_COVERAGE     0x100
-#define SPAN_FLAT         0x200  /* flat shading? */
-
-
-struct sw_span {
-   GLint x, y;
-
-   /* only need to process pixels between start <= i < end */
-   GLuint start, end;
-
-   /* This flag indicates that only a part of the span is visible */
-   GLboolean writeAll;
-
-   /**
-    * This bitmask (of SPAN_* flags) indicates which of the x/xStep
-    * variables are relevant.
-    */
-   GLuint interpMask;
-
-#if CHAN_TYPE == GL_FLOAT
-   GLfloat red, redStep;
-   GLfloat green, greenStep;
-   GLfloat blue, blueStep;
-   GLfloat alpha, alphaStep;
-   GLfloat specRed, specRedStep;
-   GLfloat specGreen, specGreenStep;
-   GLfloat specBlue, specBlueStep;
-#else /* CHAN_TYPE == */
-   GLfixed red, redStep;
-   GLfixed green, greenStep;
-   GLfixed blue, blueStep;
-   GLfixed alpha, alphaStep;
-   GLfixed specRed, specRedStep;
-   GLfixed specGreen, specGreenStep;
-   GLfixed specBlue, specBlueStep;
-#endif
-   GLfixed index, indexStep;
-   GLfixed z, zStep;
-   GLfloat fog, fogStep;
-   GLfloat tex[MAX_TEXTURE_UNITS][4], texStep[MAX_TEXTURE_UNITS][4];
-   GLfixed intTex[2], intTexStep[2];
-   GLfloat rho[MAX_TEXTURE_UNITS]; /* for texture lambda/lod computation */
-
-   /**
-    * This bitmask (of SPAN_* flags) indicates which of the fragment arrays
-    * are relevant.
-    */
-   GLuint arrayMask;
-
-   /**
-    * Arrays of fragment values.  These will either be computed from the
-    * x/xStep values above or filled in by glDraw/CopyPixels, etc.
-    */
-   union {
-      GLchan rgb[MAX_WIDTH][3];
-      GLchan rgba[MAX_WIDTH][4];
-      GLuint index[MAX_WIDTH];
-   } color;
-   GLchan  specArray[MAX_WIDTH][4];
-   GLdepth zArray[MAX_WIDTH];
-   GLfloat fogArray[MAX_WIDTH];
-   GLfloat texcoords[MAX_TEXTURE_UNITS][MAX_WIDTH][4];
-   GLfloat lambda[MAX_TEXTURE_UNITS][MAX_WIDTH];
-   GLfloat coverage[MAX_WIDTH];
-
-   /* This mask indicates if fragment is alive or culled */
-   GLubyte mask[MAX_WIDTH];
-};
-
-
-#define INIT_SPAN(S)   \
-do {                   \
-   S.interpMask = 0;   \
-   S.arrayMask = 0;    \
-   S.start = S.end = 0;        \
-} while (0)
-
-
-
 struct swrast_device_driver;
 
 
 /* These are the public-access functions exported from swrast.
  */
 extern void
-_swrast_alloc_buffers( GLcontext *ctx );
+_swrast_alloc_buffers( GLframebuffer *buffer );
+
+extern void
+_swrast_use_read_buffer( GLcontext *ctx );
+
+extern void
+_swrast_use_draw_buffer( GLcontext *ctx );
 
 extern GLboolean
 _swrast_CreateContext( GLcontext *ctx );
@@ -230,6 +137,10 @@ _swrast_Accum( GLcontext *ctx, GLenum op,
               GLint width, GLint height );
 
 
+extern void
+_swrast_DrawBuffer( GLcontext *ctx, GLenum mode );
+
+
 /* Reset the stipple counter
  */
 extern void
@@ -258,6 +169,14 @@ _swrast_Quad( GLcontext *ctx,
 extern void
 _swrast_flush( GLcontext *ctx );
 
+extern void
+_swrast_render_primitive( GLcontext *ctx, GLenum mode );
+
+extern void
+_swrast_render_start( GLcontext *ctx );
+
+extern void
+_swrast_render_finish( GLcontext *ctx );
 
 /* Tell the software rasterizer about core state changes.
  */
@@ -301,7 +220,7 @@ _swrast_CopyColorTable( GLcontext *ctx,
 
 
 /*
- * Texture fallbacks, Brian Paul.  Could also live in a new module
+ * Texture fallbacks.  Could also live in a new module
  * with the rest of the texture store fallbacks?
  */
 extern void
@@ -334,20 +253,23 @@ _swrast_copy_texsubimage3d(GLcontext *ctx,
 
 
 
-/* The driver interface for the software rasterizer.  Unless otherwise
- * noted, all functions are mandatory.  
+/* The driver interface for the software rasterizer.
+ * Unless otherwise noted, all functions are mandatory.  
  */
 struct swrast_device_driver {
 
-   void (*SetReadBuffer)( GLcontext *ctx, GLframebuffer *colorBuffer,
-                          GLenum buffer );
+   void (*SetBuffer)( GLcontext *ctx, GLframebuffer *buffer, GLuint bufferBit);
    /*
-    * Specifies the current buffer for span/pixel reading.
-    * colorBuffer will be one of:
-    *    GL_FRONT_LEFT - this buffer always exists
-    *    GL_BACK_LEFT - when double buffering
-    *    GL_FRONT_RIGHT - when using stereo
-    *    GL_BACK_RIGHT - when using stereo and double buffering
+    * Specifies the current buffer for span/pixel writing/reading.
+    * buffer indicates which window to write to / read from.  Normally,
+    * this'll be the buffer currently bound to the context, but it doesn't
+    * have to be!
+    * bufferBit indicates which color buffer, one of:
+    *    FRONT_LEFT_BIT - this buffer always exists
+    *    BACK_LEFT_BIT - when double buffering
+    *    FRONT_RIGHT_BIT - when using stereo
+    *    BACK_RIGHT_BIT - when using stereo and double buffering
+    *    AUXn_BIT - if aux buffers are implemented
     */
 
 
@@ -386,6 +308,8 @@ struct swrast_device_driver {
    void (*WriteMonoRGBASpan)( const GLcontext *ctx, GLuint n, GLint x, GLint y,
                               const GLchan color[4], const GLubyte mask[] );
    /* Write a horizontal run of RGBA pixels all with the same color.
+    * If mask is NULL, draw all pixels.
+    * If mask is not null, only draw pixel [i] when mask [i] is true.
     */
 
    void (*WriteRGBAPixels)( const GLcontext *ctx,
@@ -407,12 +331,16 @@ struct swrast_device_driver {
    /* Write a horizontal run of CI pixels.  One function is for 32bpp
     * indexes and the other for 8bpp pixels (the common case).  You mus
     * implement both for color index mode.
+    * If mask is NULL, draw all pixels.
+    * If mask is not null, only draw pixel [i] when mask [i] is true.
     */
 
    void (*WriteMonoCISpan)( const GLcontext *ctx, GLuint n, GLint x, GLint y,
                             GLuint colorIndex, const GLubyte mask[] );
    /* Write a horizontal run of color index pixels using the color index
     * last specified by the Index() function.
+    * If mask is NULL, draw all pixels.
+    * If mask is not null, only draw pixel [i] when mask [i] is true.
     */
 
    void (*WriteCI32Pixels)( const GLcontext *ctx,