Mesa (master): mesa: document _mesa_prim::begin/end

[GitLab Mirror]

Module: Mesa
Branch: master
Commit: ee549c67668289e262243b6549a5faf230aa0fd6
URL:    http://cgit.freedesktop.org/mesa/mesa/commit/?id=ee549c67668289e262243b6549a5faf230aa0fd6

Author: Marek Olšák <marek.olsak at amd.com>
Date:   Mon Feb 10 20:47:11 2020 -0500

mesa: document _mesa_prim::begin/end

Reviewed-by: Mathias Fröhlich <mathias.froehlich at web.de>
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/merge_requests/3861>

---

 src/mesa/main/draw.h | 12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/src/mesa/main/draw.h b/src/mesa/main/draw.h
index 8fa511ef0a3..528696de60f 100644
--- a/src/mesa/main/draw.h
+++ b/src/mesa/main/draw.h
@@ -44,7 +44,19 @@ struct _mesa_prim
 {
    GLubyte mode;    /**< GL_POINTS, GL_LINES, GL_QUAD_STRIP, etc */
    bool indexed;
+
+   /**
+    * tnl: If true, line stipple emulation will reset the pattern walker.
+    * vbo: If false and the primitive is a line loop, the first vertex is
+    *      the beginning of the line loop and it won't be drawn.
+    *      Instead, it will be moved to the end.
+    */
    bool begin;
+
+   /**
+    * tnl: If true and the primitive is a line loop, it will be closed.
+    * vbo: Same as tnl.
+    */
    bool end;
 
    GLuint start;