summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorDavid Thompson <dthompson2@worcester.edu>2020-12-05 12:49:50 -0500
committerDavid Thompson <dthompson2@worcester.edu>2020-12-05 12:52:11 -0500
commit5d313ab4e8584c1d9dbfccf5c69bc48a43ee37c8 (patch)
tree9c0655e7c37bc188902d2395fe89af0f133644dc /doc
parentf68b22ee64a737b121d5f4eb306175a3a53341bf (diff)
video: Change window size/position procedures to return multiple values.
Diffstat (limited to 'doc')
-rw-r--r--doc/api.texi17
1 files changed, 7 insertions, 10 deletions
diff --git a/doc/api.texi b/doc/api.texi
index f72178b..2ce58b9 100644
--- a/doc/api.texi
+++ b/doc/api.texi
@@ -93,25 +93,22 @@ Return the title for @var{window}.
@end deffn
@deffn {Procedure} window-size window
-Return the dimensions of @var{window}.
+Return 2 values for the dimensions of @var{window}.
@end deffn
@deffn {Procedure} window-minimum-size window
-Return the minimal dimensions, that @var{window} should take.
-Note, that SDL does not always enforce this restriction, so you might end up
-with a window-size, that is actually smaller than the value returned by this
-function.
+Return 2 values for the minimal dimensions that @var{window} can be.
+Note that SDL does not always enforce this restriction, so you might
+end up with a window size that is actually smaller than the value
+returned by this procedure.
@end deffn
@deffn {Procedure} window-maximum-size window
-Return the maximal dimensions, that @var{window} should take.
-Note, that SDL does not always enforce this restriction, so you might end up
-with a window-size, that is actually larger than the value returned by this
-function.
+Return 2 values for the maximum dimensions that @var{window} can be.
@end deffn
@deffn {Procedure} window-position window
-Return the position of @var{window} on the display.
+Return 2 values for the position of @var{window} on the display.
@end deffn
@deffn {Procedure} window-id window