summaryrefslogtreecommitdiff
path: root/doc/api.texi
diff options
context:
space:
mode:
authorDavid Thompson <dthompson2@worcester.edu>2023-05-24 07:51:26 -0400
committerDavid Thompson <dthompson2@worcester.edu>2023-05-24 07:51:26 -0400
commit1759fa0a056f99a61867c393708c210b37af712f (patch)
tree840669bfc8ab27d9a32fce090050cc6574519df1 /doc/api.texi
parent915836a8fdde35ef3b4dd24ba3387467f7bce5b1 (diff)
Document new #:smooth? arg for load-font in manual.v0.10.0
Diffstat (limited to 'doc/api.texi')
-rw-r--r--doc/api.texi6
1 files changed, 5 insertions, 1 deletions
diff --git a/doc/api.texi b/doc/api.texi
index 468c5a3..50ce301 100644
--- a/doc/api.texi
+++ b/doc/api.texi
@@ -2089,13 +2089,17 @@ the above example.
The following procedures can be found in the @code{(chickadee graphics
text)} module:
-@deffn {Procedure} load-font file-name point-size [#:char-set]
+@deffn {Procedure} load-font file-name point-size [#:char-set] [#:smooth? #t]
Load the scalable (OpenType, TrueType, etc.) font in the file
@var{file-name} and display it at the given @var{point-size}. By
default, all the characters in the ASCII character set are loaded.
This can be changed by passing a different character set
(@pxref{Character Sets,,, guile, GNU Guile Reference Manual}) using
the @var{char-set} keyword argument.
+
+If @var{smooth?} is @code{#t} (the default), text rendered with this
+font will have a smoother appearance when text is rotated or scaled,
+otherwise non-smooth scaling will be used.
@end deffn
@deffn {Procedure} load-bitmap-font file