| Safe Haskell | Safe-Infered |
|---|
Game.LambdaHack.Display
Description
Display game data on the screen using one of the available frontends (determined at compile time with cabal flags).
- data FrontendSession
- startup :: String -> (FrontendSession -> IO ()) -> IO ()
- shutdown :: FrontendSession -> IO ()
- frontendName :: String
- nextEvent :: FrontendSession -> Maybe Bool -> IO (Key, Modifier)
- promptGetKey :: FrontendSession -> [(Key, Modifier)] -> SingleFrame -> IO (Key, Modifier)
- displayFrame :: FrontendSession -> Bool -> Maybe SingleFrame -> IO ()
Re-exported frontend
data FrontendSession Source
Session data maintained by the frontend.
startup :: String -> (FrontendSession -> IO ()) -> IO ()Source
Spawns the gtk input and output thread, which spawns all the other
required threads. We create a separate thread for gtk to minimize
communication with the heavy main thread. The other threads have to be
spawned after gtk is initialized, because they call postGUIAsync,
and need sview and stags.
shutdown :: FrontendSession -> IO ()Source
Shuts down the frontend cleanly.
The name of the frontend.
nextEvent :: FrontendSession -> Maybe Bool -> IO (Key, Modifier)Source
Input key via the frontend. Fail if there is no frame to show to the player as a prompt for the keypress.
promptGetKey :: FrontendSession -> [(Key, Modifier)] -> SingleFrame -> IO (Key, Modifier)Source
Display a prompt, wait for any of the specified keys (for any key, if the list is empty). Repeat if an unexpected key received. Starts in Push or None mode, stop in None mode. Spends most time waiting for a key, so not performance critical, so does not need optimization.
Derived operations
displayFrame :: FrontendSession -> Bool -> Maybe SingleFrame -> IO ()Source
Push a frame or a single frame's worth of delay to the frame queue.