<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> <html> <head> <!-- Generated by HsColour, http://www.cs.york.ac.uk/fp/darcs/hscolour/ --> <title>Graphics/UI/GLUT/Callbacks/Global.hs</title> <link type='text/css' rel='stylesheet' href='hscolour.css' /> </head> <body> <pre><a name="line-1"></a><span class='hs-comment'>--------------------------------------------------------------------------------</span> <a name="line-2"></a><span class='hs-comment'>-- |</span> <a name="line-3"></a><span class='hs-comment'>-- Module : Graphics.UI.GLUT.Callbacks.Global</span> <a name="line-4"></a><span class='hs-comment'>-- Copyright : (c) Sven Panne 2002-2005</span> <a name="line-5"></a><span class='hs-comment'>-- License : BSD-style (see the file libraries/GLUT/LICENSE)</span> <a name="line-6"></a><span class='hs-comment'>--</span> <a name="line-7"></a><span class='hs-comment'>-- Maintainer : sven.panne@aedion.de</span> <a name="line-8"></a><span class='hs-comment'>-- Stability : stable</span> <a name="line-9"></a><span class='hs-comment'>-- Portability : portable</span> <a name="line-10"></a><span class='hs-comment'>--</span> <a name="line-11"></a><span class='hs-comment'>--------------------------------------------------------------------------------</span> <a name="line-12"></a> <a name="line-13"></a><span class='hs-keyword'>module</span> <span class='hs-conid'>Graphics</span><span class='hs-varop'>.</span><span class='hs-conid'>UI</span><span class='hs-varop'>.</span><span class='hs-conid'>GLUT</span><span class='hs-varop'>.</span><span class='hs-conid'>Callbacks</span><span class='hs-varop'>.</span><span class='hs-conid'>Global</span> <span class='hs-layout'>(</span> <a name="line-14"></a> <span class='hs-comment'>-- * Menu status callback</span> <a name="line-15"></a> <span class='hs-conid'>MenuUsage</span><span class='hs-layout'>(</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>)</span><span class='hs-layout'>,</span> <span class='hs-conid'>MenuStatusCallback</span><span class='hs-layout'>,</span> <span class='hs-varid'>menuStatusCallback</span><span class='hs-layout'>,</span> <a name="line-16"></a> <a name="line-17"></a> <span class='hs-comment'>-- * Idle callback</span> <a name="line-18"></a> <span class='hs-conid'>IdleCallback</span><span class='hs-layout'>,</span> <span class='hs-varid'>idleCallback</span><span class='hs-layout'>,</span> <a name="line-19"></a> <a name="line-20"></a> <span class='hs-comment'>-- * Timer callbacks</span> <a name="line-21"></a> <span class='hs-conid'>Timeout</span><span class='hs-layout'>,</span> <span class='hs-conid'>TimerCallback</span><span class='hs-layout'>,</span> <span class='hs-varid'>addTimerCallback</span> <a name="line-22"></a><span class='hs-layout'>)</span> <span class='hs-keyword'>where</span> <a name="line-23"></a> <a name="line-24"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Control</span><span class='hs-varop'>.</span><span class='hs-conid'>Monad</span><span class='hs-varop'>.</span><span class='hs-conid'>Fix</span> <span class='hs-layout'>(</span> <span class='hs-conid'>MonadFix</span><span class='hs-layout'>(</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>)</span> <span class='hs-layout'>)</span> <a name="line-25"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Foreign</span><span class='hs-varop'>.</span><span class='hs-conid'>C</span><span class='hs-varop'>.</span><span class='hs-conid'>Types</span> <span class='hs-layout'>(</span> <span class='hs-conid'>CInt</span><span class='hs-layout'>,</span> <span class='hs-conid'>CUInt</span> <span class='hs-layout'>)</span> <a name="line-26"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Foreign</span><span class='hs-varop'>.</span><span class='hs-conid'>Ptr</span> <span class='hs-layout'>(</span> <span class='hs-conid'>FunPtr</span> <span class='hs-layout'>)</span> <a name="line-27"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Graphics</span><span class='hs-varop'>.</span><span class='hs-conid'>Rendering</span><span class='hs-varop'>.</span><span class='hs-conid'>OpenGL</span><span class='hs-varop'>.</span><span class='hs-conid'>GL</span><span class='hs-varop'>.</span><span class='hs-conid'>CoordTrans</span> <span class='hs-layout'>(</span> <span class='hs-conid'>Position</span><span class='hs-layout'>(</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>)</span> <span class='hs-layout'>)</span> <a name="line-28"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Graphics</span><span class='hs-varop'>.</span><span class='hs-conid'>Rendering</span><span class='hs-varop'>.</span><span class='hs-conid'>OpenGL</span><span class='hs-varop'>.</span><span class='hs-conid'>GL</span><span class='hs-varop'>.</span><span class='hs-conid'>StateVar</span> <span class='hs-layout'>(</span> <a name="line-29"></a> <span class='hs-conid'>SettableStateVar</span><span class='hs-layout'>,</span> <span class='hs-varid'>makeSettableStateVar</span> <span class='hs-layout'>)</span> <a name="line-30"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Graphics</span><span class='hs-varop'>.</span><span class='hs-conid'>UI</span><span class='hs-varop'>.</span><span class='hs-conid'>GLUT</span><span class='hs-varop'>.</span><span class='hs-conid'>Constants</span> <span class='hs-layout'>(</span> <span class='hs-varid'>glut_MENU_NOT_IN_USE</span><span class='hs-layout'>,</span> <span class='hs-varid'>glut_MENU_IN_USE</span> <span class='hs-layout'>)</span> <a name="line-31"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Graphics</span><span class='hs-varop'>.</span><span class='hs-conid'>UI</span><span class='hs-varop'>.</span><span class='hs-conid'>GLUT</span><span class='hs-varop'>.</span><span class='hs-conid'>Callbacks</span><span class='hs-varop'>.</span><span class='hs-conid'>Registration</span> <span class='hs-layout'>(</span> <a name="line-32"></a> <span class='hs-conid'>CallbackType</span><span class='hs-layout'>(</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>)</span><span class='hs-layout'>,</span> <span class='hs-varid'>setCallback</span><span class='hs-layout'>,</span> <span class='hs-varid'>registerForCleanup</span> <span class='hs-layout'>)</span> <a name="line-33"></a> <a name="line-34"></a><span class='hs-comment'>--------------------------------------------------------------------------------</span> <a name="line-35"></a> <a name="line-36"></a><a name="MenuUsage"></a><span class='hs-keyword'>data</span> <span class='hs-conid'>MenuUsage</span> <a name="line-37"></a> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>NotInUse</span> <a name="line-38"></a> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>InUse</span> <a name="line-39"></a> <span class='hs-keyword'>deriving</span> <span class='hs-layout'>(</span> <span class='hs-conid'>Eq</span><span class='hs-layout'>,</span> <span class='hs-conid'>Ord</span><span class='hs-layout'>,</span> <span class='hs-conid'>Show</span> <span class='hs-layout'>)</span> <a name="line-40"></a> <a name="line-41"></a><a name="unmarshalMenuUsage"></a><span class='hs-definition'>unmarshalMenuUsage</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>CInt</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>MenuUsage</span> <a name="line-42"></a><span class='hs-definition'>unmarshalMenuUsage</span> <span class='hs-varid'>x</span> <a name="line-43"></a> <span class='hs-keyglyph'>|</span> <span class='hs-varid'>x</span> <span class='hs-varop'>==</span> <span class='hs-varid'>glut_MENU_NOT_IN_USE</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>NotInUse</span> <a name="line-44"></a> <span class='hs-keyglyph'>|</span> <span class='hs-varid'>x</span> <span class='hs-varop'>==</span> <span class='hs-varid'>glut_MENU_IN_USE</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>InUse</span> <a name="line-45"></a> <span class='hs-keyglyph'>|</span> <span class='hs-varid'>otherwise</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>error</span> <span class='hs-layout'>(</span><span class='hs-str'>"unmarshalMenuUsage: illegal value "</span> <span class='hs-varop'>++</span> <span class='hs-varid'>show</span> <span class='hs-varid'>x</span><span class='hs-layout'>)</span> <a name="line-46"></a> <a name="line-47"></a><a name="MenuStatusCallback"></a><span class='hs-keyword'>type</span> <span class='hs-conid'>MenuStatusCallback</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>MenuUsage</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Position</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>()</span> <a name="line-48"></a> <a name="line-49"></a><a name="MenuStatusCallback'"></a><span class='hs-keyword'>type</span> <span class='hs-conid'>MenuStatusCallback'</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>CInt</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>CInt</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>CInt</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>()</span> <a name="line-50"></a> <a name="line-51"></a><span class='hs-comment'>-- | Controls the global menu status callback so a GLUT program can determine</span> <a name="line-52"></a><span class='hs-comment'>-- when a menu is in use or not. When a menu status callback is registered, it</span> <a name="line-53"></a><span class='hs-comment'>-- will be called with the value 'InUse' when pop-up menus are in use by the</span> <a name="line-54"></a><span class='hs-comment'>-- user; and the callback will be called with the value 'NotInUse' when pop-up</span> <a name="line-55"></a><span class='hs-comment'>-- menus are no longer in use. Additionally, the location in window coordinates</span> <a name="line-56"></a><span class='hs-comment'>-- of the button press that caused the menu to go into use, or the location where</span> <a name="line-57"></a><span class='hs-comment'>-- the menu was released (maybe outside the window). Other callbacks continue to</span> <a name="line-58"></a><span class='hs-comment'>-- operate (except mouse motion callbacks) when pop-up menus are in use so the</span> <a name="line-59"></a><span class='hs-comment'>-- menu status callback allows a program to suspend animation or other tasks</span> <a name="line-60"></a><span class='hs-comment'>-- when menus are in use. The cascading and unmapping of sub-menus from an</span> <a name="line-61"></a><span class='hs-comment'>-- initial pop-up menu does not generate menu status callbacks. There is a</span> <a name="line-62"></a><span class='hs-comment'>-- single menu status callback for GLUT.</span> <a name="line-63"></a><span class='hs-comment'>--</span> <a name="line-64"></a><span class='hs-comment'>-- When the menu status callback is called, the /current menu/ will be set to</span> <a name="line-65"></a><span class='hs-comment'>-- the initial pop-up menu in both the 'InUse' and 'NotInUse' cases. The</span> <a name="line-66"></a><span class='hs-comment'>-- /current window/ will be set to the window from which the initial menu was</span> <a name="line-67"></a><span class='hs-comment'>-- popped up from, also in both cases.</span> <a name="line-68"></a> <a name="line-69"></a><a name="menuStatusCallback"></a><span class='hs-definition'>menuStatusCallback</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>SettableStateVar</span> <span class='hs-layout'>(</span><span class='hs-conid'>Maybe</span> <span class='hs-conid'>MenuStatusCallback</span><span class='hs-layout'>)</span> <a name="line-70"></a><span class='hs-definition'>menuStatusCallback</span> <span class='hs-keyglyph'>=</span> <a name="line-71"></a> <span class='hs-varid'>makeSettableStateVar</span> <span class='hs-varop'>$</span> <a name="line-72"></a> <span class='hs-varid'>setCallback</span> <span class='hs-conid'>MenuStatusCB</span> <span class='hs-varid'>glutMenuStatusFunc</span> <a name="line-73"></a> <span class='hs-layout'>(</span><span class='hs-varid'>makeMenuStatusCallback</span> <span class='hs-varop'>.</span> <span class='hs-varid'>unmarshal</span><span class='hs-layout'>)</span> <a name="line-74"></a> <span class='hs-keyword'>where</span> <span class='hs-varid'>unmarshal</span> <span class='hs-varid'>cb</span> <span class='hs-varid'>s</span> <span class='hs-varid'>x</span> <span class='hs-varid'>y</span> <span class='hs-keyglyph'>=</span> <a name="line-75"></a> <span class='hs-varid'>cb</span> <span class='hs-layout'>(</span><span class='hs-varid'>unmarshalMenuUsage</span> <span class='hs-varid'>s</span><span class='hs-layout'>)</span> <a name="line-76"></a> <span class='hs-layout'>(</span><span class='hs-conid'>Position</span> <span class='hs-layout'>(</span><span class='hs-varid'>fromIntegral</span> <span class='hs-varid'>x</span><span class='hs-layout'>)</span> <span class='hs-layout'>(</span><span class='hs-varid'>fromIntegral</span> <span class='hs-varid'>y</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span> <a name="line-77"></a> <a name="line-78"></a><span class='hs-keyword'>foreign</span> <span class='hs-keyword'>import</span> <span class='hs-keyword'>ccall</span> <span class='hs-str'>"wrapper"</span> <span class='hs-varid'>makeMenuStatusCallback</span> <span class='hs-keyglyph'>::</span> <a name="line-79"></a> <span class='hs-conid'>MenuStatusCallback'</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-layout'>(</span><span class='hs-conid'>FunPtr</span> <span class='hs-conid'>MenuStatusCallback'</span><span class='hs-layout'>)</span> <a name="line-80"></a> <a name="line-81"></a><span class='hs-keyword'>foreign</span> <span class='hs-keyword'>import</span> <span class='hs-conid'>CALLCONV</span> <span class='hs-keyword'>unsafe</span> <span class='hs-str'>"glutMenuStatusFunc"</span> <span class='hs-varid'>glutMenuStatusFunc</span> <span class='hs-keyglyph'>::</span> <a name="line-82"></a> <span class='hs-conid'>FunPtr</span> <span class='hs-conid'>MenuStatusCallback'</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>()</span> <a name="line-83"></a> <a name="line-84"></a><span class='hs-comment'>--------------------------------------------------------------------------------</span> <a name="line-85"></a> <a name="line-86"></a><a name="IdleCallback"></a><span class='hs-keyword'>type</span> <span class='hs-conid'>IdleCallback</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>IO</span> <span class='hs-conid'>()</span> <a name="line-87"></a> <a name="line-88"></a><span class='hs-comment'>-- | Controls the global idle callback so a GLUT program can perform background</span> <a name="line-89"></a><span class='hs-comment'>-- processing tasks or continuous animation when window system events are not</span> <a name="line-90"></a><span class='hs-comment'>-- being received. If enabled, the idle callback is continuously called when</span> <a name="line-91"></a><span class='hs-comment'>-- events are not being received. The /current window/ and /current menu/ will</span> <a name="line-92"></a><span class='hs-comment'>-- not be changed before the idle callback. Programs with multiple windows</span> <a name="line-93"></a><span class='hs-comment'>-- and\/or menus should explicitly set the /current window/ and\/or /current</span> <a name="line-94"></a><span class='hs-comment'>-- menu/ and not rely on its current setting.</span> <a name="line-95"></a><span class='hs-comment'>--</span> <a name="line-96"></a><span class='hs-comment'>-- The amount of computation and rendering done in an idle callback should be</span> <a name="line-97"></a><span class='hs-comment'>-- minimized to avoid affecting the program\'s interactive response. In general,</span> <a name="line-98"></a><span class='hs-comment'>-- not more than a single frame of rendering should be done in an idle callback.</span> <a name="line-99"></a> <a name="line-100"></a><a name="idleCallback"></a><span class='hs-definition'>idleCallback</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>SettableStateVar</span> <span class='hs-layout'>(</span><span class='hs-conid'>Maybe</span> <span class='hs-conid'>IdleCallback</span><span class='hs-layout'>)</span> <a name="line-101"></a><span class='hs-definition'>idleCallback</span> <span class='hs-keyglyph'>=</span> <a name="line-102"></a> <span class='hs-varid'>makeSettableStateVar</span> <span class='hs-varop'>$</span> <span class='hs-varid'>setCallback</span> <span class='hs-conid'>IdleCB</span> <span class='hs-varid'>glutIdleFunc</span> <span class='hs-varid'>makeIdleCallback</span> <a name="line-103"></a> <a name="line-104"></a><span class='hs-keyword'>foreign</span> <span class='hs-keyword'>import</span> <span class='hs-keyword'>ccall</span> <span class='hs-str'>"wrapper"</span> <span class='hs-varid'>makeIdleCallback</span> <span class='hs-keyglyph'>::</span> <a name="line-105"></a> <span class='hs-conid'>IdleCallback</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-layout'>(</span><span class='hs-conid'>FunPtr</span> <span class='hs-conid'>IdleCallback</span><span class='hs-layout'>)</span> <a name="line-106"></a> <a name="line-107"></a><span class='hs-keyword'>foreign</span> <span class='hs-keyword'>import</span> <span class='hs-conid'>CALLCONV</span> <span class='hs-keyword'>unsafe</span> <span class='hs-str'>"glutIdleFunc"</span> <span class='hs-varid'>glutIdleFunc</span> <span class='hs-keyglyph'>::</span> <a name="line-108"></a> <span class='hs-conid'>FunPtr</span> <span class='hs-conid'>IdleCallback</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>()</span> <a name="line-109"></a> <a name="line-110"></a><span class='hs-comment'>--------------------------------------------------------------------------------</span> <a name="line-111"></a> <a name="line-112"></a><a name="Timeout"></a><span class='hs-comment'>-- | Timeout for the timer callback in milliseconds</span> <a name="line-113"></a><a name="Timeout"></a><span class='hs-keyword'>type</span> <span class='hs-conid'>Timeout</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>Int</span> <a name="line-114"></a> <a name="line-115"></a><a name="TimerCallback"></a><span class='hs-keyword'>type</span> <span class='hs-conid'>TimerCallback</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>IO</span> <span class='hs-conid'>()</span> <a name="line-116"></a> <a name="line-117"></a><a name="TimerCallback'"></a><span class='hs-keyword'>type</span> <span class='hs-conid'>TimerCallback'</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>CInt</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>()</span> <a name="line-118"></a> <a name="line-119"></a><span class='hs-comment'>-- | Register a one-shot timer callback to be triggered after at least the given</span> <a name="line-120"></a><span class='hs-comment'>-- amount of time. Multiple timer callbacks at same or differing times may be</span> <a name="line-121"></a><span class='hs-comment'>-- registered simultaneously. There is no support for canceling a registered</span> <a name="line-122"></a><span class='hs-comment'>-- callback.</span> <a name="line-123"></a><span class='hs-comment'>--</span> <a name="line-124"></a><span class='hs-comment'>-- The number of milliseconds is a lower bound on the time before the callback</span> <a name="line-125"></a><span class='hs-comment'>-- is generated. GLUT attempts to deliver the timer callback as soon as possible</span> <a name="line-126"></a><span class='hs-comment'>-- after the expiration of the callback\'s time interval.</span> <a name="line-127"></a> <a name="line-128"></a><a name="addTimerCallback"></a><span class='hs-definition'>addTimerCallback</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Timeout</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>TimerCallback</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>()</span> <a name="line-129"></a><span class='hs-definition'>addTimerCallback</span> <span class='hs-varid'>msecs</span> <span class='hs-varid'>timerCallback</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>do</span> <a name="line-130"></a> <span class='hs-varid'>funPtr</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>mfix</span> <span class='hs-layout'>(</span><span class='hs-keyglyph'>\</span><span class='hs-varid'>self</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>makeTimerCallback</span> <span class='hs-layout'>(</span><span class='hs-keyglyph'>\</span><span class='hs-keyword'>_</span> <span class='hs-keyglyph'>-></span> <span class='hs-keyword'>do</span> <span class='hs-varid'>registerForCleanup</span> <span class='hs-varid'>self</span> <a name="line-131"></a> <span class='hs-varid'>timerCallback</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span> <a name="line-132"></a> <span class='hs-varid'>glutTimerFunc</span> <span class='hs-layout'>(</span><span class='hs-varid'>fromIntegral</span> <span class='hs-varid'>msecs</span><span class='hs-layout'>)</span> <span class='hs-varid'>funPtr</span> <span class='hs-num'>0</span> <a name="line-133"></a> <a name="line-134"></a><span class='hs-keyword'>foreign</span> <span class='hs-keyword'>import</span> <span class='hs-keyword'>ccall</span> <span class='hs-str'>"wrapper"</span> <span class='hs-varid'>makeTimerCallback</span> <span class='hs-keyglyph'>::</span> <a name="line-135"></a> <span class='hs-conid'>TimerCallback'</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-layout'>(</span><span class='hs-conid'>FunPtr</span> <span class='hs-conid'>TimerCallback'</span><span class='hs-layout'>)</span> <a name="line-136"></a> <a name="line-137"></a><span class='hs-keyword'>foreign</span> <span class='hs-keyword'>import</span> <span class='hs-conid'>CALLCONV</span> <span class='hs-keyword'>unsafe</span> <span class='hs-str'>"glutTimerFunc"</span> <span class='hs-varid'>glutTimerFunc</span> <span class='hs-keyglyph'>::</span> <a name="line-138"></a> <span class='hs-conid'>CUInt</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>FunPtr</span> <span class='hs-conid'>TimerCallback'</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>CInt</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>()</span> </pre></body> </html>
