Game.GoreAndAsh.GLFW.Module

The module contains declaration of monad transformer of the core module and instance for GameModule class.

Documentation

newtype GLFWT s m a

Monad transformer that handles GLFW specific API

s

- State of next core module in modules chain;

m

- Next monad in modules monad stack;

a

- Type of result value;

How to embed module:

type AppStack = ModuleStack [GLFWT, ... other modules ... ] IO

newtype AppMonad a = AppMonad (AppStack a)
  deriving (Functor, Applicative, Monad, MonadFix, MonadIO, MonadThrow, MonadCatch, MonadSDL)

The module is NOT pure within first phase (see ModuleStack docs), therefore currently only IO end monad can handler the module.

Constructors

GLFWT

Fields

• runGLFWT :: StateT (GLFWState s) m a

Instances

MonadTrans (GLFWT s)

Methods

lift :: Monad m => m a -> GLFWT s m a

Monad m => MonadState (GLFWState s) (GLFWT s m)

Methods

get :: GLFWT s m (GLFWState s)

put :: GLFWState s -> GLFWT s m ()

state :: (GLFWState s -> (a, GLFWState s)) -> GLFWT s m a

Monad m => Monad (GLFWT s m)

Methods

(>>=) :: GLFWT s m a -> (a -> GLFWT s m b) -> GLFWT s m b

(>>) :: GLFWT s m a -> GLFWT s m b -> GLFWT s m b

return :: a -> GLFWT s m a

fail :: String -> GLFWT s m a

Functor m => Functor (GLFWT s m)

Methods

fmap :: (a -> b) -> GLFWT s m a -> GLFWT s m b

(<$) :: a -> GLFWT s m b -> GLFWT s m a

MonadFix m => MonadFix (GLFWT s m)

Methods

mfix :: (a -> GLFWT s m a) -> GLFWT s m a

Monad m => Applicative (GLFWT s m)

Methods

pure :: a -> GLFWT s m a

(<*>) :: GLFWT s m (a -> b) -> GLFWT s m a -> GLFWT s m b

(*>) :: GLFWT s m a -> GLFWT s m b -> GLFWT s m b

(<*) :: GLFWT s m a -> GLFWT s m b -> GLFWT s m a

MonadIO m => MonadIO (GLFWT s m)

Methods

liftIO :: IO a -> GLFWT s m a

MonadThrow m => MonadThrow (GLFWT s m)

Methods

throwM :: Exception e => e -> GLFWT s m a

MonadMask m => MonadMask (GLFWT s m)

Methods

mask :: ((forall a. GLFWT s m a -> GLFWT s m a) -> GLFWT s m b) -> GLFWT s m b

uninterruptibleMask :: ((forall a. GLFWT s m a -> GLFWT s m a) -> GLFWT s m b) -> GLFWT s m b

MonadCatch m => MonadCatch (GLFWT s m)

Methods

catch :: Exception e => GLFWT s m a -> (e -> GLFWT s m a) -> GLFWT s m a

Monad m => MonadGLFW (GLFWT s m)

Methods

keyStatusM :: Key -> GLFWT s m (Maybe (KeyState, ModifierKeys))

mouseButtonM :: MouseButton -> GLFWT s m (Maybe (MouseButtonState, ModifierKeys))

mousePosM :: GLFWT s m (Double, Double)

mouseScrollM :: GLFWT s m [(Double, Double)]

windowSizeM :: GLFWT s m (Maybe (Double, Double))

windowClosingM :: GLFWT s m Bool

setCurrentWindowM :: Maybe Window -> GLFWT s m ()

getCurrentWindowM :: GLFWT s m (Maybe Window)

setBufferSizeM :: Int -> GLFWT s m ()

type ModuleState (GLFWT s m)

type ModuleState (GLFWT s m) = GLFWState s

Orphan instances

GameModule m s => GameModule (GLFWT s m) (GLFWState s)

Associated Types

type ModuleState (GLFWT s m :: * -> *) :: *

Methods

runModule :: MonadIO m' => GLFWT s m a -> GLFWState s -> m' (a, GLFWState s)

newModuleState :: MonadIO m' => m' (GLFWState s)

withModule :: Proxy (* -> *) (GLFWT s m) -> IO a -> IO a

cleanupModule :: GLFWState s -> IO ()