This package provides Haskell bindings for the SDL2 library.

SDL (Simple DirectMedia Layer) is a library for cross-platform development of interactive applications. SDL provides routines for managing windows, rendering graphics, processing sound, collecting input data, and much more.

The Haskell sdl2 library provides both a high- and low-level API to interface with SDL.

You may also want to check out:

• sdl2-image - For handling different image formats such as jpg and png.
• sdl2-mixer - For playing audio.
• sdl2-gfx - For drawing graphics primitives such as circles and polygons.
• sdl2-ttf - For handling true type fonts.

If you don't have SDL 2.0.6 or higher on your system via your package manager, you can install it from the official SDL site.

On Ubuntu you can install from source with a simple

./configure && make -j4 && sudo make install

On OSX you can install SDL with homebrew. pkg-config is also recommended.

brew install sdl2 pkg-config

On Windows you can install SDL with pacman under MSYS2 (or use stack's embedded MSYS2).

pacman -S mingw-w64-x86_64-pkg-config mingw-w64-x86_64-SDL2

Note: If you want to use console output, you should add this in your cabal configuration:

executable your-app
  if os(windows)
    ghc-options: -optl-mconsole

If you are getting build errors like ‘SDL_Vertex’ undeclared then your installed libsdl2 version is missing some recent additions.

You have two options to mitigate this:

1. Flip a package flag named recent-ish in your project configuration file.

• cabal.project.local:

  package sdl2
    flags: -recent-ish

• stack.yaml:

  flags:
    sdl2:
      recent-ish: false

2. Build SDL2 from source and use extra-include-dirs / extra-lib-dirs options, while disabling the pkgconfig-provided dependency:

• cabal.project.local:

  extra-include-dirs: /path/to/sdl2/include
  extra-lib-dirs: /path/to/sdl2/lib
  package sdl2
    flags: -pkgconfig

• stack.yaml:

  extra-include-dirs:
  - /path/to/sdl2/include
  extra-lib-dirs:
  - /path/to/sdl2/lib
  flags:
    sdl2:
      pkgconfig: false

The flag enables some features from SDL2 past 2.0.8 and assumes a host system has at least version 2.0.20 installed. If you have libsdl2 version older than that, but need some features past 2.0.8, you'd have to use the extra-*-dirs way.

Take a look at the getting started guide.

We need your help! The SDL API is fairly large, and the more hands we have, the quicker we can reach full coverage and release this to Hackage. There are a few ways you can help:

1. Browse http://wiki.libsdl.org/CategoryAPI and find functions that aren't exposed in the high-level bindings.

2. The above can be somewhat laborious - an easier way to find out what's missing is to write code.

   • http://www.willusher.io/pages/sdl2/ is a collection of tutorials for C++.
   • http://lazyfoo.net/tutorials/SDL/index.php is another collection of C++ tutorials.

   Both of these would be useful if they were translated to Haskell, and we'd be happy to store this code in this repository.

3. Documentation is welcome, but may not be the best use of your time as we are currently in a period of rapid development as we find the most productive API.

You can use cabal repl as a development tool, but you'll need to configure the project in a slightly non-standard way first:

cabal configure --ghc-option=-fPIC

You only need to do this once (unless you reconfigure). From this point, cabal repl should Just Work.

If you get an Invalid window error, try the -fno-ghci-sandbox option. For example, in ghci:

:set -fno-ghci-sandbox