MiniLight

MiniLight module exports all basic concepts and oprations except for concrete components.

Documentation

module MiniLight.Light

module MiniLight.Event

module MiniLight.Figure

module MiniLight.Component

module MiniLight.Loader

runLightT :: (MonadIO m, MonadMask m) => LightT LightEnv m a -> m a

Run a light monad with default configuration. runLightT = runLightTWith defLightConfig

runLightTWith :: (MonadIO m, MonadMask m) => LightConfig -> LightT LightEnv m a -> m a

Run a Light monad.

data LightConfig

Custom configuration for LightT

Constructors

LightConfig

Fields

• headless :: Bool
• logQueue :: LogLevel -> IO LogQueue

  LogQueue for logger

• logLevel :: LogLevel

  LogLevel for logger

defLightConfig :: LightConfig

Default configuration for runLightT

data LoopState

The state in the mainloop.

Constructors

LoopState

Fields

• light :: LightEnv
• loop :: LoopEnv
• loader :: LoaderEnv

Instances

HasLightEnv LoopState

Defined in MiniLight

Methods

lightEnv :: Lens' LoopState LightEnv

_fontCache :: Lens' LoopState FontMap

_logger :: Lens' LoopState LogQueue

_renderer :: Lens' LoopState (Maybe Renderer)

HasLoopEnv LoopState

Defined in MiniLight

Methods

loopEnv :: Lens' LoopState LoopEnv

_events :: Lens' LoopState (MVar [Event])

_keyStates :: Lens' LoopState (HashMap Scancode Int)

_signalQueue :: Lens' LoopState (IORef [Event])

HasLoaderEnv LoopState

Defined in MiniLight

Methods

loaderEnv :: Lens' LoopState LoaderEnv

_appConfig :: Lens' LoopState (IORef AppConfig)

_registry :: Lens' LoopState (Registry Component)

_tagRegistry :: Lens' LoopState (IORef (HashMap Text Text))

data LoopConfig

Use defConfig for a default setting.

Constructors

LoopConfig

Fields

• watchKeys :: Maybe [Scancode]

  Set Nothing if all keys should be watched. See also LoopState.

• appConfigFile :: Maybe FilePath

  Specify a yaml file which describes component settings. See Loader for the yaml syntax.

• hotConfigReplacement :: Maybe FilePath

  The directory path to be watched. If set, the config file modification will replace the component dynamically.

• componentResolver :: Resolver

  Your custom mappings between a component name and its type.

• additionalComponents :: [Component]

  The components here would be added during the initialization.

defConfig :: LoopConfig

Default configurations for the mainloop. You need to set componentResolver if you use a component.

runMainloop

Arguments

:: (HasLightEnv env, HasLightEnv env', HasLoopEnv env', HasLoaderEnv env', MonadIO m, MonadMask m)

=> (env -> LoopEnv -> LoaderEnv -> env')

Environment conversion

-> LoopConfig

Loop config

-> s

Initial state

-> (s -> LightT env' m s)

A function called in every loop

-> LightT env m ()

Run a mainloop. In a mainloop, components and events are managed.

Components in a mainloop: draw ~ update ~ (user-defined function) ~ event handling

type MiniLoop = LightT LoopState IO

Type synonym to the minimal type of the mainloop

runMiniloop :: LoopConfig -> s -> (s -> MiniLoop s) -> MiniLight ()

Same as runMainloop but fixing the type.

runComponentEnv :: (HasLightEnv env, HasLoopEnv env) => Component -> (forall env'. (HasComponentEnv env', HasLoopEnv env', HasLightEnv env') => LightT env' m ()) -> LightT env m ()

Run an action over a component.

(@@!) :: (EventType et, HasLoaderEnv env, HasLoopEnv env, HasLightEnv env, MonadIO m) => Text -> et -> LightT env m ()

Emit a signal with a loader-defined target name (!) :: EventType et => T.Text -> et -> MiniLoop ()

quit :: (MonadIO m, HasLoopEnv env) => LightT env m ()

Quit the mainloop and terminate the application.

Orphan instances

Hashable Scancode

Methods

hashWithSalt :: Int -> Scancode -> Int

hash :: Scancode -> Int