From: Roland Scheidegger <sroland@vmware.com>
Date: Tue, 9 Feb 2010 20:48:43 +0000 (+0100)
Subject: docs: fix up documentation for stencil ref value changes
X-Git-Url: https://git.libre-soc.org/?a=commitdiff_plain;h=98f8c4d0bb702c69fcddb504ddb702abc3aacc06;p=mesa.git

docs: fix up documentation for stencil ref value changes

Also fix and clarify depth/stencil/alpha documentation a bit.
---

diff --git a/src/gallium/docs/source/context.rst b/src/gallium/docs/source/context.rst
index a7669575b95..9080addba44 100644
--- a/src/gallium/docs/source/context.rst
+++ b/src/gallium/docs/source/context.rst
@@ -49,8 +49,9 @@ Non-CSO State
 
 These pieces of state are too small, variable, and/or trivial to have CSO
 objects. They all follow simple, one-method binding calls, e.g.
-``set_edgeflags``.
-
+``set_blend_color``.
+* ``set_stencil_ref`` sets the stencil front and back reference values
+  which are used as comparison values in stencil test.
 * ``set_blend_color``
 * ``set_clip_state``
 * ``set_polygon_stipple``
diff --git a/src/gallium/docs/source/cso/dsa.rst b/src/gallium/docs/source/cso/dsa.rst
index 12abaa9d6fe..1bbe381f9e9 100644
--- a/src/gallium/docs/source/cso/dsa.rst
+++ b/src/gallium/docs/source/cso/dsa.rst
@@ -11,9 +11,9 @@ they are all stored in one structure.
 
 During actual execution, the order of operations done on fragments is always:
 
+* Alpha
 * Stencil
 * Depth
-* Alpha
 
 Depth Members
 -------------
@@ -28,15 +28,18 @@ func
 Stencil Members
 ---------------
 
-XXX document valuemask, writemask
-
 enabled
     Whether the stencil test is enabled. For the second stencil, whether the
-    two-sided stencil is enabled.
+    two-sided stencil is enabled. If two-sided stencil is disabled, the other
+    fields for the second array member are not valid.
 func
     The stencil test function. One of PIPE_FUNC.
-ref_value
-    Stencil test reference value; used for certain functions.
+valuemask
+    Stencil test value mask; this is ANDed with the value in the stencil
+    buffer and the reference value before doing the stencil comparison test.
+writemask
+    Stencil test writemask; this controls which bits of the stencil buffer
+    are written.
 fail_op
     The operation to carry out if the stencil test fails. One of
     PIPE_STENCIL_OP.