diff options
| author | David Thompson <dthompson2@worcester.edu> | 2022-10-25 20:25:20 -0400 |
|---|---|---|
| committer | David Thompson <dthompson2@worcester.edu> | 2022-10-25 20:25:44 -0400 |
| commit | d64b09771a3987ede912ce62626cb478feb8bd4a (patch) | |
| tree | 06d42b30ef4f5ca78e53a986024df0db38359287 /doc | |
| parent | a7ce7f386de7aff4ebe426004224d3e2c5c5d169 (diff) | |
Allow for changing the default clear color in run-game procedure.
Add a matching flag for 'chickadee play', too.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/api.texi | 4 | ||||
| -rw-r--r-- | doc/chickadee.texi | 7 |
2 files changed, 10 insertions, 1 deletions
diff --git a/doc/api.texi b/doc/api.texi index 9d743b4..92d18dc 100644 --- a/doc/api.texi +++ b/doc/api.texi @@ -41,6 +41,7 @@ calling @code{run-game} is already taken care of for you. [#:window-fullscreen? @code{#f}] @ [#:window-resizable? @code{#f}] @ [#:update-hz 60] @ + [#:clear-color] @ [#:load] [#:update] [#:draw] [#:quit] @ [#:key-press] [#:key-release] [#:text-input] @ [#:mouse-press] [#:mouse-release] [#:mouse-move] @ @@ -53,7 +54,8 @@ A new graphical window will be opened with @var{window-width} x @var{window-height} as its dimensions, @var{window-title} as its title, and in fullscreen mode if @var{window-fullscreen?} is @code{#t}. If @var{window-resizable?} is @code{#t} then the window -can be resized by the user. +can be resized by the user. The screen color will be set to +@var{clear-color}, or a pleasant light blue, by default. @itemize @item diff --git a/doc/chickadee.texi b/doc/chickadee.texi index c6b2f07..a87a346 100644 --- a/doc/chickadee.texi +++ b/doc/chickadee.texi @@ -261,6 +261,13 @@ Make window resizable. Update the game @var{n} times per second. +@item --clear-color=@var{color} +@itemx -c @var{color} + +Set the screen clear color to @var{color}, a hex code in the format +@code{#RRGGBB}. For example, to set the clear color to black, pass +@code{--clear-color=#000000}. + @item --repl Launch a REPL in the terminal. This will allow the game environment |