summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDavid Thompson <dthompson2@worcester.edu>2014-08-27 11:27:01 -0400
committerDavid Thompson <dthompson2@worcester.edu>2014-08-27 11:27:01 -0400
commitabf24b4cfae9fb298d29e043d3cea0d745608713 (patch)
treefb40c39d0e51ab4bb812e4a783b2d72fa81c3b50
parent318b28053599249873e6cb89714953beb56774cc (diff)
sprite: Add docstring for make-sprite.
* sly/sprite.scm (make-sprite): Add docstring.
-rw-r--r--sly/sprite.scm3
1 files changed, 3 insertions, 0 deletions
diff --git a/sly/sprite.scm b/sly/sprite.scm
index 064ec66..ef35d2e 100644
--- a/sly/sprite.scm
+++ b/sly/sprite.scm
@@ -45,6 +45,9 @@
;;;
(define* (make-sprite texture #:optional #:key (shader (load-default-shader)))
+ "Return a 2D rectangular mesh that displays the image TEXTURE. The
+size of the mesh is the size of TEXTURE, in pixels. Optionally, a
+custom SHADER can be specified."
(let* ((half-width (half (texture-width texture)))
(half-height (half (texture-height texture)))
(s1 (texture-s1 texture))