fir: An EDSL that compiles to SPIR-V for graphics programming on the GPU in Haskell.

FIR is an EDSL for writing GPU shader code in Haskell, compiled to SPIR-V. Requires GHC >= 8.10.

With this library, shader programs can be written using do notation. Such programs are then transformed into abstract syntax trees (ASTs), before being compiled to SPIR-V assembly.

In effect, this replaces GLSL as a shader language. This means the Haskell type-system and type-checker are put to use in verifying programs at compile-time. Functional idioms, such as functor and applicative operations, are also supported.

See the fir-examples project subdirectory for fleshed out examples, including using the vulkan package for rendering.

The exposed modules are:

FIR

Re-exports the main functionality of the library: writing and compiling programs.

FIR.Syntax.Labels

Optional imperative-like syntax using OverloadedLabels.

Math.Linear

Vectors, matrices, and operations on them, as used by this library.

Math.Quaternion

Quaternions and their action by conjugation in 3 dimensions, useful for 3D cameras.

Important types used by this library:

Code a

Code for a pure value of type a, represented internally as an abstract syntax tree. See FIR.AST.

Overloaded functions are provided that automatically create and combine terms of this type. For instance, 3 + 5 :: Code Float gets desugared to PrimOp FAdd ( Lit 3.0 ) ( Lit 5.0 ).

Program i j a

A monadic expression, starting in state i and ending in state j. This state is used to keep track of information at the type level, allowing for type errors to be thrown on invalid operations (e.g. writing to a read-only variable, image sampling outside a fragment shader, etc).

A value of type Program i j (Code a) can be thought of as stateful GPU code producing a value of type a.

Internally represented using the codensity transformation of McBride-style indexed monads, see Control.Monad.Indexed.

Module defs

Code for a program that can be compiled to a SPIR-V module.

defs is a type-level list of shader inputs/ouputs (uniforms, varyings, etc), top-level functions, and entry points.

See FIR.Module for the definition, and the example shaders for common usage patterns.

Values of all three of these types can be displayed graphically as trees using showAST/drawAST, which can be useful for debugging.

See the project readme for further information, as well as the "getting started" guide, which includes instructions concerning installation and usage of the library, and of useful tools such as the SPIR-V tools provided by the Vulkan SDK.

Modules

Flags

Manual Flags

Name	Description	Default
internals	This flag exposes all internal modules that by default are inaccessible. It's mostly only useful for library developers to use the internals of FIR rather than end users writing shader programs.	Disabled
sop	This flag exposes a module with Syntactic instances for generics-sop.	Disabled

Use -f <flag> to enable a flag, or -f -<flag> to disable that flag. More info

Downloads

• fir-0.1.0.0.tar.gz [browse] (Cabal source package)
• Package description (revised from the package)

Note: This package has metadata revisions in the cabal description newer than included in the tarball. To unpack the package including the revisions, use 'cabal get'.

Maintainer's Corner

Package maintainers

• sheaf

For package maintainers and hackage trustees

• edit package information

Candidates

• No Candidates