lit

lit copied to clipboard

Lit — Lightweight OpenGL-based rendering engine for OCaml

%%VERSION%%

Lit is a lightweight OpenGL-based rendering engine for OCaml. It provides a thin abstraction to program GPUs with OpenGL, OpenGL ES or WebGL.

Lit depends on gg. The OpenGL and OpenGL ES renderers depend on tgls. The WebGL renderer on js_of_ocaml. Lit and its renderers are distributed under the ISC license.

Home page: http://erratique.ch/software/lit
Contact: Daniel Bünzli <daniel.buenzl [email protected]>

Installation

Lit can be installed with opam:

opam install gg tgls js_of_ocaml lit   # All renderers
opam install gg tgls lit               # OpenGL and OpenGL ES renderers 
opam install gg js_of_ocaml lit        # WebGL renderer
opam install gg lit                    # No renderer

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 lit.

Sample programs

If you installed Lit with opam sample programs are located in the directory opam config var lit:doc. Their source has a comment on how to compile them.

In the distribution sample programs and tests are located in the test directory of the distribution. You'll need useri to compile them. They can be built and listed with:

topkg build --tests true && topkg test --list