extra/game/loop/loop-docs.factor

   1 ! (c)2009 Joe Groff bsd license
   2 USING: help.markup help.syntax kernel math ui.gadgets.worlds ;
   3 IN: game.loop
   4
   5 HELP: fps
   6 { $values { "fps" real } { "nanos" integer } }
   7 { $description "Converts a frames per second value into an interval length in nanoseconds." } ;
   8
   9 HELP: <game-loop>
  10 { $values
  11     { "tick-interval-nanos" integer } { "delegate" "a " { $link "game.loop-delegates" } }
  12     { "loop" game-loop }
  13 }
  14 { $description "Constructs a new stopped " { $link game-loop } " object. When started, the game loop will call the " { $link tick* } " method on the " { $snippet "delegate" } " every " { $snippet "tick-interval-nanos" } " nanoseconds, and " { $link draw* } " on the same delegate object as frequently as possible. The " { $link start-loop } " and " { $link stop-loop } " words start and stop the game loop."
  15 $nl
  16 "To initialize the game loop with separate tick and draw delegates, use " { $link <game-loop*> } "." } ;
  17
  18 HELP: <game-loop*>
  19 { $values
  20     { "tick-interval-nanos" integer } { "tick-delegate" "a " { $link "game.loop-delegates" } } { "draw-delegate" "a " { $link "game.loop-delegates" } }
  21     { "loop" game-loop }
  22 }
  23 { $description "Constructs a new stopped " { $link game-loop } " object. When started, the game loop will call the " { $link tick* } " method on the " { $snippet "tick-delegate" } " every " { $snippet "tick-interval-nanos" } " nanoseconds, and " { $link draw* } " on the " { $snippet "draw-delegate" } " as frequently as possible. The " { $link start-loop } " and " { $link stop-loop } " words start and stop the game loop."
  24 $nl
  25 "The " { $link <game-loop> } " word provides a shorthand for initializing a game loop that uses the same object for the " { $snippet "tick-delegate" } " and " { $snippet "draw-delegate" } "." } ;
  26
  27 { <game-loop> <game-loop*> } related-words
  28
  29 HELP: draw*
  30 { $values
  31     { "tick-slice" float } { "delegate" "a " { $link "game.loop-delegates" } }
  32 }
  33 { $description "This generic word is called by a " { $link game-loop } " on its " { $snippet "draw-delegate" } " object in a tight loop while the game loop is running. The " { $snippet "tick-slice" } " value represents what fraction of the game loop's " { $snippet "tick-interval-nanos" } " time period has passed since " { $link tick* } " was most recently called on the " { $snippet "tick-delegate" } "." } ;
  34
  35 HELP: game-loop
  36 { $class-description "Objects of the " { $snippet "game-loop" } " class manage game loops. See " { $link "game.loop" } " for an overview of the game loop library. To construct a game loop, use " { $link <game-loop> } ". To start and stop a game loop, use the " { $link start-loop } " and " { $link stop-loop } " words."
  37 $nl
  38 "The " { $snippet "tick-delegate" } " and " { $snippet "draw-delegate" } " slots of a game loop object determine where the loop sends its " { $link tick* } " and " { $link draw* } " events. These slots can be changed while the game loop is running." } ;
  39
  40 HELP: game-loop-error
  41 { $values
  42     { "error" "an error object" } { "game-loop" game-loop }
  43 }
  44 { $description "If an uncaught error is thrown from inside a game loop delegate's " { $link tick* } " or " { $link draw* } ", the game loop will catch the error, stop the game loop, and rethrow an error of this class." } ;
  45
  46 HELP: start-loop
  47 { $values
  48     { "loop" game-loop }
  49 }
  50 { $description "Starts running a " { $link game-loop } "." } ;
  51
  52 HELP: stop-loop
  53 { $values
  54     { "loop" game-loop }
  55 }
  56 { $description "Stops running a " { $link game-loop } "." } ;
  57
  58 { start-loop stop-loop } related-words
  59
  60 HELP: tick*
  61 { $values
  62     { "delegate" "a " { $link "game.loop-delegates" } }
  63 }
  64 { $description "This generic word is called by a " { $link game-loop } " on its " { $snippet "tick-delegate" } " object at regular intervals while the game loop is running. The game loop's " { $snippet "tick-interval-nanos" } " attribute determines the number of nanoseconds between invocations of " { $snippet "tick*" } "." } ;
  65
  66 { draw* tick* } related-words
  67
  68 ARTICLE: "game.loop-delegates" "Game loop delegate"
  69 "A " { $link game-loop } " object requires a " { $snippet "tick-delegate" } " and " { $snippet "draw-delegate" } " that together implement the logic that controls the game. Both delegates can also be the same object. A game loop delegate can be any object that provides two methods for the following generic words:"
  70 { $subsections
  71     tick*
  72     draw*
  73 }
  74 { $snippet "tick*" } " will be called at a regular interval determined by the game loop's " { $snippet "tick-interval-nanos" } " attribute on the tick delegate. " { $snippet "draw*" } " will be invoked on the draw delegate in a tight loop, updating as frequently as possible."
  75 $nl
  76 "It is possible to change the " { $snippet "tick-delegate" } " and " { $snippet "draw-delegate" } " slots of a game loop while it is running, for example, to use different delegates to control a game while it's in the menu, paused, or running the main game." ;
  77
  78 ARTICLE: "game.loop" "Game loops"
  79 "The " { $vocab-link "game.loop" } " vocabulary contains the implementation of a game loop. The game loop supports decoupled rendering and game logic timers; given a \"tick delegate\" object with a method on the " { $link tick* } " generic and a \"draw delegate\" with a " { $link draw* } " method, the game loop will invoke the " { $snippet "tick*" } " method on the former at regular intervals while invoking the " { $snippet "draw*" } " method on the latter as frequently as possible. Game loop objects must first be constructed:"
  80 { $subsections
  81     "game.loop-delegates"
  82     <game-loop>
  83     <game-loop*>
  84 }
  85 "Once constructed, the game loop can be started and stopped:"
  86 { $subsections
  87     start-loop
  88     stop-loop
  89 }
  90 "The game loop catches errors that occur in the delegate's methods during the course of the game loop:"
  91 { $subsections
  92     game-loop-error
  93 }
  94 "The " { $vocab-link "game.worlds" } " vocabulary provides a convenient " { $link world } " subclass that integrates the game loop implementation with UI applications, managing the starting and stopping of the loop for you." ;
  95
  96 ABOUT: "game.loop"