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
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
|
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE html><html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>glFenceSync - OpenGL 4 Reference Pages</title>
<link rel="stylesheet" type="text/css" href="opengl-man.css"/>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1"/>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
MathML: {
extensions: ["content-mathml.js"]
},
tex2jax: {
inlineMath: [['$','$'], ['\\(','\\)']]
}
});
</script>
<script type="text/javascript" src="https://c328740.ssl.cf1.rackcdn.com/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"/>
</head>
<body>
<header/>
<div class="refentry" id="glFenceSync">
<div class="titlepage"/>
<div class="refnamediv">
<h2>Name</h2>
<p>glFenceSync — create a new sync object and insert it into the GL command stream</p>
</div>
<div class="refsynopsisdiv">
<h2>C Specification</h2>
<div class="funcsynopsis">
<table style="border: 0; cellspacing: 0; cellpadding: 0;" class="funcprototype-table">
<tr>
<td>
<code class="funcdef">GLsync <strong class="fsfunc">glFenceSync</strong>(</code>
</td>
<td>GLenum <var class="pdparam">condition</var>, </td>
</tr>
<tr>
<td> </td>
<td>GLbitfield <var class="pdparam">flags</var><code>)</code>;</td>
</tr>
</table>
<div class="funcprototype-spacer"> </div>
</div>
</div>
<div class="refsect1" id="parameters">
<h2>Parameters</h2>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<em class="parameter">
<code>condition</code>
</em>
</span>
</dt>
<dd>
<p>
Specifies the condition that must be met to set the sync object's state to signaled. <em class="parameter"><code>condition</code></em>
must be <code class="constant">GL_SYNC_GPU_COMMANDS_COMPLETE</code>.
</p>
</dd>
<dt>
<span class="term">
<em class="parameter">
<code>flags</code>
</em>
</span>
</dt>
<dd>
<p>
Specifies a bitwise combination of flags controlling the behavior of the sync object. No flags are presently defined
for this operation and <em class="parameter"><code>flags</code></em> must be zero.<a href="#ftn.idp170352" class="footnote"><sup class="footnote" id="idp170352">[1]</sup></a>
</p>
</dd>
</dl>
</div>
</div>
<div class="refsect1" id="description">
<h2>Description</h2>
<p>
<code class="function">glFenceSync</code> creates a new fence sync object, inserts a fence command into the GL command stream and
associates it with that sync object, and returns a non-zero name corresponding to the sync object.
</p>
<p>
When the specified <em class="parameter"><code>condition</code></em> of the sync object is satisfied by the fence command, the sync object
is signaled by the GL, causing any <a class="citerefentry" href="glWaitSync.xhtml"><span class="citerefentry"><span class="refentrytitle">glWaitSync</span></span></a>,
<a class="citerefentry" href="glClientWaitSync.xhtml"><span class="citerefentry"><span class="refentrytitle">glClientWaitSync</span></span></a> commands blocking in <em class="parameter"><code>sync</code></em>
to <span class="emphasis"><em>unblock</em></span>. No other state is affected by <code class="function">glFenceSync</code> or by the execution
of the associated fence command.
</p>
<p>
<em class="parameter"><code>condition</code></em> must be <code class="constant">GL_SYNC_GPU_COMMANDS_COMPLETE</code>. This condition is satisfied by
completion of the fence command corresponding to the sync object and all preceding commands in the same command stream.
The sync object will not be signaled until all effects from these commands on GL client and server state and the
framebuffer are fully realized. Note that completion of the fence command occurs once the state of the corresponding sync
object has been changed, but commands waiting on that sync object may not be unblocked until after the fence command completes.
</p>
</div>
<div class="refsect1" id="notes">
<h2>Notes</h2>
<p>
<code class="function">glFenceSync</code> is only supported if the GL version is 3.2 or greater, or if
the <code class="code">ARB_sync</code> extension is supported.
</p>
</div>
<div class="refsect1" id="errors">
<h2>Errors</h2>
<p>
<code class="constant">GL_INVALID_ENUM</code> is generated if <em class="parameter"><code>condition</code></em> is not
<code class="constant">GL_SYNC_GPU_COMMANDS_COMPLETE</code>.
</p>
<p>
<code class="constant">GL_INVALID_VALUE</code> is generated if <em class="parameter"><code>flags</code></em> is not zero.
</p>
<p>
Additionally, if <code class="function">glFenceSync</code> fails, it will return zero.
</p>
</div>
<div class="refsect1" id="versions">
<h2>Version Support</h2>
<div class="informaltable">
<table style="border-collapse: collapse; border-top: 2px solid ; border-bottom: 2px solid ; border-left: 2px solid ; border-right: 2px solid ; ">
<colgroup>
<col style="text-align: left; "/>
<col style="text-align: center; " class="firstvers"/>
<col style="text-align: center; "/>
<col style="text-align: center; "/>
<col style="text-align: center; "/>
<col style="text-align: center; "/>
<col style="text-align: center; "/>
<col style="text-align: center; "/>
<col style="text-align: center; "/>
<col style="text-align: center; "/>
<col style="text-align: center; "/>
<col style="text-align: center; "/>
<col style="text-align: center; " class="lastvers"/>
</colgroup>
<thead>
<tr>
<th style="text-align: left; border-right: 2px solid ; ">
</th>
<th style="text-align: center; border-bottom: 2px solid ; " colspan="12">
<span class="bold"><strong>OpenGL Version</strong></span>
</th>
</tr>
<tr>
<th style="text-align: left; border-right: 2px solid ; border-bottom: 2px solid ; ">
<span class="bold"><strong>Function / Feature Name</strong></span>
</th>
<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
<span class="bold"><strong>2.0</strong></span>
</th>
<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
<span class="bold"><strong>2.1</strong></span>
</th>
<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
<span class="bold"><strong>3.0</strong></span>
</th>
<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
<span class="bold"><strong>3.1</strong></span>
</th>
<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
<span class="bold"><strong>3.2</strong></span>
</th>
<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
<span class="bold"><strong>3.3</strong></span>
</th>
<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
<span class="bold"><strong>4.0</strong></span>
</th>
<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
<span class="bold"><strong>4.1</strong></span>
</th>
<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
<span class="bold"><strong>4.2</strong></span>
</th>
<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
<span class="bold"><strong>4.3</strong></span>
</th>
<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
<span class="bold"><strong>4.4</strong></span>
</th>
<th style="text-align: center; border-bottom: 2px solid ; ">
<span class="bold"><strong>4.5</strong></span>
</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left; border-right: 2px solid ; ">
<code class="function">glFenceSync</code>
</td>
<td style="text-align: center; border-right: 2px solid ; ">-</td>
<td style="text-align: center; border-right: 2px solid ; ">-</td>
<td style="text-align: center; border-right: 2px solid ; ">-</td>
<td style="text-align: center; border-right: 2px solid ; ">-</td>
<td style="text-align: center; border-right: 2px solid ; ">✔</td>
<td style="text-align: center; border-right: 2px solid ; ">✔</td>
<td style="text-align: center; border-right: 2px solid ; ">✔</td>
<td style="text-align: center; border-right: 2px solid ; ">✔</td>
<td style="text-align: center; border-right: 2px solid ; ">✔</td>
<td style="text-align: center; border-right: 2px solid ; ">✔</td>
<td style="text-align: center; border-right: 2px solid ; ">✔</td>
<td style="text-align: center; ">✔</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="refsect1" id="seealso">
<h2>See Also</h2>
<p>
<a class="citerefentry" href="glDeleteSync.xhtml"><span class="citerefentry"><span class="refentrytitle">glDeleteSync</span></span></a>,
<a class="citerefentry" href="glGetSync.xhtml"><span class="citerefentry"><span class="refentrytitle">glGetSync</span></span></a>,
<a class="citerefentry" href="glWaitSync.xhtml"><span class="citerefentry"><span class="refentrytitle">glWaitSync</span></span></a>,
<a class="citerefentry" href="glClientWaitSync.xhtml"><span class="citerefentry"><span class="refentrytitle">glClientWaitSync</span></span></a>
</p>
</div>
<div class="refsect1" id="Copyright">
<h2>Copyright</h2>
<p>
Copyright <span class="trademark"/>© 2010-2014 Khronos Group.
This material may be distributed subject to the terms and conditions set forth in
the Open Publication License, v 1.0, 8 June 1999.
<a class="link" href="http://opencontent.org/openpub/" target="_top">http://opencontent.org/openpub/</a>.
</p>
</div>
<div class="footnotes">
<br/>
<hr class="footnote-hr"/>
<div id="ftn.idp170352" class="footnote">
<p><a href="#idp170352" class="para"><sup class="para">[1] </sup></a>
<em class="parameter"><code>flags</code></em> is a placeholder for anticipated future extensions of fence sync object capabilities.
</p>
</div>
</div>
</div>
<footer/>
</body>
</html>
|
