Graphics.FreeGame.Simple

The essentials of using free-game

Basic type

type Game = Free GameAction

Game is a Monad that abstracts user interfaces.

data GameAction a

A base for Game monad.

Instances

Functor GameAction

MonadIO Game

Run the game

data GameParam

Parameters of the application.

Constructors

GameParam

Fields

framePerSecond :: Int

windowSize :: (Int, Int)

windowTitle :: String

windowed :: Bool

cursorVisible :: Bool

clearColor :: Color

windowOrigin :: Vec2

Instances

Show GameParam

defaultGameParam :: GameParam

640*480(windowed), 60fps

runSimple

Arguments

:: GameParam

-> world

An initial world

-> (world -> Game world)

A computation yielding new world

-> IO ()

Run a Game by the given initial state and updating function.

runSimple'

Arguments

:: GameParam

-> world

An initial world

-> (world -> forall m. MonadFree GameAction m => m world)

A computation yielding new world

-> IO ()

In most cases there's no unwrapping (Game a -> GameAction (Game a)). | The use of (>>=) is more efficient than runGame in such situation.

In the Game monad

drawPicture :: MonadFree GameAction m => Picture -> m ()

Draw a Picture.

getButtonState :: MonadFree GameAction m => Button -> m Bool

Is the specified Button is pressed?

getMousePosition :: MonadFree GameAction m => m Vec2

getMouseWheel :: MonadFree GameAction m => m Int

embedIO :: MonadFree GameAction m => IO a -> m a

Embed arbitrary IO actions into a Game monad.

quitGame :: MonadFree GameAction m => m Void

Break the current computation.

tick :: MonadFree GameAction m => m ()

Finalize the current frame and refresh the screen.

untick :: MonadFree GameAction m => Free GameAction a -> m (Either (Free GameAction a) a)

Run a Game as one frame.

untickInfinite :: MonadFree GameAction m => Free GameAction Void -> m (Free GameAction Void)

An infinite version of untick.

untickGame :: MonadFree GameAction m => Free GameAction a -> m (Free GameAction a)

Deprecated: use untick or untickInfinite instead

About Picture

data Picture

A 2D Picture.

Constructors

Bitmap Bitmap

A Bitmap as a Picture.

BitmapPicture Bitmap

Deprecated: use Bitmap instead

Deprecated synonym for Bitmap.

Pictures [Picture]

A picture consist of some Pictures.

PictureWithFinalizer (FinalizerT IO Picture)

A picture that may have side effects(internal use only).

Rotate Float Picture

Rotated picture by the given angle (in degrees, counterclockwise).

Scale Vec2 Picture

Scaled picture.

Translate Vec2 Picture

A picture translated by the given coordinate.

Colored Color Picture

Colored picture.

data Bitmap

Concrete bitmap data

loadBitmapFromFile :: FilePath -> IO Bitmap

Create a Bitmap from the given file.

loadBitmaps :: FilePath -> Q [Dec]

use with getDataFileName

loadBitmapsWith :: Name -> FilePath -> Q [Dec]

Load and define all pictures in the specified directory.

data Vec2

Constructors

Vec2 !Float !Float

Instances

Read Vec2

Show Vec2

Storable Vec2

Random Vec2

AbelianGroup Vec2

Vector Vec2

DotProd Vec2

Pointwise Vec2

Dimension Vec2

LeftModule Mat2 Vec2

RightModule Vec2 Mat2

UnitVector Vec2 Normal2

HasCoordinates Vec2 Float

HasCoordinates Mat2 Vec2

Extend Vec2 Vec3

Extend Vec2 Vec4

Diagonal Vec2 Mat2

Tensor Mat2 Vec2

Projective Vec2 Mat2 Ortho2 Mat3 Proj3

Determinant (Vec2, Vec2)

Drawing texts

data Font

Font object

loadFont :: FilePath -> IO Font

Create a Font from the given file.

text :: Font -> Float -> String -> Picture

Render a text by the specified Font.

Utilities

randomness :: (Random r, MonadFree GameAction m) => (r, r) -> m r

Get a given range of value.

degrees :: Float -> Float

Convert radians to degrees.

Deprecated

askInput :: MonadFree GameAction m => Button -> m Bool

Deprecated: use getButtonState instead.

Deprecated synonym for getButtonState.

getMouseState :: MonadFree GameAction m => m MouseState

Deprecated: use getMousePosition and getMouseWheel instead.

Yields the mouse's state.

Reexports

module Graphics.FreeGame.Input

module Graphics.FreeGame.Data.Color