FRP.Spice

This module re-exports some other modules in the spice library so that you needn't import all of them explicitly.

Documentation

data WindowConfig

A datatype to configure the window settings when creating an OpenGL context using startEngine in the engine.

Constructors

WindowConfig

Fields

getWindowWidth :: Int

getWindowHeight :: Int

getWindowFullscreen :: Bool

getWindowTitle :: String

Instances

Eq WindowConfig

Read WindowConfig

Show WindowConfig

Default WindowConfig

defaultWindowConfig :: WindowConfig

The default for WindowConfig

getWindowWidth      = 640
getWindowHeight     = 480
getWindowFullscreen = False
getWindowResizeable = False
getWindowTitle      = "Spice Application"

startEngine :: Game a => WindowConfig -> a -> IO ()

Starting the spice engine with the parameters prescribed in the WindowConfig. It updates and renders the Game automatically so all you need to to is set up the WindowConfig and make a datatype with an instance of Game.

data Sinks

A wrapper around the sinks for the mouse position, the key states, and the mouse button states.

Constructors

Sinks

Fields

mousePositionSinks :: Vector Float -> IO ()

keyboardSinks :: Map Key (Bool -> IO ())

mouseSinks :: Map MouseButton (Bool -> IO ())

data Input

A container for all of the states themselves. It is used as a Signal Input in the InputContainer (which is necessary to use it within Elerea's FRP network).

Constructors

Input

Fields

mousePosition :: Vector Float

keyboard :: Map Key Bool

mouse :: Map MouseButton Bool

data InputContainer

A container around Sinks and Signal Input so that one needn't pass around a tuple.

Constructors

InputContainer

Fields

getSinks :: Sinks

getInput :: Signal Input

makeInputContainer :: IO InputContainer

Making an InputContainer filled with all necessary externals.

makeMousePositionCallback :: WindowConfig -> InputContainer -> MousePosCallback

Creating a callback to update the mouse position's state.

makeKeyboardCallback :: InputContainer -> KeyCallback

Creating a callback to update the keyboard's states.

makeMouseCallback :: InputContainer -> MouseButtonCallback

Creating a callback to update the mouse buttons' states.

type DeltaTime = Float

A synonym to make the update function more self-documenting.

class Game a where

The class which is to be used in the startEngine function. update provides the API to update on every tick (purely), an render provides the API to render every frame.

Methods

update :: DeltaTime -> Input -> a -> a

render :: a -> Scene