Thin bindings to SDL for OCaml
OCaml C Standard ML
Clone or download
Latest commit c3a7846 Dec 27, 2017

README.md

Tsdl — Thin bindings to SDL for OCaml

%%VERSION%%

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

Tsdl depends on the SDL 2.0.6 C library (or later), ocaml-ctypes and the result compatibility package. Tsdl is distributed under the ISC license.

Home page: http://erratique.ch/software/tsdl
Contact: Daniel Bünzli <daniel.buenzl i@erratique.ch>

Installation

Tsdl needs the C library SDL 2.0.6 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 from the source interfaces. It can be consulted online or via odig doc tsdl.

Sample programs

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

./pkg/pkg.ml build --tests true

and listed with

./pkg/pkg.ml test --list

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.