[gsharp-cvs] CVS update: gsharp/sdl.lisp

[Robert Strandh]

Update of /project/gsharp/cvsroot/gsharp
In directory common-lisp.net:/tmp/cvs-serv7296

Modified Files:
	sdl.lisp 
Log Message:
Make the conventions of glyph-offsets explicit.

Date: Thu Nov 10 19:32:19 2005
Author: rstrandh

Index: gsharp/sdl.lisp
diff -u gsharp/sdl.lisp:1.7 gsharp/sdl.lisp:1.8
--- gsharp/sdl.lisp:1.7	Tue Nov  8 06:16:14 2005
+++ gsharp/sdl.lisp	Thu Nov 10 19:32:19 2005
@@ -5,7 +5,12 @@
 		   (make-pathname :directory (pathname-directory *load-truename*))))
 
 (defgeneric glyph (font glyph-no))
-(defgeneric glyph-offsets (font glyph-no))
+(defgeneric glyph-offsets (font glyph-no)
+  (:documentation "Return two values, DX and DY to be added to the reference point of
+a glyph in order to obtain its upper-left corner.  If (as is usually the case) 
+the reference point is somewhere inside the bounding box of the glyph, this
+means that both the values returned are negative"))
+
 (defgeneric staff-line-distance (font))
 (defgeneric staff-line-offsets (font))
 (defgeneric stem-offsets (font))