tekktonic / tsdl

Thin bindings to SDL for OCaml

Tsdl — Thin bindings to SDL for OCaml

Release %%VERSION%%

Tsdl is an OCaml library providing thin bindings to the cross-platform SDL C library.

Tsdl depends on the SDL 2.0.1 C library (or later) and ocaml-ctypes. Tsdl is distributed under the BSD3 license.

Home page: http://erratique.ch/software/tsdl
Contact: Daniel Bünzli <daniel.buenzl [e-mail]>

Installation

Tsdl needs the C library SDL 2.0.1 or later installed on your system. Tsdl can be installed with opam:

opam install tsdl

If you don't use opam consult the opam file for build instructions and a complete specification of the dependencies.

Documentation

The documentation and API reference is automatically generated by ocamldoc from the interfaces. It can be consulted online and there is a generated version in the doc directory of the distribution.

Sample programs

Sample programs are located in the test directory of the distribution. They can be built with:

ocamlbuild -use-ocamlfind tests.otarget

The resulting binaries are in _build/test :

• test.native, tests the bindings, the executable should exit with 0.
• sdlevents.native, traces SDL events.
• min.native a minimal SDL example.