FRP.Netwire.Input.GLFW

This module contains data types with instances needed to create wires that can be used with the netwire-input combinators. In particular, this package implements GLFWInputT which has instances of MonadKeyboard and MonadMouse

GLFW Input

Basic Input Monad

type GLFWInput = State GLFWInputState

The GLFWInput monad is simply a state monad around the GLFWInputState

Monad Transformer

type GLFWInputT m = StateT GLFWInputState m

The GLFWInputT monad transformer is simply a state monad transformer using GLFWInputState

State Types

data GLFWInputControl

This is an STM variable that holds the current input state. It cannot be manipulated directly, but it is updated by GLFW each time pollGLFW is called.

data GLFWInputState

The GLFW input state is a record that keeps track of which buttons and keys are currently pressed. Because GLFW works with callbacks, a call to pollEvents must be made in order to process any of the events. At this time, all of the appropriate callbacks are fired in order of the events received, and this record is updated to reflect the most recent input state.

Instances

Show GLFWInputState

(Functor m, Monad m) => MonadMouse MouseButton (StateT GLFWInputState m)

(Functor m, Monad m) => MonadKeyboard Key (StateT GLFWInputState m)

getInput :: GLFWInputControl -> IO GLFWInputState

Returns a current snapshot of the input

mkInputControl :: Window -> IO GLFWInputControl

Creates and returns an STM variable for the window that holds all of the most recent input state information

pollGLFW :: GLFWInputState -> GLFWInputControl -> IO GLFWInputState

Allows GLFW to interact with the windowing system to update the current state. The old state must be passed in order to properly reset certain properties such as the scroll wheel. The returned input state is identical to a subsequent call to getInput right after a call to pollEvents