doc: Document draw-line.

1 files changed, 18 insertions, 0 deletions

diff --git a/doc/api.texi b/doc/api.texi
index 9f4ca69..3ea8687 100644
--- a/doc/api.texi
+++ b/doc/api.texi
@@ -626,6 +626,24 @@ the other arguments.
 @node Lines and Shapes
 @subsection Lines and Shapes
 
+Sprites are fun, but sometimes simple, untextured lines and polygons
+are desired.  That's where the @code{(chickadee render shapes)} module
+comes in!
+
+@deffn {Scheme Procedure} draw-line @var{start} @var{end} @
+       [#:thickness 0.5] [#:feather 1.0] [#:cap round] [#:color] @
+       [#:shader]
+
+Draw a line segment from @var{start} to @var{end}. The line will be
+@var{thickness} pixels thick with an antialiased border @var{feather}
+pixels wide.  The line will be colored @var{color}. @var{cap}
+specifies the type of end cap that should be used to terminate the
+lines, either @code{none}, @code{butt}, @code{square}, @code{round},
+@code{triangle-in}, or @code{triangle-out}.  Advanced users may use
+the @var{shader} argument to override the built-in line segment
+shader.
+@end deffn
+
 @node Fonts
 @subsection Fonts