Game.LambdaHack.Client.UI.Frontend.Sdl

Text frontend based on SDL2.

Documentation

startup :: ClientOptions -> IO RawFrontend

Set up and start the main loop providing input and output.

Apparently some SDL backends are not thread-safe (https://wiki.libsdl.org/FAQDevelopment; "this should only be run in the thread that initialized the video subsystem, and for extra safety, you should consider only doing those things on the main thread in any case") so we stick to a single bound thread (but not to the main thread; enough is enough and at least in the case of OpenGL all bound threads are supposed to be as good as the main thread).

frontendName :: String

The name of the frontend.

Internal operations

type FontAtlas = EnumMap AttrCharW32 Texture

data FrontendSession

Session data maintained by the frontend.

Constructors

FrontendSession

Fields

• swindow :: Window
• srenderer :: Renderer
• sfont :: Font
• satlas :: IORef FontAtlas
• stexture :: IORef Texture
• spreviousFrame :: IORef SingleFrame
• sforcedShutdown :: IORef Bool
• scontinueSdlLoop :: IORef Bool
• sframeQueue :: MVar SingleFrame
• sframeDrawn :: MVar ()

startupFun :: ClientOptions -> MVar RawFrontend -> IO ()

shutdown :: FrontendSession -> IO ()

forceShutdown :: FrontendSession -> IO ()

display

Arguments

:: FrontendSession

frontend session data

-> SingleFrame

the screen frame to draw

-> IO ()

Add a frame to be drawn.

drawFrame

Arguments

:: ClientOptions

-> FrontendSession

frontend session data

-> SingleFrame

the screen frame to draw

-> IO ()

printScreen :: FrontendSession -> IO ()

modTranslate :: KeyModifier -> Modifier

Translates modifiers to our own encoding, ignoring Shift.

keyTranslate :: Bool -> Keycode -> Key

colorToRGBA :: Color -> V4 Word8