From abf24b4cfae9fb298d29e043d3cea0d745608713 Mon Sep 17 00:00:00 2001
From: David Thompson <dthompson2@worcester.edu>
Date: Wed, 27 Aug 2014 11:27:01 -0400
Subject: sprite: Add docstring for make-sprite.

* sly/sprite.scm (make-sprite): Add docstring.
---
 sly/sprite.scm | 3 +++
 1 file changed, 3 insertions(+)

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))
-- 
cgit v1.2.3