deepfire / reflex-glfw Goto Github PK

View Code? Open in Web Editor NEW

11.0 5.0 2.0 293 KB

A GLFW-b adapter for the Haskell Reflex FRP implementation.

License: BSD 3-Clause "New" or "Revised" License

Haskell 92.92% Nix 6.07% Emacs Lisp 0.39% Makefile 0.21% Shell 0.41%

haskell glfw reflex-frp reflex frp adapter opengl demo-app

reflex-glfw's Introduction

Pre-release NOTE

reflex-glfw awaits to be released on Hackage:

progress: https://github.com/deepfire/reflex-glfw/milestone/1
post issues here: https://github.com/deepfire/reflex-glfw/issues
general feedback here: #7

reflex-glfw

What

reflex-glfw is an adapter between Reflex, a Haskell FRP framework and GLFW-b, a set of GLFW bindings.

Where

The home of reflex-glfw is at its Github page: https://github.com/deepfire/reflex-glfw

Reflex 0.5

reflex-glfw depends on a pre-release version of reflex, which means having to jump through extra hoops to use reflex-glfw.

Installing via Nix

By far the easiest and most reliable way to do this is to employ the Nix package manager, which, unless you already have it, has to be installed first, of course:

https://nixos.org/nix/

Building the demo

Once you have Nix installed, building the demo is as easy as:

# First, enter the fixed environment (NOTE: this can take a while):
nix-shell --no-build-output
# ..then, inside the shell:
cabal build
dist/build/reflex-glfw-demo/reflex-glfw-demo

libGL error: unable to load driver: XXX_dri.so

In case you happen upon #4, at least for nVidia GPUs there’s a semi-automated solution based on https://github.com/deepfire/nix-install-vendor-gl:

git clone https://github.com/deepfire/nix-install-vendor-gl
. ./nix-install-vendor-gl/nix-install-vendor-gl.sh

Screenshot

reflex-glfw's People

Contributors

Stargazers

Watchers

Forkers

plumpmath boblehest

reflex-glfw's Issues

Pre-hackage-release feedback

Please, post here any feedback that you don't feel as warranting a separate issue of its own.

Feel free to post anything -- rants, gripes, wishes -- anything at all.

Event class enabling/disabling not exported to the user

While the underlying code allowing for configuration of events being fired is both defined:

https://github.com/deepfire/reflex-glfw/blob/master/src/Reflex/GLFW.hs#L269
..and exercised:
https://github.com/deepfire/reflex-glfw/blob/master/src/Reflex/GLFW.hs#L329
..it hasn't yet been made available to the library user.

GLFW error callback doesn't appear to work, at least during GLFW init time

As an example, the reflex-glfw-demo is incompatible with OpenGL 3.3, so changing withGLWindow like this:

withGLWindow width height title f = do
     liftIO $ GL.setErrorCallback $ Just simpleErrorPrinter
+    liftIO $ GL.defaultWindowHints
+    liftIO $ mapM_ GL.windowHint
+      [ GL.WindowHint'ContextVersionMajor 3
+      , GL.WindowHint'ContextVersionMinor 3
+      , GL.WindowHint'OpenGLProfile GL.OpenGLProfile'Core
+      , GL.WindowHint'OpenGLForwardCompat True ]
     m <- liftIO $ GL.createWindow width height title Nothing Nothing

makes the demo fail obscurely, without invoking the error callback:

[nix-shell:~/src/reflex-glfw]$ cabal build && dist/build/reflex-glfw-demo/reflex-glfw-demo
Building reflex-glfw-0.1.0.0...
Preprocessing library reflex-glfw-0.1.0.0...
[1 of 1] Compiling Reflex.GLFW      ( src/Reflex/GLFW.hs, dist/build/Reflex/GLFW.o )
Preprocessing executable 'reflex-glfw-demo' for reflex-glfw-0.1.0.0...
Linking dist/build/reflex-glfw-demo/reflex-glfw-demo ...
reflex-glfw-demo: Prelude.head: empty list

A similar failure to invoke the handler can be observed if one fails to run Reflex.GLFW.init -- the error message is produced by withGLWindow itself, not the simpleErrorPrinter handler that is set up by the time of its invocation.

It is a bit mysterious..

reflex-0.5.0 is not on Hackage

Current version of reflex-glfw depends on an unreleased version of Reflex.

Set up Travis CI

pinned nixpkgs

On my 19.09-subscribed system, nix fails to install relfex-0.6 because it's broken. Could the repo pin a working nixpkgs commit to avoid such issues?

Package ‘reflex-0.6.2.4’ in /nix/store/1h469q2hg2hhafn8c3ydhixh9x3ci354-nixpkgs-19.09pre194448.8cc2b315143/nixpkgs/pkgs/development/haskell-modules/hackage-packages.nix:195658 is marked as broken, refusing to evaluate.

GL window configuration essentially hard-coded

There is no easy way to configure the properties of the window requested of GL, viz.:

https://github.com/deepfire/reflex-glfw/blob/master/src/Reflex/GLFW.hs#L105

Demo build dependency failure: haskell-src-exts

I'm a total noob with nix, reflex and reflex-glfw (thanks for sharing). Following: nix-shell --no-build-output, I received a build error about a missing dependency:

Configuring reflex-0.5.0...
Setup: Encountered missing dependencies:
haskell-src-exts >=1.16 && <1.20

Hackage shows that package is currently at version 1.20.2. Is there an easy way for me to sort this or does this require a bump elsewhere?

GL setup failure on non-NixOS linuxen

Basically, it's an instance of NixOS/nixpkgs#9415, and manifests like this:

[nix-shell:~/src/reflex-glfw]$ cabal clean
cleaning...

[nix-shell:~/src/reflex-glfw]$ cabal build
Package has never been configured. Configuring with default flags. If this
fails, please run configure manually.
Warning: The package list for 'hackage.haskell.org' does not exist. Run 'cabal
update' to download it.
Resolving dependencies...
Configuring reflex-glfw-0.1.0.0...
Building reflex-glfw-0.1.0.0...
Preprocessing library reflex-glfw-0.1.0.0...
[1 of 1] Compiling Reflex.GLFW      ( src/Reflex/GLFW.hs, dist/build/Reflex/GLFW.o )
Preprocessing executable 'reflex-glfw-demo' for reflex-glfw-0.1.0.0...
[1 of 2] Compiling Gear             ( Gear.hs, dist/build/reflex-glfw-demo/reflex-glfw-demo-tmp/Gear.o )
[2 of 2] Compiling Main             ( Demo.hs, dist/build/reflex-glfw-demo/reflex-glfw-demo-tmp/Main.o )
Linking dist/build/reflex-glfw-demo/reflex-glfw-demo ...

[nix-shell:~/src/reflex-glfw]$ dist/build/reflex-glfw-demo/reflex-glfw-demo
libGL error: unable to load driver: swrast_dri.so
libGL error: failed to load driver: swrast

Input event processing limited at one per frame

As can be seen at

https://github.com/deepfire/reflex-glfw/blob/master/src/Reflex/GLFW.hs#L376
..events are processed at a rate of at most one per frame, which is a shame, since all the grown up folks process them all in one go, till GLFW event queue exhaustion, as can be seen at:
https://github.com/bsl/GLFW-b-demo/blob/master/src/Main.hs#L253

This causes an unfortunate over-queuing of events, that can get quite visible sometimes.