diff options
Diffstat (limited to 'doc/api.texi')
| -rw-r--r-- | doc/api.texi | 27 |
1 files changed, 13 insertions, 14 deletions
diff --git a/doc/api.texi b/doc/api.texi index df68889..8254b13 100644 --- a/doc/api.texi +++ b/doc/api.texi @@ -8,16 +8,16 @@ @node Kernel @section Kernel -At the very core of Chickadee, in the @code{(chickadee)} module, lies -an event loop. This loop, or ``kernel'', is responsible for ensuring -that the game is updated at the desired interval, rendering the -current state of the game world, and handling errors if they occur. -The kernel implements what is known as a ``fixed timestep'' game loop, -meaning that the game simulation will be advanced by a fixed interval -of time and will never vary from frame to frame, unlike some other -styles of game loops. The appropriately named @code{run-game} and -@code{abort-game} procedures are the entry and exit points to the -Chickadee game loop kernel. +At the very core of Chickadee, in the @code{(chickadee game-loop)} +module, lies an event loop. This loop, or ``kernel'', is responsible +for ensuring that the game is updated at the desired interval, +rendering the current state of the game world, and handling errors if +they occur. The kernel implements what is known as a ``fixed +timestep'' game loop, meaning that the game simulation will be +advanced by a fixed interval of time and will never vary from frame to +frame, unlike some other styles of game loops. The appropriately +named @code{run-game*} and @code{abort-game} procedures are the entry +and exit points to the Chickadee game loop kernel. On its own, the kernel does not do very much at all. In order to actually respond to input events, update game state, or render output, @@ -79,10 +79,9 @@ Stop the currently running Chickadee game loop. Since most users will want to write 2D/3D games with hardware accelerated graphics rendering, controlled via keyboard, mouse, or game controller, Chickadee comes with an easy to use engine just for -this purpose in the @code{(chickadee sdl)} module: -@code{run-game/sdl}. +this purpose in the @code{(chickadee)} module: @code{run-game}. -@deffn {Procedure} run-game/sdl [#:window-title "Chickadee!"] @ +@deffn {Procedure} run-game [#:window-title "Chickadee!"] @ [#:window-width 640] [#:window-height 480] @ [#:window-fullscreen? @code{#f}] [#:update-hz 60] @ [#:load] [#:update] [#:draw] [#:quit] @ @@ -91,7 +90,7 @@ this purpose in the @code{(chickadee sdl)} module: [#:controller-add] [#:controller-remove] [#:controller-press] @ [#:controller-release] [#:controller-move] [#:error] -Run the Chickadee game loop using the SDL engine. +Run the Chickadee game loop using the SDL engine in OpenGL mode. A new graphical window will be opened with @var{window-width} x @var{window-height} as its dimensions, @var{window-title} as its |