2D graphics and interaction for Futhark

Lys is a library and wrapper for pain-free graphics programming with Futhark. It works by using Makefile rules to automatically generate a wrapper program in C that uses SDL2 or the console to display graphics and handle user events, whose behaviour is controlled by calling a Futhark program with specially defined entry points.

Trying the Demo (assuming that you have git-cloned this repository)

Make sure that the requirements described below are satisfied. Then execute the commands:

$ futhark pkg sync
$ make
$ ./lys

A window should now open and you should be able to navigate the white object with the arrow keys and the mouse. Change object to a square by pressing s, and back to a circle by pressing c. Exit by pressing ESC.

General Usage

Download the package like any other Futhark package:

$ futhark pkg add github.com/diku-dk/lys
$ futhark pkg sync

Then create a Makefile with the following contents:

include lib/github.com/diku-dk/lys/common.mk

Finally create a Futhark program lys.fut that defines at least a module named lys of module type lys (example). Run make and a binary called lys will be compiled.

If you don't want your binary to be called lys, set the Makefile variable PROGNAME to whatever you wish. For example, if you use

PROGNAME=spetakel
include lib/github.com/diku-dk/lys/common.mk

then Lys will look for a Futhark program spetakel.fut and generate a binary named spetakel. The file spetakel.fut should still define a module called lys, however.

It is also possible to use Lys as a general library, in which case you write both the Futhark file and the corresponding C file. This gives you more flexibility in how you use the built-in text overlay and how you initialise Lys' state, but keeps the default event-render SDL loop.

Requirements

Lys is written in C, and requires a working C compiler and the SDL2 and SDL2-ttf libraries with associated header files. On Debian-like systems (including Ubuntu), this can be installed with

# apt install libsdl2-dev libsdl2-ttf-dev

On RHEL/Fedora:

# yum install SDL2-devel SDL2_ttf-devel

On macOS with Homebrew, run

$ brew install sdl2 sdl2_gfx sdl2_image sdl2_ttf

On Windows... well, if you know how, please tell us!

Common keybindings

These keybindings are common for all lys programs:

• ESC (or Ctrl-c with console): Exit the program, or escape mouse grabbing.
• F1: Toggle showing text.

Common command-line options

Run ./lys --help to see the available options.

Configuring the backend

By default, the build rules defined in lib/github.com/diku-dk/lys/common.mk use Futhark's OpenCL backend. You can change it by setting LYS_BACKEND to either cuda, multicore, or c, either in the Makefile or as an environment variable.

Configuring the frontend

By default, Lys uses SDL to display graphics and read input. There is also support for using the terminal to render graphics. This can be enabled by setting LYS_FRONTEND=console before (re-)compiling. The following caveats apply:

• Lys expects a terminal capable of 24-bit colours.

• Terminals "pixels" are rectangular, but not square. Lys tries to implement square pixels through Unicode box characters and separate foreground/background colours. How well this works depends on your terminal and its font settings.

• Terminals are relatively slow. You can increase the resolution by using a small font, but it will be much slower than SDL.

• Terminals do not support fine-grained input events, e.g. separate key up/down events. Lys tries its best to simulate these.

Some Lys programs might work fine using the console frontend, but others may not work so well.

Examples of programs using Lys

• Accelerate's ray tracer
• Ether
• Functional Images
• Mandelbrot Explorer
• Tinykaboom in Futhark
• Fastcast
• Abelian Sandpile
• futswirl
• stupidart (uses Lys as a library)