/
glGetSynciv.xhtml
215 lines (214 loc) · 9.62 KB
/
glGetSynciv.xhtml
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
<div class="refentry" id="glGetSynciv">
<div class="titlepage"></div>
<div class="refnamediv">
<h2>Name</h2>
<p>glGetSynciv — query the properties of a sync object</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">void <strong class="fsfunc">glGetSynciv</strong>(</code>
</td>
<td>GLsync <var class="pdparam">sync</var>, </td>
</tr>
<tr>
<td> </td>
<td>GLenum <var class="pdparam">pname</var>, </td>
</tr>
<tr>
<td> </td>
<td>GLsizei <var class="pdparam">bufSize</var>, </td>
</tr>
<tr>
<td> </td>
<td>GLsizei *<var class="pdparam">length</var>, </td>
</tr>
<tr>
<td> </td>
<td>GLint *<var class="pdparam">values</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>sync</code>
</em>
</span>
</dt>
<dd>
<p>
Specifies the sync object whose properties to query.
</p>
</dd>
<dt>
<span class="term">
<em class="parameter">
<code>pname</code>
</em>
</span>
</dt>
<dd>
<p>
Specifies the parameter whose value to retrieve from the sync object specified in <em class="parameter"><code>sync</code></em>.
</p>
</dd>
<dt>
<span class="term">
<em class="parameter">
<code>bufSize</code>
</em>
</span>
</dt>
<dd>
<p>
Specifies the size of the buffer whose address is given in <em class="parameter"><code>values</code></em>.
</p>
</dd>
<dt>
<span class="term">
<em class="parameter">
<code>length</code>
</em>
</span>
</dt>
<dd>
<p>
Specifies the address of an variable to receive the number of integers placed in <em class="parameter"><code>values</code></em>.
</p>
</dd>
<dt>
<span class="term">
<em class="parameter">
<code>values</code>
</em>
</span>
</dt>
<dd>
<p>
Specifies the address of an array to receive the values of the queried parameter.
</p>
</dd>
</dl>
</div>
</div>
<div class="refsect1" id="description">
<h2>Description</h2>
<p>
<code class="function">glGetSynciv</code> retrieves properties of a sync object. <em class="parameter"><code>sync</code></em> specifies the name of the sync
object whose properties to retrieve.
</p>
<p>
On success, <code class="function">glGetSynciv</code> replaces up to <em class="parameter"><code>bufSize</code></em> integers in <em class="parameter"><code>values</code></em> with the
corresponding property values of the object being queried. The actual number of integers replaced is returned in the variable whose address is
specified in <em class="parameter"><code>length</code></em>. If <em class="parameter"><code>length</code></em> is <code class="code">NULL</code>, no length is returned.
</p>
<p>
If <em class="parameter"><code>pname</code></em> is <code class="constant">GL_OBJECT_TYPE</code>, a single value representing the specific type of the sync object is
placed in <em class="parameter"><code>values</code></em>. The only type supported is <code class="constant">GL_SYNC_FENCE</code>.
</p>
<p>
If <em class="parameter"><code>pname</code></em> is <code class="constant">GL_SYNC_STATUS</code>, a single value representing the status of the sync object
(<code class="constant">GL_SIGNALED</code> or <code class="constant">GL_UNSIGNALED</code>) is placed in <em class="parameter"><code>values</code></em>.
</p>
<p>
If <em class="parameter"><code>pname</code></em> is <code class="constant">GL_SYNC_CONDITION</code>, a single value representing the condition of the sync object
is placed in <em class="parameter"><code>values</code></em>. The only condition supported is <code class="constant">GL_SYNC_GPU_COMMANDS_COMPLETE</code>.
</p>
<p>
If <em class="parameter"><code>pname</code></em> is <code class="constant">GL_SYNC_FLAGS</code>, a single value representing the flags with which the sync object
was created is placed in <em class="parameter"><code>values</code></em>. No flags are currently supported<a href="#ftn.idp181328" class="footnote"><sup class="footnote" id="idp181328">[1]</sup></a>.
</p>
<p>
If an error occurs, nothing will be written to <em class="parameter"><code>values</code></em> or <em class="parameter"><code>length</code></em>.
</p>
</div>
<div class="refsect1" id="errors">
<h2>Errors</h2>
<p>
<code class="constant">GL_INVALID_VALUE</code> is generated if <em class="parameter"><code>sync</code></em> is not the name of a sync object.
</p>
<p>
<code class="constant">GL_INVALID_ENUM</code> is generated if <em class="parameter"><code>pname</code></em> is not one of the accepted tokens.
</p>
</div>
{$pipelinestall}{$examples}
<div class="refsect1" id="versions">
<h2>API 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; " 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="3">
<span class="bold"><strong>OpenGL ES API Version</strong></span>
</th>
</tr>
<tr>
<th style="text-align: left; border-right: 2px solid ; border-bottom: 2px solid ; ">
<span class="bold"><strong>Function 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>3.0</strong></span>
</th>
<th style="text-align: center; border-bottom: 2px solid ; ">
<span class="bold"><strong>3.1</strong></span>
</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left; border-right: 2px solid ; ">glGetSynciv</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="glFenceSync"><span class="citerefentry"><span class="refentrytitle">glFenceSync</span></span></a>,
<a class="citerefentry" href="glWaitSync"><span class="citerefentry"><span class="refentrytitle">glWaitSync</span></span></a>,
<a class="citerefentry" href="glClientWaitSync"><span class="citerefentry"><span class="refentrytitle">glClientWaitSync</span></span></a>
</p>
</div>
<div class="refsect1" id="Copyright">
<h2>Copyright</h2>
<p>
Copyright © 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.idp181328" class="footnote">
<p><a href="#idp181328" class="para"><sup class="para">[1] </sup></a><em class="parameter"><code>flags</code></em> is
expected to be used in future extensions to the sync objects.</p>
</div>
</div>
</div>