rearranged order of some functions
[mesa.git] / src / mesa / main / stencil.c
index e3529996be740fe04e1cb7c451fa81ef7046201b..79c66d3fb2f4e107c47dfeb530e02a90d79fae9b 100644 (file)
@@ -1,10 +1,10 @@
-/* $Id: stencil.c,v 1.6 1999/10/13 18:42:50 brianp Exp $ */
+/* $Id: stencil.c,v 1.14 2000/02/02 22:16:04 brianp Exp $ */
 
 /*
  * Mesa 3-D graphics library
- * Version:  3.1
+ * Version:  3.3
  * 
- * Copyright (C) 1999  Brian Paul   All Rights Reserved.
+ * Copyright (C) 1999-2000  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"),
  */
 
 
-/* $XFree86: xc/lib/GL/mesa/src/stencil.c,v 1.3 1999/04/04 00:20:32 dawes Exp $ */
-
 #ifdef PC_HEADER
 #include "all.h"
 #else
-#ifndef XFree86Server
-#include <stdlib.h>
-#include <string.h>
-#else
-#include "GL/xf86glx.h"
-#endif
+#include "glheader.h"
 #include "context.h"
-#include "macros.h"
+#include "depth.h"
+#include "mem.h"
 #include "pb.h"
 #include "stencil.h"
 #include "types.h"
 #include "enable.h"
-#ifdef XFree86Server
-#include "GL/xf86glx.h"
-#endif
-#endif
-
-
-#if STENCIL_BITS==8
-#  define STENCIL_MAX 0xff
-#elif STENCIL_BITS==16
-#  define STENCIL_MAX 0xffff
-#else
-   illegal number of stencil bits
 #endif
 
 
 
-/*
- * Return the address of a stencil buffer value given the window coords:
- */
-#define STENCIL_ADDRESS(X,Y)  (ctx->Buffer->Stencil + ctx->Buffer->Width * (Y) + (X))
 
-
-void gl_ClearStencil( GLcontext *ctx, GLint s )
+void
+_mesa_ClearStencil( GLint s )
 {
+   GET_CURRENT_CONTEXT(ctx);
    ASSERT_OUTSIDE_BEGIN_END_AND_FLUSH(ctx, "glClearStencil");
    ctx->Stencil.Clear = (GLstencil) s;
 
@@ -76,8 +55,10 @@ void gl_ClearStencil( GLcontext *ctx, GLint s )
 
 
 
-void gl_StencilFunc( GLcontext *ctx, GLenum func, GLint ref, GLuint mask )
+void
+_mesa_StencilFunc( GLenum func, GLint ref, GLuint mask )
 {
+   GET_CURRENT_CONTEXT(ctx);
    GLint maxref;
 
    ASSERT_OUTSIDE_BEGIN_END_AND_FLUSH(ctx, "glStencilFunc");
@@ -99,8 +80,8 @@ void gl_StencilFunc( GLcontext *ctx, GLenum func, GLint ref, GLuint mask )
    }
 
    maxref = (1 << STENCIL_BITS) - 1;
-   ctx->Stencil.Ref = CLAMP( ref, 0, maxref );
-   ctx->Stencil.ValueMask = mask;
+   ctx->Stencil.Ref = (GLstencil) CLAMP( ref, 0, maxref );
+   ctx->Stencil.ValueMask = (GLstencil) mask;
 
    if (ctx->Driver.StencilFunc) {
       (*ctx->Driver.StencilFunc)( ctx, func, ctx->Stencil.Ref, mask );
@@ -109,8 +90,10 @@ void gl_StencilFunc( GLcontext *ctx, GLenum func, GLint ref, GLuint mask )
 
 
 
-void gl_StencilMask( GLcontext *ctx, GLuint mask )
+void
+_mesa_StencilMask( GLuint mask )
 {
+   GET_CURRENT_CONTEXT(ctx);
    ASSERT_OUTSIDE_BEGIN_END_AND_FLUSH(ctx, "glStencilMask");
    ctx->Stencil.WriteMask = (GLstencil) mask;
 
@@ -121,8 +104,10 @@ void gl_StencilMask( GLcontext *ctx, GLuint mask )
 
 
 
-void gl_StencilOp( GLcontext *ctx, GLenum fail, GLenum zfail, GLenum zpass )
+void
+_mesa_StencilOp( GLenum fail, GLenum zfail, GLenum zpass )
 {
+   GET_CURRENT_CONTEXT(ctx);
    ASSERT_OUTSIDE_BEGIN_END_AND_FLUSH(ctx, "glStencilOp");
    switch (fail) {
       case GL_KEEP:
@@ -180,42 +165,45 @@ void gl_StencilOp( GLcontext *ctx, GLenum fail, GLenum zfail, GLenum zpass )
 /* Stencil Logic:
 
 IF stencil test fails THEN
+   Apply fail-op to stencil value   
    Don't write the pixel (RGBA,Z)
-   Execute FailOp
 ELSE
-   Write the pixel
+   IF doing depth test && depth test fails THEN
+      Apply zfail-op to stencil value   
+      Write RGBA and Z to appropriate buffers
+   ELSE
+      Apply zpass-op to stencil value
 ENDIF
 
-Perform Depth Test
+*/
 
-IF depth test passes OR no depth buffer THEN
-   Execute ZPass
-   Write the pixel
-ELSE
-   Execute ZFail
-ENDIF
 
-*/
 
 
+/*
+ * Return the address of a stencil buffer value given the window coords:
+ */
+#define STENCIL_ADDRESS(X,Y)  \
+       (ctx->DrawBuffer->Stencil + ctx->DrawBuffer->Width * (Y) + (X))
+
 
 
 /*
- * Apply the given stencil operator for each pixel in the span whose
- * mask flag is set.
- * Input:  n - number of pixels in the span
- *         x, y - location of leftmost pixel in the span
+ * Apply the given stencil operator to the array of stencil values.
+ * Don't touch stencil[i] if mask[i] is zero.
+ * Input:  n - size of stencil array
  *         oper - the stencil buffer operator
+ *         stencil - array of stencil values
  *         mask - array [n] of flag:  1=apply operator, 0=don't apply operator
+ * Output:  stencil - modified values
  */
-static void apply_stencil_op_to_span( GLcontext *ctx,
-                                      GLuint n, GLint x, GLint y,
-                                     GLenum oper, GLubyte mask[] )
+static void apply_stencil_op( const GLcontext *ctx, GLenum oper,
+                              GLuint n, GLstencil stencil[],
+                              const GLubyte mask[] )
 {
    const GLstencil ref = ctx->Stencil.Ref;
    const GLstencil wrtmask = ctx->Stencil.WriteMask;
-   const GLstencil invmask = ~ctx->Stencil.WriteMask;
-   GLstencil *stencil = STENCIL_ADDRESS( x, y );
+   const GLstencil invmask = (GLstencil) (~ctx->Stencil.WriteMask);
    GLuint i;
 
    switch (oper) {
@@ -233,7 +221,7 @@ static void apply_stencil_op_to_span( GLcontext *ctx,
         else {
            for (i=0;i<n;i++) {
               if (mask[i]) {
-                 stencil[i] = stencil[i] & invmask;
+                 stencil[i] = (GLstencil) (stencil[i] & invmask);
               }
            }
         }
@@ -250,7 +238,7 @@ static void apply_stencil_op_to_span( GLcontext *ctx,
            for (i=0;i<n;i++) {
               if (mask[i]) {
                  GLstencil s = stencil[i];
-                 stencil[i] = (invmask & s ) | (wrtmask & ref);
+                 stencil[i] = (GLstencil) ((invmask & s ) | (wrtmask & ref));
               }
            }
         }
@@ -261,7 +249,7 @@ static void apply_stencil_op_to_span( GLcontext *ctx,
               if (mask[i]) {
                  GLstencil s = stencil[i];
                  if (s < STENCIL_MAX) {
-                    stencil[i] = s+1;
+                    stencil[i] = (GLstencil) (s+1);
                  }
               }
            }
@@ -272,7 +260,7 @@ static void apply_stencil_op_to_span( GLcontext *ctx,
                  /* VERIFY logic of adding 1 to a write-masked value */
                  GLstencil s = stencil[i];
                  if (s < STENCIL_MAX) {
-                    stencil[i] = (invmask & s) | (wrtmask & (s+1));
+                    stencil[i] = (GLstencil) ((invmask & s) | (wrtmask & (s+1)));
                  }
               }
            }
@@ -284,7 +272,7 @@ static void apply_stencil_op_to_span( GLcontext *ctx,
               if (mask[i]) {
                  GLstencil s = stencil[i];
                  if (s>0) {
-                    stencil[i] = s-1;
+                    stencil[i] = (GLstencil) (s-1);
                  }
               }
            }
@@ -295,7 +283,7 @@ static void apply_stencil_op_to_span( GLcontext *ctx,
                  /* VERIFY logic of subtracting 1 to a write-masked value */
                  GLstencil s = stencil[i];
                  if (s>0) {
-                    stencil[i] = (invmask & s) | (wrtmask & (s-1));
+                    stencil[i] = (GLstencil) ((invmask & s) | (wrtmask & (s-1)));
                  }
               }
            }
@@ -313,7 +301,7 @@ static void apply_stencil_op_to_span( GLcontext *ctx,
            for (i=0;i<n;i++) {
               if (mask[i]) {
                   GLstencil s = stencil[i];
-                  stencil[i] = (invmask & s) | (wrtmask & (stencil[i]+1));
+                  stencil[i] = (GLstencil) ((invmask & s) | (wrtmask & (s+1)));
               }
            }
         }
@@ -330,7 +318,7 @@ static void apply_stencil_op_to_span( GLcontext *ctx,
            for (i=0;i<n;i++) {
               if (mask[i]) {
                   GLstencil s = stencil[i];
-                  stencil[i] = (invmask & s) | (wrtmask & (stencil[i]-1));
+                  stencil[i] = (GLstencil) ((invmask & s) | (wrtmask & (s-1)));
               }
            }
         }
@@ -340,7 +328,7 @@ static void apply_stencil_op_to_span( GLcontext *ctx,
            for (i=0;i<n;i++) {
               if (mask[i]) {
                  GLstencil s = stencil[i];
-                 stencil[i] = ~s;
+                 stencil[i] = (GLstencil) ~s;
               }
            }
         }
@@ -348,13 +336,13 @@ static void apply_stencil_op_to_span( GLcontext *ctx,
            for (i=0;i<n;i++) {
               if (mask[i]) {
                  GLstencil s = stencil[i];
-                 stencil[i] = (invmask & s) | (wrtmask & ~s);
+                 stencil[i] = (GLstencil) ((invmask & s) | (wrtmask & ~s));
               }
            }
         }
         break;
       default:
-         gl_problem(ctx, "Bad stencilop in apply_stencil_op_to_span");
+         gl_problem(ctx, "Bad stencil op in apply_stencil_op");
    }
 }
 
@@ -362,24 +350,25 @@ static void apply_stencil_op_to_span( GLcontext *ctx,
 
 
 /*
- * Apply stencil test to a span of pixels before depth buffering.
- * Input:  n - number of pixels in the span
- *         x, y - coordinate of left-most pixel in the span
+ * Apply stencil test to an array of stencil values (before depth buffering).
+ * Input:  n - number of pixels in the array
+ *         stencil - array of [n] stencil values
  *         mask - array [n] of flag:  0=skip the pixel, 1=stencil the pixel
  * Output:  mask - pixels which fail the stencil test will have their
  *                 mask flag set to 0.
- * Return:  0 = all pixels failed, 1 = zero or more pixels passed.
+ *          stencil - updated stencil values (where the test passed)
+ * Return:  GL_FALSE = all pixels failed, GL_TRUE = zero or more pixels passed.
  */
-GLint gl_stencil_span( GLcontext *ctx,
-                       GLuint n, GLint x, GLint y, GLubyte mask[] )
+static GLboolean
+do_stencil_test( GLcontext *ctx, GLuint n, GLstencil stencil[],
+                 GLubyte mask[] )
 {
-   GLubyte fail[MAX_WIDTH];
-   GLint allfail = 0;
+   GLubyte fail[PB_SIZE];
+   GLboolean allfail = GL_FALSE;
    GLuint i;
    GLstencil r, s;
-   GLstencil *stencil;
 
-   stencil = STENCIL_ADDRESS( x, y );
+   ASSERT(n <= PB_SIZE);
 
    /*
     * Perform stencil test.  The results of this operation are stored
@@ -402,13 +391,13 @@ GLint gl_stencil_span( GLcontext *ctx,
               fail[i] = 0;
            }
         }
-        allfail = 1;
+        allfail = GL_TRUE;
         break;
       case GL_LESS:
-        r = ctx->Stencil.Ref & ctx->Stencil.ValueMask;
+        r = (GLstencil) (ctx->Stencil.Ref & ctx->Stencil.ValueMask);
         for (i=0;i<n;i++) {
            if (mask[i]) {
-              s = stencil[i] & ctx->Stencil.ValueMask;
+              s = (GLstencil) (stencil[i] & ctx->Stencil.ValueMask);
               if (r < s) {
                  /* passed */
                  fail[i] = 0;
@@ -424,10 +413,10 @@ GLint gl_stencil_span( GLcontext *ctx,
         }
         break;
       case GL_LEQUAL:
-        r = ctx->Stencil.Ref & ctx->Stencil.ValueMask;
+        r = (GLstencil) (ctx->Stencil.Ref & ctx->Stencil.ValueMask);
         for (i=0;i<n;i++) {
            if (mask[i]) {
-              s = stencil[i] & ctx->Stencil.ValueMask;
+              s = (GLstencil) (stencil[i] & ctx->Stencil.ValueMask);
               if (r <= s) {
                  /* pass */
                  fail[i] = 0;
@@ -443,10 +432,10 @@ GLint gl_stencil_span( GLcontext *ctx,
         }
         break;
       case GL_GREATER:
-        r = ctx->Stencil.Ref & ctx->Stencil.ValueMask;
+        r = (GLstencil) (ctx->Stencil.Ref & ctx->Stencil.ValueMask);
         for (i=0;i<n;i++) {
            if (mask[i]) {
-              s = stencil[i] & ctx->Stencil.ValueMask;
+              s = (GLstencil) (stencil[i] & ctx->Stencil.ValueMask);
               if (r > s) {
                  /* passed */
                  fail[i] = 0;
@@ -462,10 +451,10 @@ GLint gl_stencil_span( GLcontext *ctx,
         }
         break;
       case GL_GEQUAL:
-        r = ctx->Stencil.Ref & ctx->Stencil.ValueMask;
+        r = (GLstencil) (ctx->Stencil.Ref & ctx->Stencil.ValueMask);
         for (i=0;i<n;i++) {
            if (mask[i]) {
-              s = stencil[i] & ctx->Stencil.ValueMask;
+              s = (GLstencil) (stencil[i] & ctx->Stencil.ValueMask);
               if (r >= s) {
                  /* passed */
                  fail[i] = 0;
@@ -481,10 +470,10 @@ GLint gl_stencil_span( GLcontext *ctx,
         }
         break;
       case GL_EQUAL:
-        r = ctx->Stencil.Ref & ctx->Stencil.ValueMask;
+        r = (GLstencil) (ctx->Stencil.Ref & ctx->Stencil.ValueMask);
         for (i=0;i<n;i++) {
            if (mask[i]) {
-              s = stencil[i] & ctx->Stencil.ValueMask;
+              s = (GLstencil) (stencil[i] & ctx->Stencil.ValueMask);
               if (r == s) {
                  /* passed */
                  fail[i] = 0;
@@ -500,10 +489,10 @@ GLint gl_stencil_span( GLcontext *ctx,
         }
         break;
       case GL_NOTEQUAL:
-        r = ctx->Stencil.Ref & ctx->Stencil.ValueMask;
+        r = (GLstencil) (ctx->Stencil.Ref & ctx->Stencil.ValueMask);
         for (i=0;i<n;i++) {
            if (mask[i]) {
-              s = stencil[i] & ctx->Stencil.ValueMask;
+              s = (GLstencil) (stencil[i] & ctx->Stencil.ValueMask);
               if (r != s) {
                  /* passed */
                  fail[i] = 0;
@@ -529,31 +518,56 @@ GLint gl_stencil_span( GLcontext *ctx,
          return 0;
    }
 
-   apply_stencil_op_to_span( ctx, n, x, y, ctx->Stencil.FailFunc, fail );
+   if (ctx->Stencil.FailFunc != GL_KEEP) {
+      apply_stencil_op( ctx, ctx->Stencil.FailFunc, n, stencil, fail );
+   }
 
-   return (allfail) ? 0 : 1;
+   return !allfail;
 }
 
 
 
 
 /*
- * Apply the combination depth-buffer/stencil operator to a span of pixels.
+ * Apply stencil and depth testing to an array of pixels.
+ * Hardware or software stencil buffer acceptable.
  * Input:  n - number of pixels in the span
- *         x, y - location of leftmost pixel in span
  *         z - array [n] of z values
- * Input:  mask - array [n] of flags  (1=test this pixel, 0=skip the pixel)
- * Output:  mask - array [n] of flags (1=depth test passed, 0=failed) 
+ *         stencil - array [n] of stencil values
+ *         mask - array [n] of flags  (1=test this pixel, 0=skip the pixel)
+ * Output:  stencil - modified stencil values
+ *          mask - array [n] of flags (1=stencil and depth test passed)
+ * Return: GL_TRUE - all fragments failed the testing
+ *         GL_FALSE - one or more fragments passed the testing
+ * 
  */
-void gl_depth_stencil_span( GLcontext *ctx,
-                            GLuint n, GLint x, GLint y, const GLdepth z[],
-                           GLubyte mask[] )
+static GLboolean
+stencil_and_depth_test_span( GLcontext *ctx, GLuint n, GLint x, GLint y,
+                             const GLdepth z[], GLstencil stencil[],
+                             GLubyte mask[] )
 {
+   ASSERT(ctx->Stencil.Enabled);
+   ASSERT(n <= PB_SIZE);
+
+   /*
+    * Apply the stencil test to the fragments.
+    * failMask[i] is 1 if the stencil test failed.
+    */
+   if (do_stencil_test( ctx, n, stencil, mask ) == GL_FALSE) {
+      /* all fragments failed the stencil test, we're done. */
+      return GL_FALSE;
+   }
+
+
+   /*
+    * Some fragments passed the stencil test, apply depth test to them
+    * and apply Zpass and Zfail stencil ops.
+    */
    if (ctx->Depth.Test==GL_FALSE) {
       /*
        * No depth buffer, just apply zpass stencil function to active pixels.
        */
-      apply_stencil_op_to_span( ctx, n, x, y, ctx->Stencil.ZPassFunc, mask );
+      apply_stencil_op( ctx, ctx->Stencil.ZPassFunc, n, stencil, mask );
    }
    else {
       /*
@@ -562,32 +576,86 @@ void gl_depth_stencil_span( GLcontext *ctx,
       GLubyte passmask[MAX_WIDTH], failmask[MAX_WIDTH], oldmask[MAX_WIDTH];
       GLuint i;
 
-      /* init pass and fail masks to zero, copy mask[] to oldmask[] */
-      for (i=0;i<n;i++) {
-        passmask[i] = failmask[i] = 0;
-         oldmask[i] = mask[i];
-      }
+      /* save the current mask bits */
+      MEMCPY(oldmask, mask, n * sizeof(GLubyte));
 
       /* apply the depth test */
-      if (ctx->Driver.DepthTestSpan)
-         (*ctx->Driver.DepthTestSpan)( ctx, n, x, y, z, mask );
-
-      /* set the stencil pass/fail flags according to result of depth test */
+      _mesa_depth_test_span(ctx, n, x, y, z, mask);
+
+      /* Set the stencil pass/fail flags according to result of depth testing.
+       * if oldmask[i] == 0 then
+       *    Don't touch the stencil value
+       * else if oldmask[i] and newmask[i] then
+       *    Depth test passed
+       * else
+       *    assert(oldmask[i] && !newmask[i])
+       *    Depth test failed
+       * endif
+       */
       for (i=0;i<n;i++) {
-         if (oldmask[i]) {
-            if (mask[i]) {
-               passmask[i] = 1;
-            }
-            else {
-               failmask[i] = 1;
-            }
-         }
+         ASSERT(mask[i] == 0 || mask[i] == 1);
+         passmask[i] = oldmask[i] & mask[i];
+         failmask[i] = oldmask[i] & (mask[i] ^ 1);
       }
 
       /* apply the pass and fail operations */
-      apply_stencil_op_to_span( ctx, n, x, y, ctx->Stencil.ZFailFunc, failmask );
-      apply_stencil_op_to_span( ctx, n, x, y, ctx->Stencil.ZPassFunc, passmask );
+      if (ctx->Stencil.ZFailFunc != GL_KEEP) {
+         apply_stencil_op( ctx, ctx->Stencil.ZFailFunc, n, stencil, failmask );
+      }
+      if (ctx->Stencil.ZPassFunc != GL_KEEP) {
+         apply_stencil_op( ctx, ctx->Stencil.ZPassFunc, n, stencil, passmask );
+      }
    }
+
+   return GL_TRUE;  /* one or more fragments passed both tests */
+}
+
+
+
+/*
+ * Apply stencil and depth testing to the span of pixels.
+ * Both software and hardware stencil buffers are acceptable.
+ * Input:  n - number of pixels in the span
+ *         x, y - location of leftmost pixel in span
+ *         z - array [n] of z values
+ *         mask - array [n] of flags  (1=test this pixel, 0=skip the pixel)
+ * Output:  mask - array [n] of flags (1=stencil and depth test passed)
+ * Return: GL_TRUE - all fragments failed the testing
+ *         GL_FALSE - one or more fragments passed the testing
+ * 
+ */
+GLboolean
+gl_stencil_and_depth_test_span( GLcontext *ctx, GLuint n, GLint x, GLint y,
+                                const GLdepth z[], GLubyte mask[] )
+{
+   GLstencil stencilRow[MAX_WIDTH];
+   GLstencil *stencil;
+   GLboolean result;
+
+   ASSERT(ctx->Stencil.Enabled);
+   ASSERT(n <= MAX_WIDTH);
+
+   /* Get initial stencil values */
+   if (ctx->Driver.WriteStencilSpan) {
+      ASSERT(ctx->Driver.ReadStencilSpan);
+      /* Get stencil values from the hardware stencil buffer */
+      (*ctx->Driver.ReadStencilSpan)(ctx, n, x, y, stencilRow);
+      stencil = stencilRow;
+   }
+   else {
+      /* software stencil buffer */
+      stencil = STENCIL_ADDRESS(x, y);
+   }
+
+   /* do all the stencil/depth testing/updating */
+   result = stencil_and_depth_test_span( ctx, n, x, y, z, stencil, mask );
+
+   if (ctx->Driver.WriteStencilSpan) {
+      /* Write updated stencil values into hardware stencil buffer */
+      (ctx->Driver.WriteStencilSpan)(ctx, n, x, y, stencil, mask );
+   }
+
+   return result;
 }
 
 
@@ -595,25 +663,23 @@ void gl_depth_stencil_span( GLcontext *ctx,
 
 /*
  * Apply the given stencil operator for each pixel in the array whose
- * mask flag is set.
+ * mask flag is set.  This is for software stencil buffers only.
  * Input:  n - number of pixels in the span
  *         x, y - array of [n] pixels
  *         operator - the stencil buffer operator
  *         mask - array [n] of flag:  1=apply operator, 0=don't apply operator
  */
-static void apply_stencil_op_to_pixels( GLcontext *ctx,
-                                        GLuint n, const GLint x[],
-                                       const GLint y[],
-                                       GLenum oper, GLubyte mask[] )
+static void
+apply_stencil_op_to_pixels( const GLcontext *ctx,
+                            GLuint n, const GLint x[], const GLint y[],
+                            GLenum oper, const GLubyte mask[] )
 {
+   const GLstencil ref = ctx->Stencil.Ref;
+   const GLstencil wrtmask = ctx->Stencil.WriteMask;
+   const GLstencil invmask = (GLstencil) (~ctx->Stencil.WriteMask);
    GLuint i;
-   GLstencil ref;
-   GLstencil wrtmask, invmask;
-
-   wrtmask = ctx->Stencil.WriteMask;
-   invmask = ~ctx->Stencil.WriteMask;
 
-   ref = ctx->Stencil.Ref;
+   ASSERT(!ctx->Driver.WriteStencilSpan);  /* software stencil buffer only! */
 
    switch (oper) {
       case GL_KEEP:
@@ -632,7 +698,7 @@ static void apply_stencil_op_to_pixels( GLcontext *ctx,
            for (i=0;i<n;i++) {
               if (mask[i]) {
                   GLstencil *sptr = STENCIL_ADDRESS( x[i], y[i] );
-                 *sptr = invmask & *sptr;
+                 *sptr = (GLstencil) (invmask & *sptr);
               }
            }
         }
@@ -650,7 +716,7 @@ static void apply_stencil_op_to_pixels( GLcontext *ctx,
            for (i=0;i<n;i++) {
               if (mask[i]) {
                   GLstencil *sptr = STENCIL_ADDRESS( x[i], y[i] );
-                 *sptr = (invmask & *sptr ) | (wrtmask & ref);
+                 *sptr = (GLstencil) ((invmask & *sptr ) | (wrtmask & ref));
               }
            }
         }
@@ -661,7 +727,7 @@ static void apply_stencil_op_to_pixels( GLcontext *ctx,
               if (mask[i]) {
                   GLstencil *sptr = STENCIL_ADDRESS( x[i], y[i] );
                  if (*sptr < STENCIL_MAX) {
-                    *sptr = *sptr + 1;
+                    *sptr = (GLstencil) (*sptr + 1);
                  }
               }
            }
@@ -671,7 +737,7 @@ static void apply_stencil_op_to_pixels( GLcontext *ctx,
               if (mask[i]) {
                   GLstencil *sptr = STENCIL_ADDRESS( x[i], y[i] );
                  if (*sptr < STENCIL_MAX) {
-                    *sptr = (invmask & *sptr) | (wrtmask & (*sptr+1));
+                    *sptr = (GLstencil) ((invmask & *sptr) | (wrtmask & (*sptr+1)));
                  }
               }
            }
@@ -683,7 +749,7 @@ static void apply_stencil_op_to_pixels( GLcontext *ctx,
               if (mask[i]) {
                   GLstencil *sptr = STENCIL_ADDRESS( x[i], y[i] );
                  if (*sptr>0) {
-                    *sptr = *sptr - 1;
+                    *sptr = (GLstencil) (*sptr - 1);
                  }
               }
            }
@@ -693,7 +759,7 @@ static void apply_stencil_op_to_pixels( GLcontext *ctx,
               if (mask[i]) {
                   GLstencil *sptr = STENCIL_ADDRESS( x[i], y[i] );
                  if (*sptr>0) {
-                    *sptr = (invmask & *sptr) | (wrtmask & (*sptr-1));
+                    *sptr = (GLstencil) ((invmask & *sptr) | (wrtmask & (*sptr-1)));
                  }
               }
            }
@@ -704,7 +770,7 @@ static void apply_stencil_op_to_pixels( GLcontext *ctx,
            for (i=0;i<n;i++) {
               if (mask[i]) {
                   GLstencil *sptr = STENCIL_ADDRESS( x[i], y[i] );
-                  *sptr = *sptr + 1;
+                  *sptr = (GLstencil) (*sptr + 1);
               }
            }
         }
@@ -712,7 +778,7 @@ static void apply_stencil_op_to_pixels( GLcontext *ctx,
            for (i=0;i<n;i++) {
               if (mask[i]) {
                   GLstencil *sptr = STENCIL_ADDRESS( x[i], y[i] );
-                  *sptr = (invmask & *sptr) | (wrtmask & (*sptr+1));
+                  *sptr = (GLstencil) ((invmask & *sptr) | (wrtmask & (*sptr+1)));
               }
            }
         }
@@ -722,7 +788,7 @@ static void apply_stencil_op_to_pixels( GLcontext *ctx,
            for (i=0;i<n;i++) {
               if (mask[i]) {
                   GLstencil *sptr = STENCIL_ADDRESS( x[i], y[i] );
-                  *sptr = *sptr - 1;
+                  *sptr = (GLstencil) (*sptr - 1);
               }
            }
         }
@@ -730,7 +796,7 @@ static void apply_stencil_op_to_pixels( GLcontext *ctx,
            for (i=0;i<n;i++) {
               if (mask[i]) {
                   GLstencil *sptr = STENCIL_ADDRESS( x[i], y[i] );
-                  *sptr = (invmask & *sptr) | (wrtmask & (*sptr-1));
+                  *sptr = (GLstencil) ((invmask & *sptr) | (wrtmask & (*sptr-1)));
               }
            }
         }
@@ -740,7 +806,7 @@ static void apply_stencil_op_to_pixels( GLcontext *ctx,
            for (i=0;i<n;i++) {
               if (mask[i]) {
                   GLstencil *sptr = STENCIL_ADDRESS( x[i], y[i] );
-                  *sptr = ~*sptr;
+                  *sptr = (GLstencil) (~*sptr);
               }
            }
         }
@@ -748,7 +814,7 @@ static void apply_stencil_op_to_pixels( GLcontext *ctx,
            for (i=0;i<n;i++) {
               if (mask[i]) {
                   GLstencil *sptr = STENCIL_ADDRESS( x[i], y[i] );
-                  *sptr = (invmask & *sptr) | (wrtmask & ~*sptr);
+                  *sptr = (GLstencil) ((invmask & *sptr) | (wrtmask & ~*sptr));
               }
            }
         }
@@ -762,6 +828,7 @@ static void apply_stencil_op_to_pixels( GLcontext *ctx,
 
 /*
  * Apply stencil test to an array of pixels before depth buffering.
+ * Used for software stencil buffer only.
  * Input:  n - number of pixels in the span
  *         x, y - array of [n] pixels to stencil
  *         mask - array [n] of flag:  0=skip the pixel, 1=stencil the pixel
@@ -769,14 +836,16 @@ static void apply_stencil_op_to_pixels( GLcontext *ctx,
  *                 mask flag set to 0.
  * Return:  0 = all pixels failed, 1 = zero or more pixels passed.
  */
-GLint gl_stencil_pixels( GLcontext *ctx,
-                         GLuint n, const GLint x[], const GLint y[],
-                        GLubyte mask[] )
+static GLboolean
+stencil_test_pixels( GLcontext *ctx, GLuint n,
+                     const GLint x[], const GLint y[], GLubyte mask[] )
 {
    GLubyte fail[PB_SIZE];
    GLstencil r, s;
    GLuint i;
-   GLint allfail = 0;
+   GLboolean allfail = GL_FALSE;
+
+   ASSERT(!ctx->Driver.WriteStencilSpan);  /* software stencil buffer only! */
 
    /*
     * Perform stencil test.  The results of this operation are stored
@@ -800,14 +869,14 @@ GLint gl_stencil_pixels( GLcontext *ctx,
               fail[i] = 0;
            }
         }
-        allfail = 1;
+        allfail = GL_TRUE;
         break;
       case GL_LESS:
-        r = ctx->Stencil.Ref & ctx->Stencil.ValueMask;
+        r = (GLstencil) (ctx->Stencil.Ref & ctx->Stencil.ValueMask);
         for (i=0;i<n;i++) {
            if (mask[i]) {
                GLstencil *sptr = STENCIL_ADDRESS(x[i],y[i]);
-              s = *sptr & ctx->Stencil.ValueMask;
+              s = (GLstencil) (*sptr & ctx->Stencil.ValueMask);
               if (r < s) {
                  /* passed */
                  fail[i] = 0;
@@ -823,11 +892,11 @@ GLint gl_stencil_pixels( GLcontext *ctx,
         }
         break;
       case GL_LEQUAL:
-        r = ctx->Stencil.Ref & ctx->Stencil.ValueMask;
+        r = (GLstencil) (ctx->Stencil.Ref & ctx->Stencil.ValueMask);
         for (i=0;i<n;i++) {
            if (mask[i]) {
                GLstencil *sptr = STENCIL_ADDRESS(x[i],y[i]);
-              s = *sptr & ctx->Stencil.ValueMask;
+              s = (GLstencil) (*sptr & ctx->Stencil.ValueMask);
               if (r <= s) {
                  /* pass */
                  fail[i] = 0;
@@ -843,11 +912,11 @@ GLint gl_stencil_pixels( GLcontext *ctx,
         }
         break;
       case GL_GREATER:
-        r = ctx->Stencil.Ref & ctx->Stencil.ValueMask;
+        r = (GLstencil) (ctx->Stencil.Ref & ctx->Stencil.ValueMask);
         for (i=0;i<n;i++) {
            if (mask[i]) {
                GLstencil *sptr = STENCIL_ADDRESS(x[i],y[i]);
-              s = *sptr & ctx->Stencil.ValueMask;
+              s = (GLstencil) (*sptr & ctx->Stencil.ValueMask);
               if (r > s) {
                  /* passed */
                  fail[i] = 0;
@@ -863,11 +932,11 @@ GLint gl_stencil_pixels( GLcontext *ctx,
         }
         break;
       case GL_GEQUAL:
-        r = ctx->Stencil.Ref & ctx->Stencil.ValueMask;
+        r = (GLstencil) (ctx->Stencil.Ref & ctx->Stencil.ValueMask);
         for (i=0;i<n;i++) {
            if (mask[i]) {
                GLstencil *sptr = STENCIL_ADDRESS(x[i],y[i]);
-              s = *sptr & ctx->Stencil.ValueMask;
+              s = (GLstencil) (*sptr & ctx->Stencil.ValueMask);
               if (r >= s) {
                  /* passed */
                  fail[i] = 0;
@@ -883,11 +952,11 @@ GLint gl_stencil_pixels( GLcontext *ctx,
         }
         break;
       case GL_EQUAL:
-        r = ctx->Stencil.Ref & ctx->Stencil.ValueMask;
+        r = (GLstencil) (ctx->Stencil.Ref & ctx->Stencil.ValueMask);
         for (i=0;i<n;i++) {
            if (mask[i]) {
                GLstencil *sptr = STENCIL_ADDRESS(x[i],y[i]);
-              s = *sptr & ctx->Stencil.ValueMask;
+              s = (GLstencil) (*sptr & ctx->Stencil.ValueMask);
               if (r == s) {
                  /* passed */
                  fail[i] = 0;
@@ -903,11 +972,11 @@ GLint gl_stencil_pixels( GLcontext *ctx,
         }
         break;
       case GL_NOTEQUAL:
-        r = ctx->Stencil.Ref & ctx->Stencil.ValueMask;
+        r = (GLstencil) (ctx->Stencil.Ref & ctx->Stencil.ValueMask);
         for (i=0;i<n;i++) {
            if (mask[i]) {
                GLstencil *sptr = STENCIL_ADDRESS(x[i],y[i]);
-              s = *sptr & ctx->Stencil.ValueMask;
+              s = (GLstencil) (*sptr & ctx->Stencil.ValueMask);
               if (r != s) {
                  /* passed */
                  fail[i] = 0;
@@ -933,90 +1002,152 @@ GLint gl_stencil_pixels( GLcontext *ctx,
          return 0;
    }
 
-   apply_stencil_op_to_pixels( ctx, n, x, y, ctx->Stencil.FailFunc, fail );
+   if (ctx->Stencil.FailFunc != GL_KEEP) {
+      apply_stencil_op_to_pixels( ctx, n, x, y, ctx->Stencil.FailFunc, fail );
+   }
 
-   return (allfail) ? 0 : 1;
+   return !allfail;
 }
 
 
 
 
 /*
- * Apply the combination depth-buffer/stencil operator to a span of pixels.
- * Input:  n - number of pixels in the span
- *         x, y - array of [n] pixels to stencil
+ * Apply stencil and depth testing to an array of pixels.
+ * This is used both for software and hardware stencil buffers.
+ *
+ * The comments in this function are a bit sparse but the code is
+ * almost identical to stencil_and_depth_test_span(), which is well
+ * commented.
+ * 
+ * Input:  n - number of pixels in the array
+ *         x, y - array of [n] pixel positions
  *         z - array [n] of z values
- * Input:  mask - array [n] of flags  (1=test this pixel, 0=skip the pixel)
- * Output:  mask - array [n] of flags (1=depth test passed, 0=failed) 
+ *         mask - array [n] of flags  (1=test this pixel, 0=skip the pixel)
+ * Output: mask - array [n] of flags (1=stencil and depth test passed)
+ * Return: GL_TRUE - all fragments failed the testing
+ *         GL_FALSE - one or more fragments passed the testing
  */
-void gl_depth_stencil_pixels( GLcontext *ctx,
-                              GLuint n, const GLint x[], const GLint y[],
-                             const GLdepth z[], GLubyte mask[] )
+GLboolean
+gl_stencil_and_depth_test_pixels( GLcontext *ctx,
+                                  GLuint n, const GLint x[], const GLint y[],
+                                  const GLdepth z[], GLubyte mask[] )
 {
-   if (ctx->Depth.Test==GL_FALSE) {
-      /*
-       * No depth buffer, just apply zpass stencil function to active pixels.
-       */
-      apply_stencil_op_to_pixels( ctx, n, x, y, ctx->Stencil.ZPassFunc, mask );
+   ASSERT(ctx->Stencil.Enabled);
+   ASSERT(n <= PB_SIZE);
+
+   if (ctx->Driver.WriteStencilPixels) {
+      /*** Hardware stencil buffer ***/
+      GLstencil stencil[PB_SIZE];
+      GLubyte mask[PB_SIZE];
+
+      ASSERT(ctx->Driver.ReadStencilPixels);
+      (*ctx->Driver.ReadStencilPixels)(ctx, n, x, y, stencil);
+
+
+      if (do_stencil_test( ctx, n, stencil, mask ) == GL_FALSE) {
+         /* all fragments failed the stencil test, we're done. */
+         return GL_FALSE;
+      }
+
+      if (ctx->Depth.Test == GL_FALSE) {
+         apply_stencil_op( ctx, ctx->Stencil.ZPassFunc, n, stencil, mask );
+      }
+      else {
+         GLubyte passmask[PB_SIZE], failmask[PB_SIZE], oldmask[PB_SIZE];
+         GLuint i;
+
+         MEMCPY(oldmask, mask, n * sizeof(GLubyte));
+
+         _mesa_depth_test_pixels(ctx, n, x, y, z, mask);
+
+         for (i=0;i<n;i++) {
+            ASSERT(mask[i] == 0 || mask[i] == 1);
+            passmask[i] = oldmask[i] & mask[i];
+            failmask[i] = oldmask[i] & (mask[i] ^ 1);
+         }
+
+         if (ctx->Stencil.ZFailFunc != GL_KEEP) {
+            apply_stencil_op( ctx, ctx->Stencil.ZFailFunc, n, stencil, failmask );
+         }
+         if (ctx->Stencil.ZPassFunc != GL_KEEP) {
+            apply_stencil_op( ctx, ctx->Stencil.ZPassFunc, n, stencil, passmask );
+         }
+      }
+
+      /* Write updated stencil values into hardware stencil buffer */
+      (ctx->Driver.WriteStencilPixels)(ctx, n, x, y, stencil, mask );
+
+      return GL_TRUE;
+
    }
    else {
-      /*
-       * Perform depth buffering, then apply zpass or zfail stencil function.
-       */
-      GLubyte passmask[PB_SIZE], failmask[PB_SIZE], oldmask[PB_SIZE];
-      GLuint i;
+      /*** Software stencil buffer ***/
 
-      /* init pass and fail masks to zero */
-      for (i=0;i<n;i++) {
-        passmask[i] = failmask[i] = 0;
-         oldmask[i] = mask[i];
+      if (stencil_test_pixels(ctx, n, x, y, mask) == GL_FALSE) {
+         /* all fragments failed the stencil test, we're done. */
+         return GL_FALSE;
       }
 
-      /* apply the depth test */
-      if (ctx->Driver.DepthTestPixels)
-         (*ctx->Driver.DepthTestPixels)( ctx, n, x, y, z, mask );
 
-      /* set the stencil pass/fail flags according to result of depth test */
-      for (i=0;i<n;i++) {
-         if (oldmask[i]) {
-            if (mask[i]) {
-               passmask[i] = 1;
-            }
-            else {
-               failmask[i] = 1;
-            }
+      if (ctx->Depth.Test==GL_FALSE) {
+         apply_stencil_op_to_pixels( ctx, n, x, y, ctx->Stencil.ZPassFunc, mask );
+      }
+      else {
+         GLubyte passmask[PB_SIZE], failmask[PB_SIZE], oldmask[PB_SIZE];
+         GLuint i;
+
+         MEMCPY(oldmask, mask, n * sizeof(GLubyte));
+
+         _mesa_depth_test_pixels(ctx, n, x, y, z, mask);
+
+         for (i=0;i<n;i++) {
+            ASSERT(mask[i] == 0 || mask[i] == 1);
+            passmask[i] = oldmask[i] & mask[i];
+            failmask[i] = oldmask[i] & (mask[i] ^ 1);
+         }
+
+         if (ctx->Stencil.ZFailFunc != GL_KEEP) {
+            apply_stencil_op_to_pixels( ctx, n, x, y,
+                                        ctx->Stencil.ZFailFunc, failmask );
+         }
+         if (ctx->Stencil.ZPassFunc != GL_KEEP) {
+            apply_stencil_op_to_pixels( ctx, n, x, y,
+                                        ctx->Stencil.ZPassFunc, passmask );
          }
       }
 
-      /* apply the pass and fail operations */
-      apply_stencil_op_to_pixels( ctx, n, x, y,
-                                  ctx->Stencil.ZFailFunc, failmask );
-      apply_stencil_op_to_pixels( ctx, n, x, y,
-                                  ctx->Stencil.ZPassFunc, passmask );
+      return GL_TRUE;  /* one or more fragments passed both tests */
    }
-
 }
 
 
 
 /*
  * Return a span of stencil values from the stencil buffer.
+ * Used for glRead/CopyPixels
  * Input:  n - how many pixels
  *         x,y - location of first pixel
  * Output:  stencil - the array of stencil values
  */
 void gl_read_stencil_span( GLcontext *ctx,
-                           GLuint n, GLint x, GLint y, GLstencil stencil[] )
+                           GLint n, GLint x, GLint y, GLstencil stencil[] )
 {
-   if (ctx->Buffer->Stencil) {
-      const GLstencil *s = STENCIL_ADDRESS( x, y );
+   ASSERT(n >= 0);
+   if (ctx->DrawBuffer->Stencil) {
+      if (ctx->Driver.ReadStencilSpan) {
+         (*ctx->Driver.ReadStencilSpan)( ctx, (GLuint) n, x, y, stencil );
+      }
+      else {
+         const GLstencil *s = STENCIL_ADDRESS( x, y );
 #if STENCIL_BITS == 8
-      MEMCPY( stencil, s, n * sizeof(GLstencil) );
+         MEMCPY( stencil, s, n * sizeof(GLstencil) );
 #else
-      GLuint i;
-      for (i=0;i<n;i++)
-         stencil[i] = s[i];
+         GLuint i;
+         for (i=0;i<n;i++)
+            stencil[i] = s[i];
 #endif
+      }
    }
 }
 
@@ -1024,23 +1155,46 @@ void gl_read_stencil_span( GLcontext *ctx,
 
 /*
  * Write a span of stencil values to the stencil buffer.
+ * Used for glDraw/CopyPixels
  * Input:  n - how many pixels
- *         x,y - location of first pixel
+ *         x, y - location of first pixel
  *         stencil - the array of stencil values
  */
 void gl_write_stencil_span( GLcontext *ctx,
-                            GLuint n, GLint x, GLint y,
+                            GLint n, GLint x, GLint y,
                            const GLstencil stencil[] )
 {
-   if (ctx->Buffer->Stencil) {
-      GLstencil *s = STENCIL_ADDRESS( x, y );
+   ASSERT(n >= 0);
+   if (ctx->DrawBuffer->Stencil) {
+      /* do clipping */
+      if (y < ctx->DrawBuffer->Ymin || y > ctx->DrawBuffer->Ymax)
+         return;
+      if (x < ctx->DrawBuffer->Xmin) {
+         GLint diff = ctx->DrawBuffer->Xmin - x;
+         n -= diff;
+         stencil += diff;
+         x = ctx->DrawBuffer->Xmin;
+      }
+      if (x + n > ctx->DrawBuffer->Xmax) {
+         GLint diff = x + n - ctx->DrawBuffer->Xmax;
+         n -= diff;
+      }
+
+      ASSERT( n >= 0);
+
+      if (ctx->Driver.WriteStencilSpan) {
+         (*ctx->Driver.WriteStencilSpan)( ctx, n, x, y, stencil, NULL );
+      }
+      else {
+         GLstencil *s = STENCIL_ADDRESS( x, y );
 #if STENCIL_BITS == 8
-      MEMCPY( s, stencil, n * sizeof(GLstencil) );
+         MEMCPY( s, stencil, n * sizeof(GLstencil) );
 #else
-      GLuint i;
-      for (i=0;i<n;i++)
-         s[i] = stencil[i];
+         GLuint i;
+         for (i=0;i<n;i++)
+            s[i] = stencil[i];
 #endif
+      }
    }
 }
 
@@ -1052,63 +1206,199 @@ void gl_write_stencil_span( GLcontext *ctx,
  */
 void gl_alloc_stencil_buffer( GLcontext *ctx )
 {
-   GLuint buffersize = ctx->Buffer->Width * ctx->Buffer->Height;
+   GLuint buffersize = ctx->DrawBuffer->Width * ctx->DrawBuffer->Height;
 
    /* deallocate current stencil buffer if present */
-   if (ctx->Buffer->Stencil) {
-      FREE(ctx->Buffer->Stencil);
-      ctx->Buffer->Stencil = NULL;
+   if (ctx->DrawBuffer->Stencil) {
+      FREE(ctx->DrawBuffer->Stencil);
+      ctx->DrawBuffer->Stencil = NULL;
    }
 
    /* allocate new stencil buffer */
-   ctx->Buffer->Stencil = (GLstencil *) MALLOC(buffersize * sizeof(GLstencil));
-   if (!ctx->Buffer->Stencil) {
+   ctx->DrawBuffer->Stencil = (GLstencil *) MALLOC(buffersize * sizeof(GLstencil));
+   if (!ctx->DrawBuffer->Stencil) {
       /* out of memory */
-      gl_set_enable( ctx, GL_STENCIL_TEST, GL_FALSE );
+      _mesa_set_enable( ctx, GL_STENCIL_TEST, GL_FALSE );
       gl_error( ctx, GL_OUT_OF_MEMORY, "gl_alloc_stencil_buffer" );
    }
 }
 
 
 
-
 /*
- * Clear the stencil buffer.  If the stencil buffer doesn't exist yet we'll
- * allocate it now.
+ * Clear the software (malloc'd) stencil buffer.
  */
-void gl_clear_stencil_buffer( GLcontext *ctx )
+static void
+clear_software_stencil_buffer( GLcontext *ctx )
 {
-   if (ctx->Visual->StencilBits==0 || !ctx->Buffer->Stencil) {
+   if (ctx->Visual->StencilBits==0 || !ctx->DrawBuffer->Stencil) {
       /* no stencil buffer */
       return;
    }
 
    if (ctx->Scissor.Enabled) {
       /* clear scissor region only */
-      GLint y;
-      GLint width = ctx->Buffer->Xmax - ctx->Buffer->Xmin + 1;
-      for (y=ctx->Buffer->Ymin; y<=ctx->Buffer->Ymax; y++) {
-         GLstencil *ptr = STENCIL_ADDRESS( ctx->Buffer->Xmin, y );
+      const GLint width = ctx->DrawBuffer->Xmax - ctx->DrawBuffer->Xmin + 1;
+      if (ctx->Stencil.WriteMask != STENCIL_MAX) {
+         /* must apply mask to the clear */
+         GLint y;
+         for (y = ctx->DrawBuffer->Ymin; y <= ctx->DrawBuffer->Ymax; y++) {
+            const GLstencil mask = ctx->Stencil.WriteMask;
+            const GLstencil invMask = ~mask;
+            const GLstencil clearVal = (ctx->Stencil.Clear & mask);
+            GLstencil *stencil = STENCIL_ADDRESS( ctx->DrawBuffer->Xmin, y );
+            GLint i;
+            for (i = 0; i < width; i++) {
+               stencil[i] = (stencil[i] & invMask) | clearVal;
+            }
+         }
+      }
+      else {
+         /* no masking */
+         GLint y;
+         for (y = ctx->DrawBuffer->Ymin; y <= ctx->DrawBuffer->Ymax; y++) {
+            GLstencil *stencil = STENCIL_ADDRESS( ctx->DrawBuffer->Xmin, y );
 #if STENCIL_BITS==8
-         MEMSET( ptr, ctx->Stencil.Clear, width * sizeof(GLstencil) );
+            MEMSET( stencil, ctx->Stencil.Clear, width * sizeof(GLstencil) );
 #else
-         GLint x;
-         for (x = 0; x < width; x++)
-            ptr[x] = ctx->Stencil.Clear;
+            GLint i;
+            for (i = 0; i < width; i++)
+               stencil[x] = ctx->Stencil.Clear;
 #endif
+         }
       }
    }
    else {
       /* clear whole stencil buffer */
+      if (ctx->Stencil.WriteMask != STENCIL_MAX) {
+         /* must apply mask to the clear */
+         const GLuint n = ctx->DrawBuffer->Width * ctx->DrawBuffer->Height;
+         GLstencil *stencil = ctx->DrawBuffer->Stencil;
+         const GLstencil mask = ctx->Stencil.WriteMask;
+         const GLstencil invMask = ~mask;
+         const GLstencil clearVal = (ctx->Stencil.Clear & mask);
+         GLuint i;
+         for (i = 0; i < n; i++) {
+            stencil[i] = (stencil[i] & invMask) | clearVal;
+         }
+      }
+      else {
+         /* clear whole buffer without masking */
+         const GLuint n = ctx->DrawBuffer->Width * ctx->DrawBuffer->Height;
+         GLstencil *stencil = ctx->DrawBuffer->Stencil;
+
 #if STENCIL_BITS==8
-      MEMSET( ctx->Buffer->Stencil, ctx->Stencil.Clear,
-              ctx->Buffer->Width * ctx->Buffer->Height * sizeof(GLstencil) );
+         MEMSET(stencil, ctx->Stencil.Clear, n * sizeof(GLstencil) );
 #else
-      GLuint i;
-      GLuint pixels = ctx->Buffer->Width * ctx->Buffer->Height;
-      GLstencil *buffer = ctx->Buffer->Stencil;
-      for (i = 0; i < pixels; i++)
-         ptr[i] = ctx->Stencil.Clear;
+         GLuint i;
+         for (i = 0; i < n; i++) {
+            stencil[i] = ctx->Stencil.Clear;
+         }
 #endif
+      }
    }
 }
+
+
+
+/*
+ * Clear the hardware (in graphics card) stencil buffer.
+ * This is done with the Driver.WriteStencilSpan() and Driver.ReadStencilSpan()
+ * functions.
+ * Actually, if there is a hardware stencil buffer it really should have
+ * been cleared in Driver.Clear()!  However, if the hardware does not
+ * support scissored clears or masked clears (i.e. glStencilMask) then
+ * we have to use the span-based functions.
+ */
+static void
+clear_hardware_stencil_buffer( GLcontext *ctx )
+{
+   ASSERT(ctx->Driver.WriteStencilSpan);
+   ASSERT(ctx->Driver.ReadStencilSpan);
+
+   if (ctx->Scissor.Enabled) {
+      /* clear scissor region only */
+      const GLint x = ctx->DrawBuffer->Xmin;
+      const GLint width = ctx->DrawBuffer->Xmax - ctx->DrawBuffer->Xmin + 1;
+      if (ctx->Stencil.WriteMask != STENCIL_MAX) {
+         /* must apply mask to the clear */
+         GLint y;
+         for (y = ctx->DrawBuffer->Ymin; y <= ctx->DrawBuffer->Ymax; y++) {
+            const GLstencil mask = ctx->Stencil.WriteMask;
+            const GLstencil invMask = ~mask;
+            const GLstencil clearVal = (ctx->Stencil.Clear & mask);
+            GLstencil stencil[MAX_WIDTH];
+            GLint i;
+            (*ctx->Driver.ReadStencilSpan)(ctx, x, y, width, stencil);
+            for (i = 0; i < width; i++) {
+               stencil[i] = (stencil[i] & invMask) | clearVal;
+            }
+            (*ctx->Driver.WriteStencilSpan)(ctx, x, y, width, stencil, NULL);
+         }
+      }
+      else {
+         /* no masking */
+         GLstencil stencil[MAX_WIDTH];
+         GLint y, i;
+         for (i = 0; i < width; i++) {
+            stencil[i] = ctx->Stencil.Clear;
+         }
+         for (y = ctx->DrawBuffer->Ymin; y <= ctx->DrawBuffer->Ymax; y++) {
+            (*ctx->Driver.WriteStencilSpan)(ctx, x, y, width, stencil, NULL);
+         }
+      }
+   }
+   else {
+      /* clear whole stencil buffer */
+      if (ctx->Stencil.WriteMask != STENCIL_MAX) {
+         /* must apply mask to the clear */
+         const GLstencil mask = ctx->Stencil.WriteMask;
+         const GLstencil invMask = ~mask;
+         const GLstencil clearVal = (ctx->Stencil.Clear & mask);
+         const GLint width = ctx->DrawBuffer->Width;
+         const GLint height = ctx->DrawBuffer->Height;
+         const GLint x = ctx->DrawBuffer->Xmin;
+         GLint y;
+         for (y = 0; y < height; y++) {
+            GLstencil stencil[MAX_WIDTH];
+            GLuint i;
+            (*ctx->Driver.ReadStencilSpan)(ctx, x, y, width, stencil);
+            for (i = 0; i < width; i++) {
+               stencil[i] = (stencil[i] & invMask) | clearVal;
+            }
+            (*ctx->Driver.WriteStencilSpan)(ctx, x, y, width, stencil, NULL);
+         }
+      }
+      else {
+         /* clear whole buffer without masking */
+         const GLint width = ctx->DrawBuffer->Width;
+         const GLint height = ctx->DrawBuffer->Width;
+         const GLint x = ctx->DrawBuffer->Xmin;
+         GLstencil stencil[MAX_WIDTH];
+         GLint y, i;
+         for (i = 0; i < width; i++) {
+            stencil[i] = ctx->Stencil.Clear;
+         }
+         for (y = 0; y < height; y++) {
+            (*ctx->Driver.WriteStencilSpan)(ctx, x, y, width, stencil, NULL);
+         }
+      }
+   }
+}
+
+
+
+/*
+ * Clear the stencil buffer.
+ */
+void gl_clear_stencil_buffer( GLcontext *ctx )
+{
+   if (ctx->Driver.WriteStencilSpan) {
+      ASSERT(ctx->Driver.ReadStencilSpan);
+      clear_hardware_stencil_buffer(ctx);
+   }
+   else {
+      clear_software_stencil_buffer(ctx);
+   }
+}
+