summaryrefslogtreecommitdiff
path: root/src/gallium/docs/source/cso/dsa.rst
diff options
context:
space:
mode:
authorCorbin Simpson <MostAwesomeDude@gmail.com>2010-01-05 08:37:49 -0800
committerCorbin Simpson <MostAwesomeDude@gmail.com>2010-01-05 08:37:49 -0800
commit3e18bad36d90255dca6cb519eb7ecfc540c292c1 (patch)
tree1d9d7dc8a24baf21d1758be65f5cf5dadf85e8f1 /src/gallium/docs/source/cso/dsa.rst
parent897cb8950ae14ffe7029b1daf16113ff62ce0dfe (diff)
parent467cccf0a77e225b886711db2b0b929ecf71e411 (diff)
Merge branch 'gallium-docs'
Diffstat (limited to 'src/gallium/docs/source/cso/dsa.rst')
-rw-r--r--src/gallium/docs/source/cso/dsa.rst58
1 files changed, 58 insertions, 0 deletions
diff --git a/src/gallium/docs/source/cso/dsa.rst b/src/gallium/docs/source/cso/dsa.rst
new file mode 100644
index 0000000000..12abaa9d6f
--- /dev/null
+++ b/src/gallium/docs/source/cso/dsa.rst
@@ -0,0 +1,58 @@
+.. _depth,stencil,&alpha:
+
+Depth, Stencil, & Alpha
+=======================
+
+These three states control the depth, stencil, and alpha tests, used to
+discard fragments that have passed through the fragment shader.
+
+Traditionally, these three tests have been clumped together in hardware, so
+they are all stored in one structure.
+
+During actual execution, the order of operations done on fragments is always:
+
+* Stencil
+* Depth
+* Alpha
+
+Depth Members
+-------------
+
+enabled
+ Whether the depth test is enabled.
+writemask
+ Whether the depth buffer receives depth writes.
+func
+ The depth test function. One of PIPE_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.
+func
+ The stencil test function. One of PIPE_FUNC.
+ref_value
+ Stencil test reference value; used for certain functions.
+fail_op
+ The operation to carry out if the stencil test fails. One of
+ PIPE_STENCIL_OP.
+zfail_op
+ The operation to carry out if the stencil test passes but the depth test
+ fails. One of PIPE_STENCIL_OP.
+zpass_op
+ The operation to carry out if the stencil test and depth test both pass.
+ One of PIPE_STENCIL_OP.
+
+Alpha Members
+-------------
+
+enabled
+ Whether the alpha test is enabled.
+func
+ The alpha test function. One of PIPE_FUNC.
+ref_value
+ Alpha test reference value; used for certain functions.