Reflex.Vty.Host

Documentation

type VtyApp t m

Arguments

 = MonadVtyApp t m

=> DisplayRegion

The initial display size (updates to this come as events)

-> Event t Event

Vty input events.

-> m (VtyResult t)

The output of the VtyApp. The application runs in a context that, among other things, allows new events to be created and triggered (TriggerEvent), provides access to an event that fires immediately upon app instantiation (PostBuild), and allows actions to be run upon occurrences of events (PerformEvent).

A functional reactive vty application.

data VtyResult t

The output of a VtyApp.

Constructors

VtyResult

Fields

• _vtyResult_picture :: Behavior t Picture

  The current vty output. runVtyAppWithHandle samples this value every time an event fires and updates the display.

• _vtyResult_shutdown :: Event t ()

  An event that requests application termination.

getDefaultVty :: IO Vty

Returns the standard vty configuration with mouse mode enabled.

runVtyApp :: (forall t m. VtyApp t m) -> IO ()

Run a VtyApp with a Vty handle with a standard configuration.

runVtyAppWithHandle

Arguments

:: Vty

A Vty handle.

-> (forall t m. VtyApp t m)

A functional reactive vty application.

-> IO ()

Runs a VtyApp in a given Vty.

type MonadVtyApp t m = (Reflex t, Adjustable t m, MonadCatch m, MonadFix (Performable m), MonadFix m, MonadHold t (Performable m), MonadHold t m, MonadIO (HostFrame t), MonadIO (Performable m), MonadIO m, MonadMask m, MonadRef (HostFrame t), MonadThrow m, NotReady t m, PerformEvent t m, PostBuild t m, PrimMonad (HostFrame t), Ref (HostFrame t) ~ IORef, Ref m ~ IORef, ReflexHost t, TriggerEvent t m)

The constraints necessary to run a VtyApp. See runVtyAppWithHandle for more on why each of these are necessary and how they can be fulfilled.

type VtyEvent = Event

A synonym for the underlying vty event type from Vty. This should probably ultimately be replaced by something defined in this library.