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

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

Run a Light monad.

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 Component for the yaml syntax.

• componentResolver :: Text -> Value -> MiniLight Component

  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.

data LoopEnv env

LoopEnv value would be passed to user side in a mainloop.

Constructors

LoopState

Fields

• env :: env
• keyStates :: HashMap Scancode Int
• events :: IORef [Event]
• signalQueue :: IORef [Event]
• components :: IOVector Component

Instances

HasLoopEnv (LoopEnv env)

Defined in MiniLight

Methods

keyStatesL :: Lens' (LoopEnv env) (HashMap Scancode Int)

eventsL :: Lens' (LoopEnv env) (IORef [Event])

signalQueueL :: Lens' (LoopEnv env) (IORef [Event])

HasLightEnv env => HasLightEnv (LoopEnv env)

Defined in MiniLight

Methods

rendererL :: Lens' (LoopEnv env) Renderer

fontCacheL :: Lens' (LoopEnv env) FontMap

type MiniLoop = LightT (LoopEnv LightEnv) IO

Type synonym to the minimal type of the mainloop

runMainloop

Arguments

:: (HasLightEnv env, HasLightEnv loop, HasLoopEnv loop, MonadIO m, MonadMask m)

=> (LoopEnv env -> loop)

LoopState conversion function (you can pass id, fixing loop as LoopState LightEnv)

-> LoopConfig

loop config

-> s

initial state

-> (s -> LightT loop 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

Orphan instances

Hashable Scancode

Methods

hashWithSalt :: Int -> Scancode -> Int

hash :: Scancode -> Int

HasLoopEnv env => HasLoopEnv (Text, env)

Methods

keyStatesL :: Lens' (Text, env) (HashMap Scancode Int)

eventsL :: Lens' (Text, env) (IORef [Event])

signalQueueL :: Lens' (Text, env) (IORef [Event])

HasLightEnv env => HasLightEnv (Text, env)

Methods

rendererL :: Lens' (Text, env) Renderer

fontCacheL :: Lens' (Text, env) FontMap

HasComponentEnv (Text, env)

Methods

uidL :: Lens' (Text, env) Text