diff options
author | David Thompson <dthompson2@worcester.edu> | 2017-01-25 22:28:49 -0500 |
---|---|---|
committer | David Thompson <dthompson2@worcester.edu> | 2017-01-25 22:28:49 -0500 |
commit | 41e434cead35a8527ae264514ce2de15ade88d7e (patch) | |
tree | 5e475bb7b39dfa2da7464e27da7345ece43a47b7 /doc/api.texi | |
parent | 6306a7dc561d1108586c4a9c27b869f9a60e18a5 (diff) |
doc: Document draw-line.
Diffstat (limited to 'doc/api.texi')
-rw-r--r-- | doc/api.texi | 18 |
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 |