render: shapes: Add docstring to draw-line.
authorDavid Thompson <dthompson2@worcester.edu>
Thu, 26 Jan 2017 03:25:57 +0000 (22:25 -0500)
committerDavid Thompson <dthompson2@worcester.edu>
Thu, 26 Jan 2017 03:25:57 +0000 (22:25 -0500)
* chickadee/render/shapes.scm (draw-line): Add docstring.

chickadee/render/shapes.scm

index 6981807..fe0df72 100644 (file)
@@ -131,6 +131,12 @@ void main (void) {
                     (cap 'round)
                     (color white)
                     (shader (force default-shader)))
+      "Draw a line segment from START to END. The line will be
+THICKNESS pixels thick with an antialiased border FEATHER pixels wide.
+The line will be colored COLOR. CAP specifies the type of end cap that
+should be used to terminate the lines, either 'none', 'butt',
+'square', 'round', 'triangle-in', or 'triangle-out'.  Advanced users
+may use SHADER to override the built-in line segment shader."
       (let* ((x1 (vec2-x start))
              (y1 (vec2-y start))
              (x2 (vec2-x end))