From 0fe14aaf972b0cc00a7f7c3162c39b0ad422d7d9 Mon Sep 17 00:00:00 2001
From: David Thompson <dthompson2@worcester.edu>
Date: Sat, 13 May 2023 11:21:13 -0400
Subject: Add window event handlers to run-game.

---
 doc/api.texi | 73 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 72 insertions(+), 1 deletion(-)

(limited to 'doc/api.texi')

diff --git a/doc/api.texi b/doc/api.texi
index b9e2229..468c5a3 100644
--- a/doc/api.texi
+++ b/doc/api.texi
@@ -46,7 +46,13 @@ calling @code{run-game} is already taken care of for you.
        [#:key-press] [#:key-release] [#:text-input] @
        [#:mouse-press] [#:mouse-release] [#:mouse-move] @
        [#:controller-add] [#:controller-remove] [#:controller-press] @
-       [#:controller-release] [#:controller-move] [#:error]
+       [#:controller-release] [#:controller-move] @
+       [#:window-keyboard-enter] [#:window-keyboard-leave] @
+       [#:window-mouse-enter] [#:window-mouse-leave] @
+       [#:window-show] [#:window-hide] @
+       [#:window-minimize] [#:window-maximize] @
+       [#:window-move] [#:window-resize] @
+       [#:error]
 
 Run the Chickadee game loop.
 
@@ -291,6 +297,71 @@ values are:
 
 @end enumerate
 
+@item
+@var{window-keyboard-enter}: Called with zero arguments when the
+window gains keyboard focus.
+
+@item
+@var{window-keyboard-leave}: Called with zero arguments when the
+window loses keyboard focus.
+
+@item
+@var{window-mouse-enter}: Called with zero arguments when the window
+gains mouse focus.
+
+@item
+@var{window-mouse-leave}: Called with zero arguments when the window
+loses mouse focus.
+
+@item
+@var{window-show}: Called with zero arguments when the window is
+shown after having been hidden.
+
+@item
+@var{window-hide}: Called with zero arguments when the window is
+hidden.
+
+@item
+@var{window-minimize}: Called with zero arguments when the window is
+minimized.
+
+@item
+@var{window-maximize}: Called with zero arguments when the window is
+maximized.
+
+@item
+@var{window-move}: Called with two arguments when the window is moved
+within the desktop environment.
+
+@enumerate
+
+@item
+@var{x}: The x coordinate of the top-left corner of the window, in
+pixels.
+
+@item
+@var{y}: The y coordinate of the top-left corner of the window, in
+pixels.
+
+@end enumerate
+
+Desktop environments use the top-left corner as the origin rather than
+the bottom-left like Chickadee does, hence the discrepancy here.
+
+@item
+@var{window-resize}: Called with zero arguments when the window is
+resized.
+
+@enumerate
+
+@item
+@var{width}: The new width in pixels.
+
+@item
+@var{height}: The new height in pixels.
+
+@end enumerate
+
 @item
 @var{error}: Called with two arguments when an error occurs:
 
-- 
cgit v1.2.3