{-| Threading restrictions which apply to the C version of GLFW still apply when writing @GLFW-b@ programs. See (applies here). Current context restructions which apply to the C version of GLFW still apply. See (applies here). @GLFW-b@ wraps callbacks and schedules them to be run after 'pollEvents' and 'waitEvents' in the normal GHC runtime where they aren't subject to the usual GLFW reentrancy restrictions. See (does not apply here). -} module Graphics.UI.GLFW ( -- * Error handling Error (..) -- , setErrorCallback, ErrorCallback -- * Initialization and version information , Version (..) -- , init , terminate , getVersion , getVersionString -- * Monitor handling , Monitor , MonitorState (..) , VideoMode (..) , GammaRamp (gammaRampRed, gammaRampGreen, gammaRampBlue) , makeGammaRamp -- , getMonitors , getPrimaryMonitor , getMonitorPos , getMonitorPhysicalSize , getMonitorName , setMonitorCallback, MonitorCallback , getVideoModes , getVideoMode , setGamma , getGammaRamp , setGammaRamp -- * Window handling , Window , WindowHint (..) , ContextRobustness (..) , OpenGLProfile (..) , ClientAPI (..) , ContextCreationAPI (..) , ContextReleaseBehavior (..) -- , defaultWindowHints , windowHint , createWindow , destroyWindow , windowShouldClose , setWindowShouldClose , setWindowTitle , getWindowPos , setWindowPos , getWindowSize , setWindowSize , setWindowSizeLimits , setWindowAspectRatio , getWindowFrameSize , getFramebufferSize , setWindowIcon , iconifyWindow , restoreWindow , focusWindow , maximizeWindow , showWindow , hideWindow , getWindowMonitor , setCursorPos , setFullscreen , setWindowed -- related to c'glfwGetWindowAttrib --. , getWindowFocused -- | , getWindowMaximized -- | , getWindowFloating -- | , getWindowIconified -- | , getWindowResizable -- | , getWindowDecorated -- | , getWindowVisible -- | , getWindowClientAPI -- | , getWindowContextCreationAPI -- | , getWindowContextVersionMajor -- | , getWindowContextVersionMinor -- | , getWindowContextVersionRevision -- | , getWindowContextRobustness -- | , getWindowContextReleaseBehavior -- | , getWindowContextNoError -- | , getWindowOpenGLForwardCompat -- | , getWindowOpenGLDebugContext -- | , getWindowOpenGLProfile --------------' , setWindowPosCallback, WindowPosCallback , setWindowSizeCallback, WindowSizeCallback , setWindowCloseCallback, WindowCloseCallback , setWindowRefreshCallback, WindowRefreshCallback , setWindowFocusCallback, WindowFocusCallback , setWindowIconifyCallback, WindowIconifyCallback , setFramebufferSizeCallback, FramebufferSizeCallback , pollEvents , waitEvents , waitEventsTimeout , postEmptyEvent -- * Input handling , Key (..) , KeyState (..) , Joystick (..) , JoystickState (..) , JoystickButtonState (..) , MouseButton (..) , MouseButtonState (..) , CursorState (..) , CursorInputMode (..) , StickyKeysInputMode (..) , StickyMouseButtonsInputMode (..) , ModifierKeys (..) , Image , mkImage , Cursor (..) , StandardCursorShape (..) -- -- related to c'glfwSetInputMode ----. , getCursorInputMode -- | , setCursorInputMode -- | , getStickyKeysInputMode -- | , setStickyKeysInputMode -- | , getStickyMouseButtonsInputMode -- | , setStickyMouseButtonsInputMode -----' , getKey , getKeyName , getMouseButton , getCursorPos , setKeyCallback, KeyCallback , setCharCallback, CharCallback , setCharModsCallback, CharModsCallback , setMouseButtonCallback, MouseButtonCallback , setCursorPosCallback, CursorPosCallback , setCursorEnterCallback, CursorEnterCallback , createCursor , createStandardCursor , setCursor , destroyCursor , setScrollCallback, ScrollCallback , setDropCallback, DropCallback , joystickPresent , getJoystickAxes , getJoystickButtons , getJoystickName , setJoystickCallback, JoystickCallback -- * Time , getTime , setTime , getTimerValue , getTimerFrequency -- * Context , makeContextCurrent , getCurrentContext , swapBuffers , swapInterval , extensionSupported -- * Clipboard , getClipboardString , setClipboardString -- * Vulkan-related functions , vulkanSupported , getRequiredInstanceExtensions , getInstanceProcAddress , getPhysicalDevicePresentationSupport , createWindowSurface -- * Native access functions -- $nativeaccess , getWin32Adapter , getWin32Monitor , getWin32Window , getWGLContext , getCocoaMonitor , getCocoaWindow , getNSGLContext , getX11Display , getX11Adapter , getX11Monitor , getX11Window , getGLXContext , getGLXWindow , getWaylandDisplay , getWaylandMonitor , getWaylandWindow , getMirDisplay , getMirMonitor , getMirWindow , getEGLDisplay , getEGLContext , getEGLSurface ) where -------------------------------------------------------------------------------- import Prelude hiding (init) import Control.Monad (when, liftM) import Data.IORef (IORef, atomicModifyIORef, newIORef, readIORef) import Data.Word (Word32, Word64) import Foreign.C.String (peekCString, withCString, CString) import Foreign.C.Types (CUInt, CUShort) import Foreign.Marshal.Alloc (alloca, allocaBytes) import Foreign.Marshal.Array (advancePtr, allocaArray, peekArray, withArray) import Foreign.Ptr (FunPtr, freeHaskellFunPtr, nullFunPtr, nullPtr ,Ptr) import Foreign.StablePtr import Foreign.Storable (Storable (..)) import System.IO.Unsafe (unsafePerformIO) import Graphics.UI.GLFW.C import Graphics.UI.GLFW.Types import Bindings.GLFW -------------------------------------------------------------------------------- -- We store FunPtrs from mk'GLFW*fun in these stored*Fun IORefs. Initialized -- with unsafePerformIO, they are basically mutable global variables. storedErrorFun :: IORef C'GLFWerrorfun storedMonitorFun :: IORef C'GLFWmonitorfun storedJoystickFun :: IORef C'GLFWjoystickfun storedErrorFun = unsafePerformIO $ newIORef nullFunPtr storedMonitorFun = unsafePerformIO $ newIORef nullFunPtr storedJoystickFun = unsafePerformIO $ newIORef nullFunPtr -- These NOINLINE pragmas are due to use of unsafePerformIO. -- See http://hackage.haskell.org/packages/archive/base/latest/doc/html/System-IO-Unsafe.html#v:unsafePerformIO . {-# NOINLINE storedErrorFun #-} {-# NOINLINE storedMonitorFun #-} {-# NOINLINE storedJoystickFun #-} setWindowCallback :: (c -> IO (FunPtr c)) -- wf wrapper function -> (h -> c) -- af adapter function -> (FunPtr c -> IO (FunPtr c)) -- gf c'glfwSet*Callback function -> (WindowCallbacks -> IORef (FunPtr c)) -- ior accessor for storage location -> Window -- win window -> Maybe h -- mcb Haskell callback -> IO () setWindowCallback wr af gf ior win mcb = do pcallbacks <- castPtrToStablePtr `liftM` c'glfwGetWindowUserPointer (unWindow win) callbacks <- deRefStablePtr pcallbacks setCallback wr af gf (ior callbacks) mcb setCallback :: (c -> IO (FunPtr c)) -- wf wrapper function -> (h -> c) -- af adapter function -> (FunPtr c -> IO (FunPtr c)) -- gf c'glfwSet*Callback function -> IORef (FunPtr c) -- ior storage location -> Maybe h -- mcb Haskell callback -> IO () setCallback wf af gf ior mcb = do -- If mcb is Just, make ccb the FunPtr of the adapted callback. Otherwise a -- null FunPtr. ccb <- maybe (return nullFunPtr) (wf . af) mcb -- Call the GLFW callback-setting function. _ <- gf ccb -- Store it. storeCallback ior ccb storeCallback :: IORef (FunPtr a) -> FunPtr a -> IO () storeCallback ior new = do -- Store the new FunPtr, retrieve the previous one. prev <- atomicModifyIORef ior (\cur -> (new, cur)) -- Free the old FunPtr if necessary. when (prev /= nullFunPtr) $ freeHaskellFunPtr prev -------------------------------------------------------------------------------- -- | The error code and also a human-readable error message. type ErrorCallback = Error -> String -> IO () -- | Fires when the window position changes. type WindowPosCallback = Window -> Int -> Int -> IO () -- | Fires when the window is resized (in Screen Coordinates, which might not map 1:1 with pixels). type WindowSizeCallback = Window -> Int -> Int -> IO () -- | Fires when the user is attempting to close the window type WindowCloseCallback = Window -> IO () -- | Fires when the contents of the window are damaged and they must be refreshed. type WindowRefreshCallback = Window -> IO () -- | Fires when the window gains or loses input focus. type WindowFocusCallback = Window -> Bool -> IO () -- | Fires when the window is iconified (minimized) or not. type WindowIconifyCallback = Window -> Bool -> IO () -- | Fires when the size of the framebuffer for the window changes (in Pixels). type FramebufferSizeCallback = Window -> Int -> Int -> IO () -- | Fires whenever a mouse button is clicked. type MouseButtonCallback = Window -> MouseButton -> MouseButtonState -> ModifierKeys -> IO () -- | Fires every time the cursor position changes. Sub-pixel accuracy is used, when available. type CursorPosCallback = Window -> Double -> Double -> IO () -- | Fires when the cursor enters or exits the client area of the window. type CursorEnterCallback = Window -> CursorState -> IO () -- | Fires when the user scrolls the mouse wheel or via touch gesture. type ScrollCallback = Window -> Double -> Double -> IO () -- | Fires for each press or repeat of keyboard keys (regardless of if it has textual meaning or not, eg Shift) type KeyCallback = Window -> Key -> Int -> KeyState -> ModifierKeys -> IO () -- | Fires when a complete character codepoint is typed by the user, Shift then 'b' generates "B". type CharCallback = Window -> Char -> IO () -- | Similar to 'CharCallback', fires when a complete unicode codepoint is typed by the user. type CharModsCallback = Window -> Char -> ModifierKeys -> IO () -- | Fires when a monitor is connected or disconnected. type MonitorCallback = Monitor -> MonitorState -> IO () -- | Fires when a joystick is connected or disconnected. type JoystickCallback = Joystick -> JoystickState -> IO () -- 3.1 additions -------------------------------------------------------------------------------- -- CB scheduling data ScheduledCallbacks = ScheduledCallbacks { _forward :: [IO ()] -- Execution iterates this list , _backward :: [IO ()] -- New schedules prepend here } storedScheduledCallbacks :: IORef ScheduledCallbacks storedScheduledCallbacks = unsafePerformIO . newIORef $ ScheduledCallbacks [] [] -- This NOINLINE pragma is due to use of unsafePerformIO. -- See http://hackage.haskell.org/packages/archive/base/latest/doc/html/System-IO-Unsafe.html#v:unsafePerformIO . {-# NOINLINE storedScheduledCallbacks #-} -- This is provided in newer "base" versions. To avoid depending on -- it, it's reimplemented here. Should remove if/when compatibility -- with older base is not an issue: atomicModifyIORef' :: IORef a -> (a -> (a,b)) -> IO b atomicModifyIORef' ref f = do b <- atomicModifyIORef ref (\x -> let (a, b) = f x in (a, a `seq` b)) b `seq` return b schedule :: IO () -> IO () schedule act = atomicModifyIORef' storedScheduledCallbacks $ \(ScheduledCallbacks oldForward oldBackward) -> (ScheduledCallbacks oldForward (act : oldBackward), ()) splitFirst :: [a] -> (Maybe a, [a]) splitFirst [] = (Nothing, []) splitFirst (x:xs) = (Just x, xs) getNextScheduled :: IO (Maybe (IO ())) getNextScheduled = atomicModifyIORef storedScheduledCallbacks $ \(ScheduledCallbacks oldForward oldBackward) -> case oldForward of [] -> let (mCb, newForward) = splitFirst (reverse oldBackward) in (ScheduledCallbacks newForward [], mCb) (cb:rest) -> -- Eat forward first (ScheduledCallbacks rest oldBackward, Just cb) executeScheduled :: IO () executeScheduled = do mcb <- getNextScheduled case mcb of Nothing -> return () Just cb -> cb >> executeScheduled -------------------------------------------------------------------------------- -- Error handling -- | Can (and probably should) be used before GLFW initialization. -- See setErrorCallback :: Maybe ErrorCallback -> IO () setErrorCallback = setCallback mk'GLFWerrorfun (\cb a0 a1 -> do s <- peekCString a1 schedule $ cb (fromC a0) s) c'glfwSetErrorCallback storedErrorFun -------------------------------------------------------------------------------- -- Image utility functions withGLFWImage :: Image -> (Ptr C'GLFWimage -> IO a) -> IO a withGLFWImage (Image w h pxs) f = alloca $ \p'img -> withArray pxs $ \p'pxs -> do poke p'img $ C'GLFWimage (toC w) (toC h) p'pxs f p'img -------------------------------------------------------------------------------- -- Initialization and version information -- | Attempts to initialize the GLFW library. When the library is not initialized, the only -- allowed functions to call are 'getVersion', 'getVersionString', 'setErrorCallback', -- 'init', and 'terminate'. Returns if the initialization was successful or not. -- See -- and init :: IO Bool init = fromC `fmap` c'glfwInit -- | Cleans up GLFW and puts the library into an uninitialized state. -- Once you call this, you must initilize the library again. -- Warning: No window's context may be current in another thread when this is called. -- See -- and . This -- function is not . terminate :: IO () terminate = do c'glfwTerminate -- Free all stored FunPtrs. storeCallback storedErrorFun nullFunPtr storeCallback storedMonitorFun nullFunPtr storeCallback storedJoystickFun nullFunPtr -- | Gets the version of the GLFW library that's being used with the current program. -- See getVersion :: IO Version getVersion = allocaArray 3 $ \p -> do let p0 = p p1 = p `advancePtr` 1 p2 = p `advancePtr` 2 c'glfwGetVersion p0 p1 p2 v0 <- fromC `fmap` peek p0 v1 <- fromC `fmap` peek p1 v2 <- fromC `fmap` peek p2 return $ Version v0 v1 v2 -- | Gets the compile-time version string of the GLFW library binary. -- Gives extra info like platform and compile time options used, but you should not -- attempt to parse this to get the GLFW version number. Use 'getVersion' instead. -- See getVersionString :: IO (Maybe String) getVersionString = do p'vs <- c'glfwGetVersionString if p'vs /= nullPtr then Just `fmap` peekCString p'vs else return Nothing -------------------------------------------------------------------------------- -- Monitor handling -- | Gets the list of available monitors, if possible. -- See getMonitors :: IO (Maybe [Monitor]) getMonitors = alloca $ \p'n -> do p'mon <- c'glfwGetMonitors p'n n <- fromC `fmap` peek p'n if p'mon == nullPtr || n <= 0 then return Nothing else (Just . map fromC) `fmap` peekArray n p'mon -- | Gets the primary monitor. -- See getPrimaryMonitor :: IO (Maybe Monitor) getPrimaryMonitor = do p'mon <- c'glfwGetPrimaryMonitor return $ if p'mon == nullPtr then Nothing else Just $ fromC p'mon -- | Gets the position of the specified monitor within the coordinate space. -- See getMonitorPos :: Monitor -> IO (Int, Int) getMonitorPos mon = allocaArray 2 $ \p -> do let p'x = p p'y = p `advancePtr` 1 c'glfwGetMonitorPos (toC mon) p'x p'y x <- fromC `fmap` peek p'x y <- fromC `fmap` peek p'y return (x, y) -- | The physical width and height of the monitor. -- See getMonitorPhysicalSize :: Monitor -> IO (Int, Int) getMonitorPhysicalSize mon = allocaArray 2 $ \p -> do let p'w = p p'h = p `advancePtr` 1 c'glfwGetMonitorPhysicalSize (toC mon) p'w p'h w <- fromC `fmap` peek p'w h <- fromC `fmap` peek p'h return (w, h) -- | A human-readable name for the monitor specified. -- See getMonitorName :: Monitor -> IO (Maybe String) getMonitorName mon = do p'name <- c'glfwGetMonitorName (toC mon) if p'name == nullPtr then return Nothing else Just `fmap` peekCString p'name -- | Sets a callback for when a monitor is connected or disconnected. -- See setMonitorCallback :: Maybe MonitorCallback -> IO () setMonitorCallback = setCallback mk'GLFWmonitorfun (\cb a0 a1 -> schedule $ cb (fromC a0) (fromC a1)) c'glfwSetMonitorCallback storedMonitorFun -- | Obtains the possible video modes of the monitor. -- See getVideoModes :: Monitor -> IO (Maybe [VideoMode]) getVideoModes mon = alloca $ \p'n -> do p'vms <- c'glfwGetVideoModes (toC mon) p'n n <- fromC `fmap` peek p'n if p'vms == nullPtr || n <= 0 then return Nothing else (Just . map fromC) `fmap` peekArray n p'vms -- | Gets the active video mode of the monitor. -- See getVideoMode :: Monitor -> IO (Maybe VideoMode) getVideoMode mon = do p'vm <- c'glfwGetVideoMode (toC mon) if p'vm == nullPtr then return Nothing else (Just . fromC) `fmap` peek p'vm -- | Sets the gamma of a monitor. -- See setGamma :: Monitor -> Double -> IO () setGamma mon e = c'glfwSetGamma (toC mon) (toC e) -- | Gets the gamma ramp in use with the monitor. -- See getGammaRamp :: Monitor -> IO (Maybe GammaRamp) getGammaRamp m = do p'ggr <- c'glfwGetGammaRamp (toC m) if p'ggr == nullPtr then return Nothing else do ggr <- peek p'ggr let p'rs = c'GLFWgammaramp'red ggr p'gs = c'GLFWgammaramp'green ggr p'bs = c'GLFWgammaramp'blue ggr cn = c'GLFWgammaramp'size ggr n = fromC cn if n == 0 || nullPtr `elem` [p'rs, p'gs, p'bs] then return Nothing else do rs <- map fromC `fmap` peekArray n p'rs gs <- map fromC `fmap` peekArray n p'gs bs <- map fromC `fmap` peekArray n p'bs return $ Just GammaRamp { gammaRampRed = rs , gammaRampGreen = gs , gammaRampBlue = bs } -- | Assigns a gamma ramp to use with the given monitor. -- See setGammaRamp :: Monitor -> GammaRamp -> IO () setGammaRamp mon gr = let rs = map toC $ gammaRampRed gr :: [CUShort] gs = map toC $ gammaRampGreen gr :: [CUShort] bs = map toC $ gammaRampBlue gr :: [CUShort] -- GammaRamp's smart constructor ensures that the RGB lists all have -- equal length, so just use the number of reds. cn = toC $ length rs :: CUInt in alloca $ \p'ggr -> withArray rs $ \p'rs -> withArray gs $ \p'gs -> withArray bs $ \p'bs -> do let ggr = C'GLFWgammaramp { c'GLFWgammaramp'red = p'rs , c'GLFWgammaramp'green = p'gs , c'GLFWgammaramp'blue = p'bs , c'GLFWgammaramp'size = cn } poke p'ggr ggr c'glfwSetGammaRamp (toC mon) p'ggr -------------------------------------------------------------------------------- -- Window handling -- | Sets all the window hints to default. -- See defaultWindowHints :: IO () defaultWindowHints = c'glfwDefaultWindowHints -- | Hints something to the GLFW windowing system. -- See windowHint :: WindowHint -> IO () windowHint wh = let (t, v) = unpack in c'glfwWindowHint t v where unpack = case wh of (WindowHint'Resizable x) -> (c'GLFW_RESIZABLE, toC x) (WindowHint'Visible x) -> (c'GLFW_VISIBLE, toC x) (WindowHint'Decorated x) -> (c'GLFW_DECORATED, toC x) (WindowHint'RedBits x) -> (c'GLFW_RED_BITS, toC x) (WindowHint'GreenBits x) -> (c'GLFW_GREEN_BITS, toC x) (WindowHint'BlueBits x) -> (c'GLFW_BLUE_BITS, toC x) (WindowHint'AlphaBits x) -> (c'GLFW_ALPHA_BITS, toC x) (WindowHint'DepthBits x) -> (c'GLFW_DEPTH_BITS, toC x) (WindowHint'StencilBits x) -> (c'GLFW_STENCIL_BITS, toC x) (WindowHint'AccumRedBits x) -> (c'GLFW_ACCUM_RED_BITS, toC x) (WindowHint'AccumGreenBits x) -> (c'GLFW_ACCUM_GREEN_BITS, toC x) (WindowHint'AccumBlueBits x) -> (c'GLFW_ACCUM_BLUE_BITS, toC x) (WindowHint'AccumAlphaBits x) -> (c'GLFW_ACCUM_ALPHA_BITS, toC x) (WindowHint'AuxBuffers x) -> (c'GLFW_AUX_BUFFERS, toC x) (WindowHint'Samples x) -> (c'GLFW_SAMPLES, toC x) (WindowHint'RefreshRate x) -> (c'GLFW_REFRESH_RATE, toC x) (WindowHint'DoubleBuffer x) -> (c'GLFW_DOUBLEBUFFER, toC x) (WindowHint'Stereo x) -> (c'GLFW_STEREO, toC x) (WindowHint'sRGBCapable x) -> (c'GLFW_SRGB_CAPABLE, toC x) (WindowHint'Floating x) -> (c'GLFW_FLOATING, toC x) (WindowHint'Focused x) -> (c'GLFW_FOCUSED, toC x) (WindowHint'Maximized x) -> (c'GLFW_MAXIMIZED, toC x) (WindowHint'AutoIconify x) -> (c'GLFW_AUTO_ICONIFY, toC x) (WindowHint'ClientAPI x) -> (c'GLFW_CLIENT_API, toC x) (WindowHint'ContextCreationAPI x) -> (c'GLFW_CONTEXT_CREATION_API, toC x) (WindowHint'ContextVersionMajor x) -> (c'GLFW_CONTEXT_VERSION_MAJOR, toC x) (WindowHint'ContextVersionMinor x) -> (c'GLFW_CONTEXT_VERSION_MINOR, toC x) (WindowHint'ContextRobustness x) -> (c'GLFW_CONTEXT_ROBUSTNESS, toC x) (WindowHint'ContextReleaseBehavior x) -> (c'GLFW_CONTEXT_RELEASE_BEHAVIOR, toC x) (WindowHint'ContextNoError x) -> (c'GLFW_CONTEXT_NO_ERROR, toC x) (WindowHint'OpenGLForwardCompat x) -> (c'GLFW_OPENGL_FORWARD_COMPAT, toC x) (WindowHint'OpenGLDebugContext x) -> (c'GLFW_OPENGL_DEBUG_CONTEXT, toC x) (WindowHint'OpenGLProfile x) -> (c'GLFW_OPENGL_PROFILE, toC x) -- | Creates a new window. -- Note: If running in GHCI don't forget to `:set -fno-ghci-sandbox` or you -- may run into an assertion failure, segfault or other nasty crash. -- See createWindow :: Int -- ^ Desired width for the window. -> Int -- ^ Desired height for the window. -> String -- ^ Desired title for the window. -> Maybe Monitor -- ^ Monitor to use in fullscreen mode. -> Maybe Window -- ^ Window for context object sharing, see -- . -> IO (Maybe Window) createWindow w h title mmon mwin = withCString title $ \ptitle -> do charFun <- newIORef nullFunPtr charModsFun <- newIORef nullFunPtr cursorEnterFun <- newIORef nullFunPtr cursorPosFun <- newIORef nullFunPtr framebufferSizeFun <- newIORef nullFunPtr keyFun <- newIORef nullFunPtr mouseButtonFun <- newIORef nullFunPtr scrollFun <- newIORef nullFunPtr windowCloseFun <- newIORef nullFunPtr windowFocusFun <- newIORef nullFunPtr windowIconifyFun <- newIORef nullFunPtr windowPosFun <- newIORef nullFunPtr windowRefreshFun <- newIORef nullFunPtr windowSizeFun <- newIORef nullFunPtr dropFun <- newIORef nullFunPtr let callbacks = WindowCallbacks { storedCharFun = charFun , storedCharModsFun = charModsFun , storedCursorEnterFun = cursorEnterFun , storedCursorPosFun = cursorPosFun , storedFramebufferSizeFun = framebufferSizeFun , storedKeyFun = keyFun , storedMouseButtonFun = mouseButtonFun , storedScrollFun = scrollFun , storedWindowCloseFun = windowCloseFun , storedWindowFocusFun = windowFocusFun , storedWindowIconifyFun = windowIconifyFun , storedWindowPosFun = windowPosFun , storedWindowRefreshFun = windowRefreshFun , storedWindowSizeFun = windowSizeFun , storedDropFun = dropFun } p'win <- c'glfwCreateWindow (toC w) (toC h) ptitle (maybe nullPtr toC mmon) (maybe nullPtr toC mwin) if p'win == nullPtr then return Nothing else do callbackPtr <- newStablePtr callbacks c'glfwSetWindowUserPointer p'win (castStablePtrToPtr callbackPtr) return $ Just $ fromC p'win -- | Cleans up a window and all associated resources -- See . -- This function is not . destroyWindow :: Window -> IO () destroyWindow win = do pcb <- castPtrToStablePtr `liftM` c'glfwGetWindowUserPointer (toC win) cbs <- deRefStablePtr pcb c'glfwDestroyWindow (toC win) let free callback = do funptr <- readIORef (callback cbs) when (funptr /= nullFunPtr) $ freeHaskellFunPtr funptr free storedCharFun free storedCharModsFun free storedCursorEnterFun free storedCursorPosFun free storedFramebufferSizeFun free storedKeyFun free storedMouseButtonFun free storedScrollFun free storedWindowCloseFun free storedWindowFocusFun free storedWindowIconifyFun free storedWindowPosFun free storedWindowRefreshFun free storedWindowSizeFun freeStablePtr pcb -- | If the window should close or not. -- See windowShouldClose :: Window -> IO Bool windowShouldClose win = fromC `fmap` c'glfwWindowShouldClose (toC win) -- | Sets if the window should close or not. -- See setWindowShouldClose :: Window -> Bool -> IO () setWindowShouldClose win b = c'glfwSetWindowShouldClose (toC win) (toC b) -- | Sets the Title string of the window. -- See setWindowTitle :: Window -> String -> IO () setWindowTitle win title = withCString title $ c'glfwSetWindowTitle (toC win) -- | Gets the window's position (in Screen Coordinates). -- See getWindowPos :: Window -> IO (Int, Int) getWindowPos win = allocaArray 2 $ \p -> do let p'x = p p'y = p `advancePtr` 1 c'glfwGetWindowPos (toC win) p'x p'y x <- fromC `fmap` peek p'x y <- fromC `fmap` peek p'y return (x, y) -- | Sets the window's position (in Screen Coordinates). -- See setWindowPos :: Window -> Int -> Int -> IO () setWindowPos win x y = c'glfwSetWindowPos (toC win) (toC x) (toC y) -- | Gets the size of the window (in Screen Coordinates). -- See getWindowSize :: Window -> IO (Int, Int) getWindowSize win = allocaArray 2 $ \p -> do let p'w = p p'h = p `advancePtr` 1 c'glfwGetWindowSize (toC win) p'w p'h w <- fromC `fmap` peek p'w h <- fromC `fmap` peek p'h return (w, h) -- | Gets the size of the frame around the window (in Screen Coordinates). This -- size includes the title bar, if the window has one. Not to be confused with -- 'getFramebufferSize', which gets the size of the rendering area. -- See getWindowFrameSize :: Window -> IO (Int, Int, Int, Int) getWindowFrameSize win = allocaArray 4 $ \p -> do let p'l = p p't = p `advancePtr` 1 p'r = p `advancePtr` 2 p'b = p `advancePtr` 3 c'glfwGetWindowFrameSize (toC win) p'l p't p'r p'b l <- fromC `fmap` peek p'l t <- fromC `fmap` peek p't r <- fromC `fmap` peek p'r b <- fromC `fmap` peek p'b return (l, t, r, b) -- | Sets the size of the client area for the window (in Screen Coordinates). -- See setWindowSize :: Window -> Int -> Int -> IO () setWindowSize win w h = c'glfwSetWindowSize (toC win) (toC w) (toC h) -- | Sets the size limits of the client area of the specified window. If the -- window is full screen, the size limits only take effect once it is made -- windowed. If the window is not resizable this function does nothing. Pass -- 'Nothing' in any argument to disable the limit. -- See setWindowSizeLimits :: Window -> Maybe Int -- ^ The minimum width, in screen coordinates, of the client -- area. -> Maybe Int -- ^ The minimum height, in screen coordinates, of the -- client area. -> Maybe Int -- ^ The maximum width, in screen coordinates, of the client -- area. -> Maybe Int -- ^ The maximum height, in screen coordinates, of the -- client area. -> IO () setWindowSizeLimits win min'w min'h max'w max'h = c'glfwSetWindowSizeLimits (toC win) (toC min'w) (toC min'h) (toC max'w) (toC max'h) -- | Sets the required aspect ratio of the client area of the specified window. -- Pass Nothing to disable the limit. -- See setWindowAspectRatio :: Window -> Maybe (Int, Int) -> IO () setWindowAspectRatio win Nothing = c'glfwSetWindowAspectRatio (toC win) c'GLFW_DONT_CARE c'GLFW_DONT_CARE setWindowAspectRatio win (Just (w, h)) = c'glfwSetWindowAspectRatio (toC win) (toC w) (toC h) -- | The size of the framebuffer (in Pixels) -- See getFramebufferSize :: Window -> IO (Int, Int) getFramebufferSize win = allocaArray 2 $ \p -> do let p'w = p p'h = p `advancePtr` 1 c'glfwGetFramebufferSize (toC win) p'w p'h w <- fromC `fmap` peek p'w h <- fromC `fmap` peek p'h return (w, h) -- | Sets the icon of the specified window. The system will try to find the -- image with the dimensions closest to the ones required by the platform. This -- image is then scaled and used as the icon for that size. Good sizes are -- 16x16, 32x32, and 48x48. Pass the empty list to reset to the default icon. -- Has no effect on OS X (See the ) setWindowIcon :: Window -> [Image] -> IO () setWindowIcon win [] = c'glfwSetWindowIcon (toC win) 0 nullPtr setWindowIcon win imgs = let arrSizeBytes = length imgs * sizeOf (undefined :: C'GLFWimage) addNextImage :: [Image] -> Int -> Ptr C'GLFWimage -> IO () addNextImage [] numImages ptr = c'glfwSetWindowIcon (toC win) (toC numImages) ptr addNextImage (img:rest) idx ptr = withGLFWImage img $ \p'img -> do c'img <- peek p'img pokeElemOff ptr idx c'img addNextImage rest (idx + 1) ptr in allocaBytes arrSizeBytes $ addNextImage imgs 0 -- | Iconifies (minimizes) the window. -- See iconifyWindow :: Window -> IO () iconifyWindow = c'glfwIconifyWindow . toC -- | Restores the window from an iconified/minimized state. -- See restoreWindow :: Window -> IO () restoreWindow = c'glfwRestoreWindow . toC -- | Brings the specified window to front and sets input focus. The window -- should already be visible and not iconified. -- See focusWindow :: Window -> IO () focusWindow = c'glfwFocusWindow . toC -- | Maximizes the specified window if it was not already maximized. -- See maximizeWindow :: Window -> IO () maximizeWindow = c'glfwMaximizeWindow . toC -- | Shows the window. -- See showWindow :: Window -> IO () showWindow = c'glfwShowWindow . toC -- | Hides the window. -- See hideWindow :: Window -> IO () hideWindow = c'glfwHideWindow . toC -- | Gets the monitor that this window is running on, provided the window is -- fullscreen. -- See getWindowMonitor :: Window -> IO (Maybe Monitor) getWindowMonitor win = do p'mon <- c'glfwGetWindowMonitor (toC win) return $ if p'mon == nullPtr then Nothing else Just $ fromC p'mon -- | Sets the position of the cursor within the window. -- See setCursorPos :: Window -> Double -> Double -> IO () setCursorPos win x y = c'glfwSetCursorPos (toC win) (toC x) (toC y) -- | Makes a window fullscreen on the given monitor. The number of red, green, -- and blue bits is ignored. Note, this shouldn't be used to update the -- resolution of a fullscreen window. Use 'setWindowSize' instead. -- See setFullscreen :: Window -> Monitor -> VideoMode -> IO () setFullscreen win mon (VideoMode width height _ _ _ refresh) = c'glfwSetWindowMonitor (toC win) (toC mon) 0 0 (toC width) (toC height) (toC refresh) -- | Updates a window to be windowed instead of fullscreen. Note, this shouldn't -- be used to update the position or size of a window. Use 'setWindowPos' and -- 'setWindowSize' instead. -- See setWindowed :: Window -> Int -- ^ The width of the client area -> Int -- ^ The height of the client area -> Int -- ^ The x position of the window -> Int -- ^ The y position of the window -> IO () setWindowed win width height x y = c'glfwSetWindowMonitor (toC win) nullPtr (toC x) (toC y) (toC width) (toC height) 0 -- start of functions related to c'glfwGetWindowAttrib -- | If the window has focus or not. -- See getWindowFocused :: Window -> IO Bool getWindowFocused win = fromC `fmap` c'glfwGetWindowAttrib (toC win) c'GLFW_FOCUSED -- | If the window is maximized or not. -- See getWindowMaximized :: Window -> IO Bool getWindowMaximized win = fromC `fmap` c'glfwGetWindowAttrib (toC win) c'GLFW_MAXIMIZED -- | If the window has been set to be 'always on top' or not. -- See getWindowFloating :: Window -> IO Bool getWindowFloating win = fromC `fmap` c'glfwGetWindowAttrib (toC win) c'GLFW_FLOATING -- | If the window is iconified (minimized) or not. -- See getWindowIconified :: Window -> IO Bool getWindowIconified win = fromC `fmap` c'glfwGetWindowAttrib (toC win) c'GLFW_ICONIFIED -- | If the window is resizable or not. -- See getWindowResizable :: Window -> IO Bool getWindowResizable win = fromC `fmap` c'glfwGetWindowAttrib (toC win) c'GLFW_RESIZABLE -- | If the window is decorated or not. -- See getWindowDecorated :: Window -> IO Bool getWindowDecorated win = fromC `fmap` c'glfwGetWindowAttrib (toC win) c'GLFW_DECORATED -- | If the window is visible or not. -- See getWindowVisible :: Window -> IO Bool getWindowVisible win = fromC `fmap` c'glfwGetWindowAttrib (toC win) c'GLFW_VISIBLE -- | The client api for this window. -- See getWindowClientAPI :: Window -> IO ClientAPI getWindowClientAPI win = fromC `fmap` c'glfwGetWindowAttrib (toC win) c'GLFW_CLIENT_API -- | Returns the context creation API used to create the specified window. -- See getWindowContextCreationAPI :: Window -> IO ContextCreationAPI getWindowContextCreationAPI win = fromC `fmap` c'glfwGetWindowAttrib (toC win) c'GLFW_CONTEXT_CREATION_API -- | The context's "major" version, x.0.0 -- See getWindowContextVersionMajor :: Window -> IO Int getWindowContextVersionMajor win = fromC `fmap` c'glfwGetWindowAttrib (toC win) c'GLFW_CONTEXT_VERSION_MAJOR -- | The context's "minor" version, 0.y.0 -- See getWindowContextVersionMinor :: Window -> IO Int getWindowContextVersionMinor win = fromC `fmap` c'glfwGetWindowAttrib (toC win) c'GLFW_CONTEXT_VERSION_MINOR -- | The context's "revision" version, 0.0.z -- See getWindowContextVersionRevision :: Window -> IO Int getWindowContextVersionRevision win = fromC `fmap` c'glfwGetWindowAttrib (toC win) c'GLFW_CONTEXT_REVISION -- | The context robustness of this window. -- See getWindowContextRobustness :: Window -> IO ContextRobustness getWindowContextRobustness win = fromC `fmap` c'glfwGetWindowAttrib (toC win) c'GLFW_CONTEXT_ROBUSTNESS -- | Returns the context release behavior. -- See getWindowContextReleaseBehavior :: Window -> IO ContextReleaseBehavior getWindowContextReleaseBehavior win = fromC `fmap` c'glfwGetWindowAttrib (toC win) c'GLFW_CONTEXT_RELEASE_BEHAVIOR -- | Returns true if the window is set to NO_ERROR (see the -- -- extension. getWindowContextNoError :: Window -> IO Bool getWindowContextNoError win = fromC `fmap` c'glfwGetWindowAttrib (toC win) c'GLFW_CONTEXT_NO_ERROR -- | If this window is set for opengl to be forward compatible. -- See getWindowOpenGLForwardCompat :: Window -> IO Bool getWindowOpenGLForwardCompat win = fromC `fmap` c'glfwGetWindowAttrib (toC win) c'GLFW_OPENGL_FORWARD_COMPAT -- | If the window has an opengl debug context -- See getWindowOpenGLDebugContext :: Window -> IO Bool getWindowOpenGLDebugContext win = fromC `fmap` c'glfwGetWindowAttrib (toC win) c'GLFW_OPENGL_DEBUG_CONTEXT -- | Obtains the current opengl profile. -- See getWindowOpenGLProfile :: Window -> IO OpenGLProfile getWindowOpenGLProfile win = fromC `fmap` c'glfwGetWindowAttrib (toC win) c'GLFW_OPENGL_PROFILE -- end of functions related to c'glfwGetWindowAttrib -- | Sets the callback to use when the window position changes. -- See setWindowPosCallback :: Window -> Maybe WindowPosCallback -> IO () setWindowPosCallback win = setWindowCallback mk'GLFWwindowposfun (\cb a0 a1 a2 -> schedule $ cb (fromC a0) (fromC a1) (fromC a2)) (c'glfwSetWindowPosCallback (toC win)) storedWindowPosFun win -- | Sets the callback to use when the window's size changes. -- See setWindowSizeCallback :: Window -> Maybe WindowSizeCallback -> IO () setWindowSizeCallback win = setWindowCallback mk'GLFWwindowsizefun (\cb a0 a1 a2 -> schedule $ cb (fromC a0) (fromC a1) (fromC a2)) (c'glfwSetWindowSizeCallback (toC win)) storedWindowSizeFun win -- | Sets the callback to use when the user attempts to close the window. -- See setWindowCloseCallback :: Window -> Maybe WindowCloseCallback -> IO () setWindowCloseCallback win = setWindowCallback mk'GLFWwindowclosefun (. fromC) (c'glfwSetWindowCloseCallback (toC win)) storedWindowCloseFun win -- | Sets the callback to use when the window's data is partly dead and it should refresh. -- See setWindowRefreshCallback :: Window -> Maybe WindowRefreshCallback -> IO () setWindowRefreshCallback win = setWindowCallback mk'GLFWwindowrefreshfun (. fromC) (c'glfwSetWindowRefreshCallback (toC win)) storedWindowRefreshFun win -- | Sets the callback to use when the window gains or loses focus. -- See setWindowFocusCallback :: Window -> Maybe WindowFocusCallback -> IO () setWindowFocusCallback win = setWindowCallback mk'GLFWwindowfocusfun (\cb a0 a1 -> schedule $ cb (fromC a0) (fromC a1)) (c'glfwSetWindowFocusCallback (toC win)) storedWindowFocusFun win -- | Sets the callback to use when the window is iconified or not (aka, minimized or not). -- See setWindowIconifyCallback :: Window -> Maybe WindowIconifyCallback -> IO () setWindowIconifyCallback win = setWindowCallback mk'GLFWwindowiconifyfun (\cb a0 a1 -> schedule $ cb (fromC a0) (fromC a1)) (c'glfwSetWindowIconifyCallback (toC win)) storedWindowIconifyFun win -- | Sets the callback to use when the framebuffer's size changes. -- See setFramebufferSizeCallback :: Window -> Maybe FramebufferSizeCallback -> IO () setFramebufferSizeCallback win = setWindowCallback mk'GLFWframebuffersizefun (\cb a0 a1 a2 -> schedule $ cb (fromC a0) (fromC a1) (fromC a2)) (c'glfwSetFramebufferSizeCallback (toC win)) storedFramebufferSizeFun win -- | Checks for any pending events, processes them, and then immediately returns. -- This is most useful for continual rendering, such as games. -- See the . This -- function is not . pollEvents :: IO () pollEvents = c'glfwPollEvents >> executeScheduled -- | Waits until at least one event is in the queue then processes the queue and returns. -- Requires at least one window to be active for it to sleep. This saves a lot of CPU, and -- is better if you're doing only periodic rendering, such as with an editor program. -- See the . This -- function is not . waitEvents :: IO () waitEvents = c'glfwWaitEvents >> executeScheduled -- | Same as 'waitEvents', with a timeout after which the function returns. -- See the . This -- function is not . waitEventsTimeout :: Double -> IO () waitEventsTimeout seconds = c'glfwWaitEventsTimeout (toC seconds) >> executeScheduled -- | Creates an empty event within the event queue. Can be called from any -- thread, so you can use this to wake up the main thread that's using -- 'waitEvents' from a secondary thread. -- See the postEmptyEvent :: IO () postEmptyEvent = c'glfwPostEmptyEvent -------------------------------------------------------------------------------- -- Input handling -- start of glfw{GS}etInputMode-related functions -- | Gets the current cursor input mode. -- See getCursorInputMode :: Window -> IO CursorInputMode getCursorInputMode win = fromC `fmap` c'glfwGetInputMode (toC win) c'GLFW_CURSOR -- | Set the cursor input mode. -- See setCursorInputMode :: Window -> CursorInputMode -> IO () setCursorInputMode win c = c'glfwSetInputMode (toC win) c'GLFW_CURSOR (toC c) -- | Gets the current sticky keys mode. -- See getStickyKeysInputMode :: Window -> IO StickyKeysInputMode getStickyKeysInputMode win = fromC `fmap` c'glfwGetInputMode (toC win) c'GLFW_STICKY_KEYS -- | Sets if sticky keys should be used or not. -- See setStickyKeysInputMode :: Window -> StickyKeysInputMode -> IO () setStickyKeysInputMode win sk = c'glfwSetInputMode (toC win) c'GLFW_STICKY_KEYS (toC sk) -- | Gets if sticky mouse buttons are on or not. -- See getStickyMouseButtonsInputMode :: Window -> IO StickyMouseButtonsInputMode getStickyMouseButtonsInputMode win = fromC `fmap` c'glfwGetInputMode (toC win) c'GLFW_STICKY_MOUSE_BUTTONS -- | Sets if sticky mouse buttons should be used or not. -- See setStickyMouseButtonsInputMode :: Window -> StickyMouseButtonsInputMode -> IO () setStickyMouseButtonsInputMode win smb = c'glfwSetInputMode (toC win) c'GLFW_STICKY_MOUSE_BUTTONS (toC smb) -- end of glfw{GS}etInputMode-related functions -- | Gets the state of the specified key. If Stickey Keys isn't enabled then it's possible for -- keyboard polling to miss individual key presses. Use the callback to avoid this. -- See getKey :: Window -> Key -> IO KeyState getKey win k = fromC `fmap` c'glfwGetKey (toC win) (toC k) -- | Returns the localized name of the specified printable key. This is intended -- for displaying key bindings to the user. The scancode is used if the provided -- 'Key' isn't printable. If the scancode maps to a non-printable key as well, -- then 'Nothing' is returned. -- See getKeyName :: Key -> Int -> IO (Maybe String) getKeyName k scancode = do cstr <- c'glfwGetKeyName (toC k) (toC scancode) if cstr == nullPtr then return Nothing else Just `fmap` peekCString cstr -- | Gets the state of a single specified mouse button. If sticky mouse button -- mode isn't enabled it's possible for mouse polling to miss individual mouse events. Use -- the call back to avoid this. -- See getMouseButton :: Window -> MouseButton -> IO MouseButtonState getMouseButton win b = fromC `fmap` c'glfwGetMouseButton (toC win) (toC b) -- | Returns the position, in screen coodinates, relative to the upper left. -- If the 'CursorInputMode' is "disabled", then results are unbounded by the window size. -- See getCursorPos :: Window -> IO (Double, Double) getCursorPos win = allocaArray 2 $ \p -> do let p'x = p p'y = p `advancePtr` 1 c'glfwGetCursorPos (toC win) p'x p'y x <- fromC `fmap` peek p'x y <- fromC `fmap` peek p'y return (x, y) -- | Assigns the given callback to use for all keyboard presses and repeats. -- See setKeyCallback :: Window -> Maybe KeyCallback -> IO () setKeyCallback win = setWindowCallback mk'GLFWkeyfun (\cb a0 a1 a2 a3 a4 -> schedule $ cb (fromC a0) (fromC a1) (fromC a2) (fromC a3) (fromC a4)) (c'glfwSetKeyCallback (toC win)) storedKeyFun win -- | Sets the callback to use when the user types a character -- See setCharCallback :: Window -> Maybe CharCallback -> IO () setCharCallback win = setWindowCallback mk'GLFWcharfun (\cb a0 a1 -> schedule $ cb (fromC a0) (fromC a1)) (c'glfwSetCharCallback (toC win)) storedCharFun win -- | Sets the callback to use with Unicode characters regardless of what -- modifier keys are used. -- See setCharModsCallback :: Window -> Maybe CharModsCallback -> IO () setCharModsCallback win = setWindowCallback mk'GLFWcharmodsfun (\cb a0 a1 a2 -> schedule $ cb (fromC a0) (fromC a1) (fromC a2)) (c'glfwSetCharModsCallback (toC win)) storedCharModsFun win -- | Assigns the callback to run whenver a mouse button is clicked. -- See setMouseButtonCallback :: Window -> Maybe MouseButtonCallback -> IO () setMouseButtonCallback win = setWindowCallback mk'GLFWmousebuttonfun (\cb a0 a1 a2 a3 -> schedule $ cb (fromC a0) (fromC a1) (fromC a2) (fromC a3)) (c'glfwSetMouseButtonCallback (toC win)) storedMouseButtonFun win -- | Assigns the callback to run whenver the cursor position changes. -- See setCursorPosCallback :: Window -> Maybe CursorPosCallback -> IO () setCursorPosCallback win = setWindowCallback mk'GLFWcursorposfun (\cb a0 a1 a2 -> schedule $ cb (fromC a0) (fromC a1) (fromC a2)) (c'glfwSetCursorPosCallback (toC win)) storedCursorPosFun win -- | Sets the callback for when the cursor enters or leaves the client area. -- See setCursorEnterCallback :: Window -> Maybe CursorEnterCallback -> IO () setCursorEnterCallback win = setWindowCallback mk'GLFWcursorenterfun (\cb a0 a1 -> schedule $ cb (fromC a0) (fromC a1)) (c'glfwSetCursorEnterCallback (toC win)) storedCursorEnterFun win -- | Sets the callback to run when the user scrolls with the mouse wheel or a touch gesture. -- See setScrollCallback :: Window -> Maybe ScrollCallback -> IO () setScrollCallback win = setWindowCallback mk'GLFWscrollfun (\cb a0 a1 a2 -> schedule $ cb (fromC a0) (fromC a1) (fromC a2)) (c'glfwSetScrollCallback (toC win)) storedScrollFun win -- | Tests if the joystick is present at all -- See joystickPresent :: Joystick -> IO Bool joystickPresent js = fromC `fmap` c'glfwJoystickPresent (toC js) -- | Returns the values of all axes of the specified joystick, normalized to between -1.0 and 1.0 -- See getJoystickAxes :: Joystick -> IO (Maybe [Double]) getJoystickAxes js = alloca $ \p'n -> do p'axes <- c'glfwGetJoystickAxes (toC js) p'n n <- fromC `fmap` peek p'n if p'axes == nullPtr || n <= 0 then return Nothing else (Just . map fromC) `fmap` peekArray n p'axes -- | Returns a list of all joystick button states for the specified joystick. -- See getJoystickButtons :: Joystick -> IO (Maybe [JoystickButtonState]) getJoystickButtons js = alloca $ \p'n -> do p'buttons <- c'glfwGetJoystickButtons (toC js) p'n n <- fromC `fmap` peek p'n if p'buttons == nullPtr || n <= 0 then return Nothing else (Just . map fromC) `fmap` peekArray n p'buttons -- | A human-readable name for a Joystick. Not guranteed to be unique. -- See getJoystickName :: Joystick -> IO (Maybe String) getJoystickName js = do p'name <- c'glfwGetJoystickName (toC js) if p'name == nullPtr then return Nothing else Just `fmap` peekCString p'name -- | Sets a callback for when a joystick is connected or disconnected. -- See setJoystickCallback :: Maybe JoystickCallback -> IO () setJoystickCallback = setCallback mk'GLFWjoystickfun (\cb a0 a1 -> schedule $ cb (fromC a0) (fromC a1)) c'glfwSetJoystickCallback storedJoystickFun -------------------------------------------------------------------------------- -- Time -- | Returns the time (in seconds) of the GLFW timer. -- This is the amount of time since GLFW was initialized, unless 'setTime' was used. -- The exact resolution is system dependent. -- See getTime :: IO (Maybe Double) getTime = do t <- fromC `fmap` c'glfwGetTime return $ if t == 0 then Nothing else Just t -- | Sets the GLFW timer to the specified value, which is measured in seconds, and must be positive. -- The value must also be less than ~584 years in seconds (18446744073.0). -- After this the timer begins to count upward at the normal rate. -- See setTime :: Double -> IO () setTime = c'glfwSetTime . toC -- | Returns the current value of the raw timer, measured in 1 / frequency -- seconds. The frequency can be queried using getTimerFrequency. -- See getTimerValue :: IO Word64 getTimerValue = c'glfwGetTimerValue -- | Returns the frequency, in Hz, of the raw timer. -- See getTimerFrequency :: IO Word64 getTimerFrequency = c'glfwGetTimerFrequency -------------------------------------------------------------------------------- -- Context -- | Makes the context of the specified window the current one for the calling thread. -- A context can only be made current on a single thread at a time, -- and each thread can have only a single current context at a time. -- See makeContextCurrent :: Maybe Window -> IO () makeContextCurrent = c'glfwMakeContextCurrent . maybe nullPtr toC -- | Obtains which window owns the current context of the calling thread. -- See getCurrentContext :: IO (Maybe Window) getCurrentContext = do p'win <- c'glfwGetCurrentContext return $ if p'win == nullPtr then Nothing else Just $ fromC p'win -- | Swaps the front and back buffers of the window. -- See swapBuffers :: Window -> IO () swapBuffers = c'glfwSwapBuffers . toC -- | Sets the number of screen updates that the GPU should wait after 'swapBuffers' before actually swapping the buffers. -- Generates 'Error'NoCurrentContext' if no context is current. -- See swapInterval :: Int -> IO () swapInterval = c'glfwSwapInterval . toC -- | If the current OpenGL or OpenGL ES context supports the extension specified. -- Generates 'Error'NoCurrentContext' if no context is current. -- See extensionSupported :: String -> IO Bool extensionSupported ext = withCString ext $ \p'ext -> fromC `fmap` c'glfwExtensionSupported p'ext -------------------------------------------------------------------------------- -- Clipboard -- http://www.glfw.org/docs/3.2/input.html#clipboard -- | The window that will own the clipboard contents, and also the clipboard string. -- See setClipboardString :: Window -> String -> IO () setClipboardString win s = withCString s (c'glfwSetClipboardString (toC win)) -- | Obtains the contents of the system keyboard, if possible. -- Generates 'Error'FormatUnavailable' if the system clipboard is empty or if it's not a UTF-8 string. -- See getClipboardString :: Window -> IO (Maybe String) getClipboardString win = do p's <- c'glfwGetClipboardString (toC win) if p's == nullPtr then return Nothing else Just `fmap` peekCString p's -------------------------------------------------------------------------------- -- 3.1 additions (http://www.glfw.org/docs/3.1/news.html#news_31) -------------------------------------------------------------------------------- -- Cursor Objects -- http://www.glfw.org/docs/3.2/input.html#cursor_object -- | Creates a new cursor. createCursor :: Image -- ^ The desired cursor image. -> Int -- ^ The desired x-coordinate, in pixels, of the cursor -- hotspot. -> Int -- ^ The desired y-coordinate, in pixels, of the cursor -- hotspot. -> IO Cursor createCursor img x y = withGLFWImage img $ \p'img -> Cursor `fmap` c'glfwCreateCursor p'img (toC x) (toC y) -- | Creates a cursor with a standard shape that can be set for a window with -- setCursor. createStandardCursor :: StandardCursorShape -> IO Cursor createStandardCursor = (fmap Cursor) . c'glfwCreateStandardCursor . toC -- | Sets the cursor image to be used when the cursor is over the client area -- of the specified window. The set cursor will only be visible when the cursor -- mode of the window is GLFW_CURSOR_NORMAL. -- On some platforms, the set cursor may not be visible unless the window also -- has input focus. setCursor :: Window -> Cursor -> IO () setCursor (Window wptr) (Cursor cptr) = c'glfwSetCursor wptr cptr -- | Destroys a cursor previously created with `createCursor`. Any remaining -- cursors will be destroyed by `terminate`. This function is not -- . destroyCursor :: Cursor -> IO () destroyCursor = c'glfwDestroyCursor . unCursor -- | A callback that allows for drag and drop support. type DropCallback = Window -- ^ The window that received the event. -> [String] -- ^ The file and/or directory path names -> IO () -- | Sets the file drop callback of the specified window, which is called when -- one or more dragged files are dropped on the window. setDropCallback :: Window -> Maybe DropCallback -> IO () setDropCallback win = setWindowCallback mk'GLFWdropfun (\cb w c fs -> do let count = fromC c fps <- flip mapM [0..count-1] $ \i -> do let p = advancePtr fs i p' <- peek p peekCString p' schedule $ cb (fromC w) fps) (c'glfwSetDropCallback (toC win)) storedDropFun win -------------------------------------------------------------------------------- -- Vulkan-related functions -------------------------------------------------------------------------------- -- | This function returns whether the Vulkan loader has been found. -- This check is performed by `init`. vulkanSupported :: IO Bool vulkanSupported = (c'GLFW_TRUE ==) <$> c'glfwVulkanSupported -- | Get required vulkan extensions; -- Pointer memory is managed by GLFW, destroyed by `terminate` call. -- -- The returned extension names are kept in `CString` type, because -- they are expected to be consumed by vulkan device initialization functions. getRequiredInstanceExtensions :: IO [CString] getRequiredInstanceExtensions = alloca $ \countPtr -> do extsPtrPtr <- c'glfwGetRequiredInstanceExtensions countPtr count <- fromIntegral <$> peek countPtr peekArray count extsPtrPtr -- | Returns the address of the specified Vulkan instance function. getInstanceProcAddress :: Ptr vkInstance -- ^ VkInstance. -- Note, the returned function must be used -- with the same instance or its child. -> String -- ^ Function name -> IO (FunPtr vkProc) getInstanceProcAddress i procName = withCString procName (c'glfwGetInstanceProcAddress i) -- | Returns whether the specified queue family can present images. getPhysicalDevicePresentationSupport :: Ptr vkInstance -- ^ VkInstance -> Ptr vkPhysicalDevice -- ^ VkPhysicalDevice -> Word32 -- ^ Index of a queue family to query. -- This is an index in the array returned by -- @vkGetPhysicalDeviceQueueFamilyProperties@ function. -> IO Bool getPhysicalDevicePresentationSupport inst dev i = (c'GLFW_TRUE ==) <$> c'glfwGetPhysicalDevicePresentationSupport inst dev i -- | Creates a Vulkan surface for the specified window createWindowSurface :: Enum vkResult => Ptr vkInstance -- ^ VkInstance -> Window -- ^ GLFWwindow *window -> Ptr vkAllocationCallbacks -- ^ const VkAllocationCallbacks *allocator -> Ptr vkSurfaceKHR -- ^ VkSurfaceKHR *surface -> IO vkResult createWindowSurface i win acs s = toEnum . fromIntegral <$> c'glfwCreateWindowSurface i (toC win) acs s -------------------------------------------------------------------------------- -- Native APIs -------------------------------------------------------------------------------- -- $nativeaccess -- The low level native-access bindings are exposed here via bindings-GLFW. -- These must be enabled with the 'ExposeNative' flag passed to bindings-GLFW. -- The return values of these functions are used as a best-guess and are not -- coupled with any other implementation. They should be used with caution -- and at your own risk. -- | See getWin32Adapter :: Window -> IO CString getWin32Adapter = c'glfwGetWin32Adapter . toC -- | See getWin32Monitor :: Window -> IO CString getWin32Monitor = c'glfwGetWin32Monitor . toC -- | See getWin32Window :: Window -> IO (Ptr ()) getWin32Window = c'glfwGetWin32Window . toC -- | See getWGLContext :: Window -> IO (Ptr ()) getWGLContext = c'glfwGetWGLContext . toC -- | See getCocoaMonitor :: Window -> IO (Ptr Word32) getCocoaMonitor = c'glfwGetCocoaMonitor . toC -- | See getCocoaWindow :: Window -> IO (Ptr ()) getCocoaWindow = c'glfwGetCocoaWindow . toC -- | See getNSGLContext :: Window -> IO (Ptr ()) getNSGLContext = c'glfwGetNSGLContext . toC -- | See getX11Display :: Window -> IO (Ptr display) getX11Display = c'glfwGetX11Display . toC -- | See getX11Adapter :: Window -> IO Word64 getX11Adapter = c'glfwGetX11Adapter . toC -- | See getX11Monitor :: Window -> IO Word64 getX11Monitor = c'glfwGetX11Monitor . toC -- | See getX11Window :: Window -> IO Word64 getX11Window = c'glfwGetX11Window . toC -- | See getGLXContext :: Window -> IO (Ptr ()) getGLXContext = c'glfwGetGLXContext . toC -- | See getGLXWindow :: Window -> IO Word64 getGLXWindow = c'glfwGetGLXWindow . toC -- | See getWaylandDisplay :: IO (Ptr wl_display) getWaylandDisplay = c'glfwGetWaylandDisplay -- | See getWaylandMonitor :: Window -> IO (Ptr wl_output) getWaylandMonitor = c'glfwGetWaylandMonitor . toC -- | See getWaylandWindow :: Window -> IO (Ptr wl_surface) getWaylandWindow = c'glfwGetWaylandWindow . toC -- | See getMirDisplay :: IO (Ptr mir_connection) getMirDisplay = c'glfwGetMirDisplay -- | See getMirMonitor :: Window -> IO Int getMirMonitor = (fmap fromC) . c'glfwGetMirMonitor . toC -- | See getMirWindow :: Window -> IO (Ptr mir_surface) getMirWindow = c'glfwGetMirWindow . toC -- | See getEGLDisplay :: IO (Ptr ()) getEGLDisplay = c'glfwGetEGLDisplay -- | See getEGLContext :: Window -> IO (Ptr ()) getEGLContext = c'glfwGetEGLContext . toC -- | See getEGLSurface :: Window -> IO (Ptr ()) getEGLSurface = c'glfwGetEGLSurface . toC