Game.GoreAndAsh.SDL.Module

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

Documentation

newtype SDLT s m a

Monad transformer of SDL core module.

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 [SDLT, ... 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

SDLT

Fields

• runSDLT :: StateT (SDLState s) m a

Instances

MonadBase IO m => MonadBase IO (SDLT s m)

Methods

liftBase :: IO α -> SDLT s m α

MonadError e m => MonadError e (SDLT s m)

Methods

throwError :: e -> SDLT s m a

catchError :: SDLT s m a -> (e -> SDLT s m a) -> SDLT s m a

MonadTrans (SDLT s)

Methods

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

Monad m => MonadState (SDLState s) (SDLT s m)

Methods

get :: SDLT s m (SDLState s)

put :: SDLState s -> SDLT s m ()

state :: (SDLState s -> (a, SDLState s)) -> SDLT s m a

Monad m => Monad (SDLT s m)

Methods

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

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

return :: a -> SDLT s m a

fail :: String -> SDLT s m a

Functor m => Functor (SDLT s m)

Methods

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

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

MonadFix m => MonadFix (SDLT s m)

Methods

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

Monad m => Applicative (SDLT s m)

Methods

pure :: a -> SDLT s m a

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

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

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

MonadIO m => MonadIO (SDLT s m)

Methods

liftIO :: IO a -> SDLT s m a

MonadThrow m => MonadThrow (SDLT s m)

Methods

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

MonadMask m => MonadMask (SDLT s m)

Methods

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

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

MonadCatch m => MonadCatch (SDLT s m)

Methods

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

MonadResource m => MonadResource (SDLT s m)

Methods

liftResourceT :: ResourceT IO a -> SDLT s m a

(MonadIO m, MonadThrow m) => MonadSDL (SDLT s m)

Methods

sdlCreateWindowM :: WindowName -> Text -> WindowConfig -> RendererConfig -> SDLT s m (Window, Renderer)

sdlGetWindowM :: WindowName -> SDLT s m (Maybe (Window, Renderer))

sdlDestroyWindowM :: WindowName -> SDLT s m ()

sdlSetBackColor :: WindowName -> Maybe (V4 Word8) -> SDLT s m ()

sdlCreateContext :: WindowName -> SDLT s m ()

sdlMakeCurrent :: WindowName -> SDLT s m ()

sdlWindowShownEventsM :: SDLT s m (Seq WindowShownEventData)

sdlWindowHiddenEventsM :: SDLT s m (Seq WindowHiddenEventData)

sdlWindowExposedEventsM :: SDLT s m (Seq WindowExposedEventData)

sdlWindowMovedEventsM :: SDLT s m (Seq WindowMovedEventData)

sdlWindowResizedEventsM :: SDLT s m (Seq WindowResizedEventData)

sdlWindowSizeChangedEventsM :: SDLT s m (Seq WindowSizeChangedEventData)

sdlWindowMinimizedEventsM :: SDLT s m (Seq WindowMinimizedEventData)

sdlWindowMaximizedEventsM :: SDLT s m (Seq WindowMaximizedEventData)

sdlWindowRestoredEventsM :: SDLT s m (Seq WindowRestoredEventData)

sdlWindowGainedMouseFocusEventsM :: SDLT s m (Seq WindowGainedMouseFocusEventData)

sdlWindowLostMouseFocusEventsM :: SDLT s m (Seq WindowLostMouseFocusEventData)

sdlWindowGainedKeyboardFocusEventsM :: SDLT s m (Seq WindowGainedKeyboardFocusEventData)

sdlWindowLostKeyboardFocusEventsM :: SDLT s m (Seq WindowLostKeyboardFocusEventData)

sdlWindowClosedEventsM :: SDLT s m (Seq WindowClosedEventData)

sdlKeyboardEventsM :: SDLT s m (Seq KeyboardEventData)

sdlTextEditingEventsM :: SDLT s m (Seq TextEditingEventData)

sdlTextInputEventsM :: SDLT s m (Seq TextInputEventData)

sdlMouseMotionEventsM :: SDLT s m (Seq MouseMotionEventData)

sdlMouseButtonEventsM :: SDLT s m (Seq MouseButtonEventData)

sdlMouseWheelEventsM :: SDLT s m (Seq MouseWheelEventData)

sdlJoyAxisEventsM :: SDLT s m (Seq JoyAxisEventData)

sdlJoyBallEventsM :: SDLT s m (Seq JoyBallEventData)

sdlJoyHatEventsM :: SDLT s m (Seq JoyHatEventData)

sdlJoyButtonEventsM :: SDLT s m (Seq JoyButtonEventData)

sdlJoyDeviceEventsM :: SDLT s m (Seq JoyDeviceEventData)

sdlControllerAxisEventsM :: SDLT s m (Seq ControllerAxisEventData)

sdlControllerButtonEventsM :: SDLT s m (Seq ControllerButtonEventData)

sdlControllerDeviceEventsM :: SDLT s m (Seq ControllerDeviceEventData)

sdlQuitEventM :: SDLT s m Bool

sdlUserEventsM :: SDLT s m (Seq UserEventData)

sdlSysWMEventsM :: SDLT s m (Seq SysWMEventData)

sdlTouchFingerEventsM :: SDLT s m (Seq TouchFingerEventData)

sdlMultiGestureEventsM :: SDLT s m (Seq MultiGestureEventData)

sdlDollarGestureEventsM :: SDLT s m (Seq DollarGestureEventData)

sdlDropEventsM :: SDLT s m (Seq DropEventData)

sdlClipboardUpdateEventsM :: SDLT s m (Seq ClipboardUpdateEventData)

type ModuleState (SDLT s m)

type ModuleState (SDLT s m) = SDLState s

Orphan instances

GameModule m s => GameModule (SDLT s m) (SDLState s)

Associated Types

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

Methods

runModule :: MonadIO m' => SDLT s m a -> SDLState s -> m' (a, SDLState s)

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

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

cleanupModule :: SDLState s -> IO ()