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
|
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE html><html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title xmlns:xlink="http://www.w3.org/1999/xlink">eglGetSyncAttrib - EGL Reference Pages</title>
<link rel="stylesheet" type="text/css" href="khronos-man.css"/>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"/>
</head>
<body>
<header/>
<div class="refentry" id="eglGetSyncAttrib">
<div class="titlepage"/>
<div class="refnamediv">
<h2>Name</h2>
<p>eglGetSyncAttrib —
Return an attribute 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">EGLBoolean <strong class="fsfunc">eglGetSyncAttrib</strong>(</code>
</td>
<td>(EGLDisplay <var class="pdparam">display</var>, </td>
</tr>
<tr>
<td> </td>
<td>EGLSync <var class="pdparam">sync</var>, </td>
</tr>
<tr>
<td> </td>
<td>EGLint <var class="pdparam">attribute</var>, </td>
</tr>
<tr>
<td> </td>
<td>EGLAttrib *<var class="pdparam">value</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>display</code>
</em>
</span>
</dt>
<dd>
<p>
Specifies the <abbr class="acronym">EGL</abbr> display connection.
</p>
</dd>
<dt>
<span class="term">
<em class="parameter">
<code>sync</code>
</em>
</span>
</dt>
<dd>
<p>
Specifies the sync object to query.
</p>
</dd>
<dt>
<span class="term">
<em class="parameter">
<code>attribute</code>
</em>
</span>
</dt>
<dd>
<p>
Specifies the EGL sync object attribute to query.
</p>
</dd>
<dt>
<span class="term">
<em class="parameter">
<code>value</code>
</em>
</span>
</dt>
<dd>
<p>
Returns the requested attribute value.
</p>
</dd>
</dl>
</div>
</div>
<div class="refsect1" id="description">
<h2>Description</h2>
<p>
<code class="function">eglGetSyncAttrib</code> is used to query
attributes of the sync object <em class="parameter"><code>sync</code></em>. Legal
values for <em class="parameter"><code>attribute</code></em> depend on the type
of sync object, as shown in table
<a class="xref" href="#tab-syncattr" title="Table 1. Attributes accepted by eglGetSyncAttrib">Table 1, “
Attributes accepted by <code class="function">eglGetSyncAttrib</code>
”</a>. Assuming no errors are
generated, <code class="constant">EGL_TRUE</code> is returned and the
value of the queried attribute is returned in
*<em class="parameter"><code>value</code></em>.
</p>
<div class="table" id="tab-syncattr">
<div class="table-title">Table 1.
Attributes accepted by <code class="function">eglGetSyncAttrib</code>
</div>
<div class="table-contents">
<table style="border-collapse: collapse; border-top: 2px solid ; border-bottom: 2px solid ; border-left: 2px solid ; border-right: 2px solid ; ">
<colgroup>
<col/>
<col/>
<col/>
</colgroup>
<thead>
<tr>
<th style="text-align: left; border-right: 2px solid ; border-bottom: 2px solid ; ">Attribute</th>
<th style="text-align: left; border-right: 2px solid ; border-bottom: 2px solid ; ">Description</th>
<th style="text-align: left; border-bottom: 2px solid ; ">Supported Sync Objects</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left; border-right: 2px solid ; border-bottom: 2px solid ; ">Attribute</td>
<td style="text-align: left; border-right: 2px solid ; border-bottom: 2px solid ; ">Description</td>
<td style="text-align: left; border-bottom: 2px solid ; ">Supported Sync Objects</td>
</tr>
<tr>
<td style="text-align: left; border-right: 2px solid ; border-bottom: 2px solid ; ">
<code class="constant">EGL_SYNC_TYPE</code>
</td>
<td style="text-align: left; border-right: 2px solid ; border-bottom: 2px solid ; ">Type of the sync object</td>
<td style="text-align: left; border-bottom: 2px solid ; ">All</td>
</tr>
<tr>
<td style="text-align: left; border-right: 2px solid ; border-bottom: 2px solid ; ">
<code class="constant">EGL_SYNC_STATUS</code>
</td>
<td style="text-align: left; border-right: 2px solid ; border-bottom: 2px solid ; ">Status of the sync object</td>
<td style="text-align: left; border-bottom: 2px solid ; ">All</td>
</tr>
<tr>
<td style="text-align: left; border-right: 2px solid ; ">
<code class="constant">EGL_SYNC_CONDITION</code>
</td>
<td style="text-align: left; border-right: 2px solid ; ">Signaling condition</td>
<td style="text-align: left; ">
<code class="constant">EGL_SYNC_FENCE</code> or
<code class="constant">EGL_SYNC_CL_EVENT</code>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<br class="table-break"/>
</div>
<div class="refsect1" id="errors">
<h2>Errors</h2>
<p>
On failure, <code class="function">eglGetSyncAttrib</code> returns
<code class="constant">EGL_FALSE</code> and *<em class="parameter"><code>value</code></em>
is not modified.
</p>
<p>
If <em class="parameter"><code>sync</code></em> is not a valid sync object for
<em class="parameter"><code>display</code></em>, an
<code class="constant">EGL_BAD_PARAMETER</code> error is generated.
</p>
<p>
If <em class="parameter"><code>attribute</code></em> is not one of the attributes
in table <a class="xref" href="#tab-syncattr" title="Table 1. Attributes accepted by eglGetSyncAttrib">Table 1, “
Attributes accepted by <code class="function">eglGetSyncAttrib</code>
”</a>, an
<code class="constant">EGL_BAD_ATTRIBUTE</code> error is generated.
</p>
<p>
If <em class="parameter"><code>attribute</code></em> is not supported for the
type of sync object passed in <em class="parameter"><code>sync</code></em>, an
<code class="constant">EGL_BAD_MATCH</code> error is generated.
</p>
<p>
If <em class="parameter"><code>display</code></em> does not match the display
passed to <code class="function">eglCreateSync</code> when
<em class="parameter"><code>sync</code></em> was created, behaviour is undefined.
</p>
</div>
<div class="refsect1" id="notes">
<h2>Notes</h2>
<p>
<code class="function">eglGetSyncAttrib</code> is available only if the
EGL version is 1.5 or greater.
</p>
</div>
<div class="refsect1" id="seealso">
<h2>See Also</h2>
<p>
<a class="citerefentry" href="eglCreateSync.xhtml"><span class="citerefentry"><span class="refentrytitle">eglCreateSync</span></span></a>
</p>
</div>
<p>
</p>
<div class="refsect3" id="copyright">
<img src="KhronosLogo.jpg"/>
<p>
Copyright © 2003-2014 The Khronos Group Inc.
Permission is hereby granted, free of charge, to any person obtaining a
copy of this software and/or associated documentation files (the
"Materials"), to deal in the Materials without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Materials, and to
permit persons to whom the Materials are furnished to do so, subject to
the condition that this copyright notice and permission notice shall be included
in all copies or substantial portions of the Materials.
</p>
</div>
<p>
</p>
</div>
<footer/>
</body>
</html>
|
