Mesa (lp-binning): llvmpipe: added function comments

[Brian Paul]

Module: Mesa
Branch: lp-binning
Commit: 7d9b97703aba0c751e2cf10025859cbfe66074b4
URL:    http://cgit.freedesktop.org/mesa/mesa/commit/?id=7d9b97703aba0c751e2cf10025859cbfe66074b4

Author: Brian Paul <brianp at vmware.com>
Date:   Thu Dec 17 14:22:43 2009 -0700

llvmpipe: added function comments

---

 src/gallium/drivers/llvmpipe/lp_bld_flow.c |   15 +++++++++++++++
 1 files changed, 15 insertions(+), 0 deletions(-)

diff --git a/src/gallium/drivers/llvmpipe/lp_bld_flow.c b/src/gallium/drivers/llvmpipe/lp_bld_flow.c
index dcc25fb..420d062 100644
--- a/src/gallium/drivers/llvmpipe/lp_bld_flow.c
+++ b/src/gallium/drivers/llvmpipe/lp_bld_flow.c
@@ -402,6 +402,13 @@ lp_build_mask_check(struct lp_build_mask_context *mask)
 }
 
 
+/**
+ * Begin a section of code which is predicated on a mask.
+ * \param mask  the mask context, initialized here
+ * \param flow  the flow context
+ * \param type  the type of the mask
+ * \param value  storage for the mask
+ */
 void
 lp_build_mask_begin(struct lp_build_mask_context *mask,
                     struct lp_build_flow_context *flow,
@@ -422,6 +429,11 @@ lp_build_mask_begin(struct lp_build_mask_context *mask,
 }
 
 
+/**
+ * Update boolean mask with given value (bitwise AND).
+ * Typically used to update the quad's pixel alive/killed mask
+ * after depth testing, alpha testing, TGSI_OPCODE_KIL, etc.
+ */
 void
 lp_build_mask_update(struct lp_build_mask_context *mask,
                      LLVMValueRef value)
@@ -432,6 +444,9 @@ lp_build_mask_update(struct lp_build_mask_context *mask,
 }
 
 
+/**
+ * End section of code which is predicated on a mask.
+ */
 LLVMValueRef
 lp_build_mask_end(struct lp_build_mask_context *mask)
 {