Data.Component.Basic

The package provides the basics for all components in the library.

A component should have the followings (those can be omitted):

• position: {x: int, y: int}
• size: {width: int, height: int}
• color: int[4]
• font: {family: string, bold: bool, italic: bool, size: int}

Documentation

data Config

Basic config type

Constructors

Config

Fields

• size :: V2 Int
• position :: V2 Int
• color :: V4 Word8
• fontDesc :: FontDescriptor
• fontSize :: Int

Instances

FromJSON Config

Defined in Data.Component.Basic

Methods

parseJSON :: Value -> Parser Config

parseJSONList :: Value -> Parser [Config]

loadFontFrom :: Config -> MiniLight Font

Load a system font from Config type.

wrapConfig :: (Config -> a -> Parser r) -> (Object -> Parser a) -> Value -> Parser r

This wrapper function is useful when you write your component config parser.

areaRectangle :: Config -> Rectangle Int

The rectangle region of the component.

data Signal where

Basic signal type.

Constructors

MousePressed

Fields

• :: V2 Int

  The relative position of the mouse pointer

• -> Signal

MouseReleased

Fields

• :: V2 Int

  The relative position of the mouse pointer

• -> Signal

MouseOver

Fields

• :: V2 Int

  The relative position of the mouse pointer

• -> Signal

Instances

EventType Signal

Defined in Data.Component.Basic

wrapSignal

Arguments

:: (HasLightEnv env, HasLoopEnv env, HasComponentEnv env, MonadIO m, ComponentUnit c)

=> (c -> Config)

Config getter

-> (Event -> c -> LightT env m c)

Custom onSignal function

-> Event -> c -> LightT env m c

This wrapper function is useful when you write your own onSignal component.

emitBasicSignal :: (HasLightEnv env, HasLoopEnv env, HasComponentEnv env, MonadIO m) => Event -> Config -> LightT env m ()

Basic signaling function.

contains :: (Ord a, Num a) => Rectangle a -> V2 a -> Bool