YampaSDL2

MainLoop

mainLoop :: Backend a AppOutput -> SF AppInput AppOutput -> IO ()

Starts the Yampa loop

Backend

data Backend a b

Constructors

Backend

Fields

• initAction :: IO a
• inputAction :: Bool -> IO (DTime, Maybe a)
• outputAction :: Bool -> b -> IO Bool
• parseInput :: SF a AppInput
• closeAction :: IO ()

data BackendConfiguration

Constructors

BackendConfiguration

Fields

• windowWidth :: Int
• windowHeight :: Int
• windowName :: String
• windowResizable :: Bool
• fps :: Double

defaultBackendConfiguration :: BackendConfiguration

sdlBackend :: BackendConfiguration -> IO (Backend (Event EventPayload) AppOutput)

Set up SDL

Input

data AppInput

Your main SF receives AppInput as input

Constructors

AppInput

Fields

• inpQuit :: Bool
• inpKey :: Maybe Scancode
• inpMousePos :: V2 Double
• inpMouseLeft :: Maybe (V2 Double)
• inpMouseRight :: Maybe (V2 Double)

Instances

Show AppInput

Methods

showsPrec :: Int -> AppInput -> ShowS

show :: AppInput -> String

showList :: [AppInput] -> ShowS

initAppInput :: AppInput

SFs

quit :: SF AppInput (Event ())

anyKeyActive :: SF AppInput (Event Scancode)

anyKeyPress :: SF AppInput (Event Scancode)

mouseLeftActive :: SF AppInput (Event (V2 Double))

mouseLeftPress :: SF AppInput (Event (V2 Double))

mouseRightActive :: SF AppInput (Event (V2 Double))

mouseRightPress :: SF AppInput (Event (V2 Double))

mousePosition :: SF AppInput (V2 Double)

Output

data AppOutput

Your main SF needs to create an AppOutput

Constructors

AppOutput

Fields

• graphics :: Graphics
• sound :: [Sound]
• shouldExit :: Bool

data Graphics

Constructors

Graphics

Fields

• camera :: Camera
• objects :: [RenderShape]

Instances

Show Graphics

Methods

showsPrec :: Int -> Graphics -> ShowS

show :: Graphics -> String

showList :: [Graphics] -> ShowS

data Camera

Constructors

Camera

Fields

• cPos :: V2 Double

  Moves the viewpoint

• cSize :: V2 Double

  Set the size of the viewpoint, for example to zoom.

Instances

Show Camera

Methods

showsPrec :: Int -> Camera -> ShowS

show :: Camera -> String

showList :: [Camera] -> ShowS

data RenderShape

Constructors

RS

Fields

• shapeCentre :: V2 Double
• shape :: Shape
• zIndex :: Int

  Higher zIndex means the RenderShape is in front of the others

Instances

Eq RenderShape

Methods

(==) :: RenderShape -> RenderShape -> Bool

(/=) :: RenderShape -> RenderShape -> Bool

Show RenderShape

Methods

showsPrec :: Int -> RenderShape -> ShowS

show :: RenderShape -> String

showList :: [RenderShape] -> ShowS

data Sound

Constructors

NotImplementedYet

container :: V2 Double -> [RenderShape] -> [RenderShape]

Shapes

data Shape

Constructors

Rectangle

Fields

• rectSize :: V2 Double
• colour :: ShapeColour

Circle

Fields

• radius :: Double
• colour :: ShapeColour

Triangle

Think of shapeCentre as a vector which is applied to all 3 points of the triangle

Fields

• pointA :: V2 Double
• pointB :: V2 Double
• pointC :: V2 Double
• colour :: ShapeColour

Image

Fields

• size :: V2 Double
• sourceRect :: Maybe (V2 Double, V2 Double)

  the section of the image that you want to render

• imgPath :: String

Instances

Eq Shape

Methods

(==) :: Shape -> Shape -> Bool

(/=) :: Shape -> Shape -> Bool

Show Shape

Methods

showsPrec :: Int -> Shape -> ShowS

show :: Shape -> String

showList :: [Shape] -> ShowS

data ShapeColour

Constructors

Filled (Colour Double)

Unfilled (Colour Double)

Instances

Eq ShapeColour

Methods

(==) :: ShapeColour -> ShapeColour -> Bool

(/=) :: ShapeColour -> ShapeColour -> Bool

Show ShapeColour

Methods

showsPrec :: Int -> ShapeColour -> ShowS

show :: ShapeColour -> String

showList :: [ShapeColour] -> ShowS

Animation

animate :: Animation -> SF a (Maybe RenderShape)

data Animation

Constructors

Animation

Fields

• frames :: [(Time, RenderShape)]

  Time specifies how long the RenderShape is displayed, for example [(0.5, renderShape1), (0.5, renderShape2)]

• type_ :: AnimationType

data AnimationType

Constructors

Once

Endless

Repeat Int

Alternate

AlternateEndless

newAnimation :: [(Time, RenderShape)] -> AnimationType -> Animation

module Data.Colour.Names

module Data.Colour.SRGB

module Linear.V2

module SDL.Input.Keyboard.Codes