FRP.Spice

This module re-exports the core elements of the library, along with all of the types housed within the library.

Documentation

module Graphics.UI.GLFW

module Data.Map.Strict

loadSpriteAsset :: FilePath -> LoadAssets

Creating a LoadAsset call to load a Sprite.

bindColor :: Color -> Scene

Binding a color to change the current OpenGL color.

color4f :: Float -> Float -> Float -> Float -> Color

Constructing a color from 4 Floats.

color3f :: Float -> Float -> Float -> Color

Constructing a color from 3 Floats, with the alpha channel defaulting to its maximum (of 1.0).

color4i :: Int -> Int -> Int -> Int -> Color

Constructing a color from 4 Ints.

color3i :: Int -> Int -> Int -> Color

Constructing a color from 3 Ints, with the alpha channel defaulting to its maximum (of 255).

black :: Color

The color black.

white :: Color

The color white.

grey :: Color

The color gray.

gray :: Color

A synonym for the color grey.

red :: Color

The color red.

green :: Color

The color green.

blue :: Color

The color blue.

renderPoint :: Vector Float -> Scene

Rendering a position.

renderLine :: Vector Float -> Vector Float -> Scene

Rendering a line.

renderTriangle :: Vector Float -> Vector Float -> Vector Float -> Scene

Rendering a triangle.

renderRectangle :: Vector Float -> Vector Float -> Scene

Rendering a rectangle.

renderSquare :: Vector Float -> Float -> Scene

Rendering a square.

renderPolygon :: [Vector Float] -> Scene

Rendering a polygon of any n sides.

renderSprite :: Sprite -> Vector Float -> Scene

Rendering a Sprite at the position specified.

renderSpriteWithSize :: Sprite -> Vector Float -> Vector Float -> Scene

Rendering a Sprite at the position specified with the size specified.

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

Starting the engine with window parameters described within the provided WindowConfig.

startEngineDefault :: Game a => a -> IO ()

Starting the engine with default window parameter.

data DoListT a b

A data type that can be composed (so long as the data stored is a Monoid) in do-notation.

Constructors

DoListT a b

Instances

Monoid a => Monad (DoListT a)

The Monad instance to allow the DoList to compose through do-notation.

Functor (DoListT a)

A Functor instance to satisfy the Applicative's requirements.

Monoid a => Applicative (DoListT a)

An Applicative instance to satisfy the Monad's requirements in the future.

type DoList a = DoListT a ()

A type synonym for the DoListT that should be used.

data WindowConfig

The config that is used to define the GLFW window's properties.

Constructors

WindowConfig

Fields

getWindowWidth :: Int

getWindowHeight :: Int

getWindowFullscreen :: Bool

getWindowTitle :: String

Instances

Default WindowConfig

The default state for a WindowConfig.

data Color

A data type representing a color as 4 floats (r, g, b, a) representing red, green, blue, and the alpha channel respectively. The floats should range from 0 to 1, representing 0 to 255 in more classical representations.

Constructors

Color

Fields

colorRed :: Float

colorGreen :: Float

colorBlue :: Float

colorAlpha :: Float

data Vector a

A data type that stores two values. It can be used to perform basic vector logic. It should be noted that the Vector logic provided in this library is not linear-algebra style vector logic.

Constructors

Vector a a

Instances

Functor Vector

A functor instance to apply a function onto both values stored in a Vector.

Applicative Vector

An applicative instance to allow one to write functions on Vectors that have separate functions for both values.

Default a => Default (Vector a)

The default state for a Vector.

data Sinks

A wrapper around the sinks for the mouse position, mouse buttons, and keyboard keys.

Constructors

Sinks

Fields

mousePosSink :: Vector Float -> IO ()

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

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

data Input

A data structure that represents the current state of the input. Used in the InputContainer along with the Sink to handle all input -- updating and referencing.

Constructors

Input

Fields

mousePos :: Vector Float

mouseButton :: Map MouseButton Bool

key :: Map Key Bool

data InputContainer

The container for both Sink and Input. The Input is stored within a Signal so it may be used within the FRP/Elerea part of the framework.

Constructors

InputContainer

Fields

getSinks :: Sinks

getInput :: Signal Input

data Sprite

Containing all of the necessary information for rendering an image on screen (aside from the position where the sprite should be rendered.)

Constructors

Sprite

Fields

spriteTex :: TextureObject

spriteSize :: Vector Float

data LoadAsset

Representing the loading of an asset into the game framework.

Constructors

LoadSprite FilePath

type LoadAssets = DoList [LoadAsset]

A DoList synonym for LoadAsset.

data Assets

Storing the loaded assets in a single data structure.

Constructors

Assets

Fields

sprites :: Map FilePath Sprite

Instances

Default Assets

The default state for an Assets.

type Scene = IO ()

A type synonym to imply that functions performed in this function should solely render.

type DeltaTime = Float

A type synonym to make the delta time (in the Game definition) more self documenting.

class Game a where

The requirements for a given data structure to be used as a game within the framework.

Methods

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

render :: Assets -> a -> Scene

loadAssets :: a -> LoadAssets

up :: Num a => Vector a

The cardinal directions.

right :: Num a => Vector a

The cardinal directions.

left :: Num a => Vector a

The cardinal directions.

down :: Num a => Vector a

The cardinal directions.

(^+) :: Num a => Vector a -> Vector a -> Vector a infixl 6

Adding two Vectors.

(^-) :: Num a => Vector a -> Vector a -> Vector a infixl 6

Subtracting a Vector from another Vector.

(^*) :: Num a => Vector a -> Vector a -> Vector a infixl 7

Multiplying two Vectors (not a dot product, but rather multiplying the first value in the first vector by the second value in the second vector, and the same with with the second value.)

(^.) :: Num a => Vector a -> Vector a -> a infixl 7

The dot product of two Vectors.

(^+>) :: Num a => Vector a -> a -> Vector a infixl 6

Adding a Vector and a given number. Effectively the same as calling (^+) on a Vector and a Vector n n.

(^->) :: Num a => Vector a -> a -> Vector a infixl 6

Subtracting a number from a Vector. Effectively the same as calling (^-) on a Vector and a Vector n n.

(^*>) :: Num a => Vector a -> a -> Vector a infixl 7

Multiplying a Vector by a given number. Effecitvely the same as calling (^*) on a Vector and a Vector n n.

(^.>) :: Num a => Vector a -> a -> a infixl 7

The dot product of two Vectors.