/usr/share/doc/libghc-opengl-doc/html/src/Graphics-Rendering-OpenGL-GL-SyncObjects.html is in libghc-opengl-doc 3.0.1.0-3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 | <?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://code.haskell.org/~malcolm/hscolour/ -->
<title>src/Graphics/Rendering/OpenGL/GL/SyncObjects.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.Rendering.OpenGL.GL.SyncObjects</span>
<a name="line-4"></a><span class='hs-comment'>-- Copyright : (c) Sven Panne 2016</span>
<a name="line-5"></a><span class='hs-comment'>-- License : BSD3</span>
<a name="line-6"></a><span class='hs-comment'>--</span>
<a name="line-7"></a><span class='hs-comment'>-- Maintainer : Sven Panne <svenpanne@gmail.com></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'>-- This module corresponds to section 4.1 (Sync Objects and Fences) of the</span>
<a name="line-12"></a><span class='hs-comment'>-- OpenGL 4.4 specs.</span>
<a name="line-13"></a><span class='hs-comment'>--</span>
<a name="line-14"></a><span class='hs-comment'>--------------------------------------------------------------------------------</span>
<a name="line-15"></a>
<a name="line-16"></a><span class='hs-keyword'>module</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'>SyncObjects</span> <span class='hs-layout'>(</span>
<a name="line-17"></a> <span class='hs-comment'>-- * Sync Objects and Fences</span>
<a name="line-18"></a> <span class='hs-conid'>SyncObject</span><span class='hs-layout'>,</span> <span class='hs-varid'>syncGpuCommandsComplete</span><span class='hs-layout'>,</span>
<a name="line-19"></a>
<a name="line-20"></a> <span class='hs-comment'>-- * Waiting for Sync Objects</span>
<a name="line-21"></a> <span class='hs-conid'>WaitTimeout</span><span class='hs-layout'>,</span> <span class='hs-conid'>WaitFlag</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'>WaitResult</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'>clientWaitSync</span><span class='hs-layout'>,</span>
<a name="line-22"></a> <span class='hs-varid'>waitSync</span><span class='hs-layout'>,</span> <span class='hs-varid'>maxServerWaitTimeout</span><span class='hs-layout'>,</span>
<a name="line-23"></a>
<a name="line-24"></a> <span class='hs-comment'>-- * Sync Object Queries</span>
<a name="line-25"></a> <span class='hs-conid'>SyncStatus</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'>syncStatus</span>
<a name="line-26"></a><span class='hs-layout'>)</span> <span class='hs-keyword'>where</span>
<a name="line-27"></a>
<a name="line-28"></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'>IO</span><span class='hs-varop'>.</span><span class='hs-conid'>Class</span>
<a name="line-29"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>ObjectName</span>
<a name="line-30"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>StateVar</span>
<a name="line-31"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Foreign</span><span class='hs-varop'>.</span><span class='hs-conid'>Marshal</span><span class='hs-varop'>.</span><span class='hs-conid'>Utils</span> <span class='hs-layout'>(</span> <span class='hs-varid'>with</span> <span class='hs-layout'>)</span>
<a name="line-32"></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-varid'>nullPtr</span> <span class='hs-layout'>)</span>
<a name="line-33"></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'>DebugOutput</span>
<a name="line-34"></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'>GLboolean</span>
<a name="line-35"></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'>PeekPoke</span>
<a name="line-36"></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'>QueryUtils</span>
<a name="line-37"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Graphics</span><span class='hs-varop'>.</span><span class='hs-conid'>GL</span>
<a name="line-38"></a>
<a name="line-39"></a><span class='hs-comment'>--------------------------------------------------------------------------------</span>
<a name="line-40"></a>
<a name="line-41"></a><a name="SyncObject"></a><span class='hs-keyword'>newtype</span> <span class='hs-conid'>SyncObject</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>SyncObject</span> <span class='hs-layout'>{</span> <span class='hs-varid'>syncID</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>GLsync</span> <span class='hs-layout'>}</span>
<a name="line-42"></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-43"></a>
<a name="line-44"></a><a name="instance%20ObjectName%20SyncObject"></a><span class='hs-keyword'>instance</span> <span class='hs-conid'>ObjectName</span> <span class='hs-conid'>SyncObject</span> <span class='hs-keyword'>where</span>
<a name="line-45"></a> <span class='hs-varid'>isObjectName</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>liftIO</span> <span class='hs-varop'>.</span> <span class='hs-varid'>fmap</span> <span class='hs-varid'>unmarshalGLboolean</span> <span class='hs-varop'>.</span> <span class='hs-varid'>glIsSync</span> <span class='hs-varop'>.</span> <span class='hs-varid'>syncID</span>
<a name="line-46"></a> <span class='hs-varid'>deleteObjectName</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>liftIO</span> <span class='hs-varop'>.</span> <span class='hs-varid'>glDeleteSync</span> <span class='hs-varop'>.</span> <span class='hs-varid'>syncID</span>
<a name="line-47"></a>
<a name="line-48"></a><a name="instance%20CanBeLabeled%20SyncObject"></a><span class='hs-keyword'>instance</span> <span class='hs-conid'>CanBeLabeled</span> <span class='hs-conid'>SyncObject</span> <span class='hs-keyword'>where</span>
<a name="line-49"></a> <span class='hs-varid'>objectLabel</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>objectPtrLabel</span> <span class='hs-varop'>.</span> <span class='hs-varid'>syncID</span>
<a name="line-50"></a>
<a name="line-51"></a><a name="syncGpuCommandsComplete"></a><span class='hs-definition'>syncGpuCommandsComplete</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>IO</span> <span class='hs-conid'>SyncObject</span>
<a name="line-52"></a><span class='hs-definition'>syncGpuCommandsComplete</span> <span class='hs-keyglyph'>=</span>
<a name="line-53"></a> <span class='hs-varid'>fmap</span> <span class='hs-conid'>SyncObject</span> <span class='hs-varop'>$</span> <span class='hs-varid'>glFenceSync</span> <span class='hs-conid'>GL_SYNC_GPU_COMMANDS_COMPLETE</span> <span class='hs-num'>0</span>
<a name="line-54"></a>
<a name="line-55"></a><span class='hs-comment'>--------------------------------------------------------------------------------</span>
<a name="line-56"></a>
<a name="line-57"></a><a name="WaitTimeout"></a><span class='hs-keyword'>type</span> <span class='hs-conid'>WaitTimeout</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>GLuint64</span>
<a name="line-58"></a>
<a name="line-59"></a><span class='hs-comment'>--------------------------------------------------------------------------------</span>
<a name="line-60"></a>
<a name="line-61"></a><a name="WaitFlag"></a><span class='hs-keyword'>data</span> <span class='hs-conid'>WaitFlag</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>SyncFlushCommands</span>
<a name="line-62"></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-63"></a>
<a name="line-64"></a><a name="marshalWaitFlag"></a><span class='hs-definition'>marshalWaitFlag</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>WaitFlag</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>GLbitfield</span>
<a name="line-65"></a><span class='hs-definition'>marshalWaitFlag</span> <span class='hs-varid'>x</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>case</span> <span class='hs-varid'>x</span> <span class='hs-keyword'>of</span>
<a name="line-66"></a> <span class='hs-conid'>SyncFlushCommands</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>GL_SYNC_FLUSH_COMMANDS_BIT</span>
<a name="line-67"></a>
<a name="line-68"></a><span class='hs-comment'>--------------------------------------------------------------------------------</span>
<a name="line-69"></a>
<a name="line-70"></a><a name="WaitResult"></a><span class='hs-keyword'>data</span> <span class='hs-conid'>WaitResult</span> <span class='hs-keyglyph'>=</span>
<a name="line-71"></a> <span class='hs-conid'>AlreadySignaled</span>
<a name="line-72"></a> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>TimeoutExpired</span>
<a name="line-73"></a> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>ConditionSatisfied</span>
<a name="line-74"></a> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>WaitFailed</span>
<a name="line-75"></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-76"></a>
<a name="line-77"></a><a name="unmarshalWaitResult"></a><span class='hs-definition'>unmarshalWaitResult</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>GLenum</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>WaitResult</span>
<a name="line-78"></a><span class='hs-definition'>unmarshalWaitResult</span> <span class='hs-varid'>x</span>
<a name="line-79"></a> <span class='hs-keyglyph'>|</span> <span class='hs-varid'>x</span> <span class='hs-varop'>==</span> <span class='hs-conid'>GL_ALREADY_SIGNALED</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>AlreadySignaled</span>
<a name="line-80"></a> <span class='hs-keyglyph'>|</span> <span class='hs-varid'>x</span> <span class='hs-varop'>==</span> <span class='hs-conid'>GL_TIMEOUT_EXPIRED</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>TimeoutExpired</span>
<a name="line-81"></a> <span class='hs-keyglyph'>|</span> <span class='hs-varid'>x</span> <span class='hs-varop'>==</span> <span class='hs-conid'>GL_CONDITION_SATISFIED</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>ConditionSatisfied</span>
<a name="line-82"></a> <span class='hs-keyglyph'>|</span> <span class='hs-varid'>x</span> <span class='hs-varop'>==</span> <span class='hs-conid'>GL_WAIT_FAILED</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>WaitFailed</span>
<a name="line-83"></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'>"unmarshalWaitResult: 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-84"></a>
<a name="line-85"></a><span class='hs-comment'>--------------------------------------------------------------------------------</span>
<a name="line-86"></a>
<a name="line-87"></a><a name="clientWaitSync"></a><span class='hs-definition'>clientWaitSync</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>SyncObject</span> <span class='hs-keyglyph'>-></span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>WaitFlag</span><span class='hs-keyglyph'>]</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>WaitTimeout</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>WaitResult</span>
<a name="line-88"></a><span class='hs-definition'>clientWaitSync</span> <span class='hs-varid'>syncObject</span> <span class='hs-varid'>flags</span> <span class='hs-keyglyph'>=</span>
<a name="line-89"></a> <span class='hs-varid'>fmap</span> <span class='hs-varid'>unmarshalWaitResult</span> <span class='hs-varop'>.</span>
<a name="line-90"></a> <span class='hs-varid'>glClientWaitSync</span> <span class='hs-layout'>(</span><span class='hs-varid'>syncID</span> <span class='hs-varid'>syncObject</span><span class='hs-layout'>)</span> <span class='hs-layout'>(</span><span class='hs-varid'>sum</span> <span class='hs-layout'>(</span><span class='hs-varid'>map</span> <span class='hs-varid'>marshalWaitFlag</span> <span class='hs-varid'>flags</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span>
<a name="line-91"></a>
<a name="line-92"></a><a name="waitSync"></a><span class='hs-definition'>waitSync</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>SyncObject</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>()</span>
<a name="line-93"></a><span class='hs-definition'>waitSync</span> <span class='hs-varid'>syncObject</span> <span class='hs-keyglyph'>=</span>
<a name="line-94"></a> <span class='hs-varid'>glWaitSync</span> <span class='hs-layout'>(</span><span class='hs-varid'>syncID</span> <span class='hs-varid'>syncObject</span><span class='hs-layout'>)</span> <span class='hs-num'>0</span> <span class='hs-layout'>(</span><span class='hs-varid'>fromIntegral</span> <span class='hs-conid'>GL_TIMEOUT_IGNORED</span><span class='hs-layout'>)</span>
<a name="line-95"></a>
<a name="line-96"></a><a name="maxServerWaitTimeout"></a><span class='hs-definition'>maxServerWaitTimeout</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>GettableStateVar</span> <span class='hs-conid'>WaitTimeout</span>
<a name="line-97"></a><span class='hs-definition'>maxServerWaitTimeout</span> <span class='hs-keyglyph'>=</span>
<a name="line-98"></a> <span class='hs-varid'>makeGettableStateVar</span> <span class='hs-layout'>(</span><span class='hs-varid'>getInteger64</span> <span class='hs-varid'>fromIntegral</span> <span class='hs-conid'>GetMaxServerWaitTimeout</span><span class='hs-layout'>)</span>
<a name="line-99"></a>
<a name="line-100"></a><span class='hs-comment'>--------------------------------------------------------------------------------</span>
<a name="line-101"></a>
<a name="line-102"></a><a name="SyncStatus"></a><span class='hs-keyword'>data</span> <span class='hs-conid'>SyncStatus</span> <span class='hs-keyglyph'>=</span>
<a name="line-103"></a> <span class='hs-conid'>Unsignaled</span>
<a name="line-104"></a> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>Signaled</span>
<a name="line-105"></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-106"></a>
<a name="line-107"></a><a name="unmarshalSyncStatus"></a><span class='hs-definition'>unmarshalSyncStatus</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>GLenum</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>SyncStatus</span>
<a name="line-108"></a><span class='hs-definition'>unmarshalSyncStatus</span> <span class='hs-varid'>x</span>
<a name="line-109"></a> <span class='hs-keyglyph'>|</span> <span class='hs-varid'>x</span> <span class='hs-varop'>==</span> <span class='hs-conid'>GL_UNSIGNALED</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>Unsignaled</span>
<a name="line-110"></a> <span class='hs-keyglyph'>|</span> <span class='hs-varid'>x</span> <span class='hs-varop'>==</span> <span class='hs-conid'>GL_SIGNALED</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>Signaled</span>
<a name="line-111"></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'>"unmarshalSyncStatus: 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-112"></a>
<a name="line-113"></a><a name="syncStatus"></a><span class='hs-definition'>syncStatus</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>SyncObject</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>GettableStateVar</span> <span class='hs-conid'>SyncStatus</span>
<a name="line-114"></a><span class='hs-definition'>syncStatus</span> <span class='hs-varid'>syncObject</span> <span class='hs-keyglyph'>=</span>
<a name="line-115"></a> <span class='hs-varid'>makeGettableStateVar</span> <span class='hs-varop'>$</span>
<a name="line-116"></a> <span class='hs-varid'>with</span> <span class='hs-num'>0</span> <span class='hs-varop'>$</span> <span class='hs-keyglyph'>\</span><span class='hs-varid'>buf</span> <span class='hs-keyglyph'>-></span> <span class='hs-keyword'>do</span>
<a name="line-117"></a> <span class='hs-varid'>glGetSynciv</span> <span class='hs-layout'>(</span><span class='hs-varid'>syncID</span> <span class='hs-varid'>syncObject</span><span class='hs-layout'>)</span> <span class='hs-conid'>GL_SYNC_STATUS</span> <span class='hs-num'>1</span> <span class='hs-varid'>nullPtr</span> <span class='hs-varid'>buf</span>
<a name="line-118"></a> <span class='hs-varid'>peek1</span> <span class='hs-layout'>(</span><span class='hs-varid'>unmarshalSyncStatus</span> <span class='hs-varop'>.</span> <span class='hs-varid'>fromIntegral</span><span class='hs-layout'>)</span> <span class='hs-varid'>buf</span>
</pre></body>
</html>
|