summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDavid Thompson <dthompson2@worcester.edu>2017-01-25 22:25:57 -0500
committerDavid Thompson <dthompson2@worcester.edu>2017-01-25 22:25:57 -0500
commita68ae4ea988e09741eaa98e5514d78170d028ab6 (patch)
tree6e539dc1103b78f37e05fb9db875541ffc857962
parent92fbc130909cc0bfd17430c590c5b42475385682 (diff)
render: shapes: Add docstring to draw-line.
* chickadee/render/shapes.scm (draw-line): Add docstring.
-rw-r--r--chickadee/render/shapes.scm6
1 files changed, 6 insertions, 0 deletions
diff --git a/chickadee/render/shapes.scm b/chickadee/render/shapes.scm
index 6981807..fe0df72 100644
--- a/chickadee/render/shapes.scm
+++ b/chickadee/render/shapes.scm
@@ -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))