1<?xml version="1.0" encoding="UTF-8" standalone="no"?> 2<!DOCTYPE html><html xmlns="http://www.w3.org/1999/xhtml"> 3 <head> 4 <title xmlns:xlink="http://www.w3.org/1999/xlink">eglGetSyncAttrib - EGL Reference Pages</title> 5 <link rel="stylesheet" type="text/css" href="khronos-man.css"/> 6 <meta name="generator" content="DocBook XSL Stylesheets V1.79.1"/> 7 </head> 8 <body> 9 <header/> 10 <div class="refentry" id="eglGetSyncAttrib"> 11 <div class="titlepage"/> 12 <div class="refnamediv"> 13 <h2>Name</h2> 14 <p>eglGetSyncAttrib — 15 Return an attribute of a sync object 16 </p> 17 </div> 18 <div class="refsynopsisdiv"> 19 <h2>C Specification</h2> 20 <div class="funcsynopsis"> 21 <table style="border: 0; cellspacing: 0; cellpadding: 0;" class="funcprototype-table"> 22 <tr> 23 <td> 24 <code class="funcdef">EGLBoolean <strong class="fsfunc">eglGetSyncAttrib</strong>(</code> 25 </td> 26 <td>(EGLDisplay <var class="pdparam">display</var>, </td> 27 </tr> 28 <tr> 29 <td> </td> 30 <td>EGLSync <var class="pdparam">sync</var>, </td> 31 </tr> 32 <tr> 33 <td> </td> 34 <td>EGLint <var class="pdparam">attribute</var>, </td> 35 </tr> 36 <tr> 37 <td> </td> 38 <td>EGLAttrib *<var class="pdparam">value</var><code>)</code>;</td> 39 </tr> 40 </table> 41 <div class="funcprototype-spacer"> </div> 42 </div> 43 </div> 44 <div class="refsect1" id="parameters"> 45 <h2>Parameters</h2> 46 <div class="variablelist"> 47 <dl class="variablelist"> 48 <dt> 49 <span class="term"> 50 <em class="parameter"> 51 <code>display</code> 52 </em> 53 </span> 54 </dt> 55 <dd> 56 <p> 57 Specifies the <abbr class="acronym">EGL</abbr> display connection. 58 </p> 59 </dd> 60 <dt> 61 <span class="term"> 62 <em class="parameter"> 63 <code>sync</code> 64 </em> 65 </span> 66 </dt> 67 <dd> 68 <p> 69 Specifies the sync object to query. 70 </p> 71 </dd> 72 <dt> 73 <span class="term"> 74 <em class="parameter"> 75 <code>attribute</code> 76 </em> 77 </span> 78 </dt> 79 <dd> 80 <p> 81 Specifies the EGL sync object attribute to query. 82 </p> 83 </dd> 84 <dt> 85 <span class="term"> 86 <em class="parameter"> 87 <code>value</code> 88 </em> 89 </span> 90 </dt> 91 <dd> 92 <p> 93 Returns the requested attribute value. 94 </p> 95 </dd> 96 </dl> 97 </div> 98 </div> 99 <div class="refsect1" id="description"> 100 <h2>Description</h2> 101 <p> 102 <code class="function">eglGetSyncAttrib</code> is used to query 103 attributes of the sync object <em class="parameter"><code>sync</code></em>. Legal 104 values for <em class="parameter"><code>attribute</code></em> depend on the type 105 of sync object, as shown in table 106 <a class="xref" href="#tab-syncattr" title="Table 1. Attributes accepted by eglGetSyncAttrib">Table 1, “ 107 Attributes accepted by <code class="function">eglGetSyncAttrib</code> 108 ”</a>. Assuming no errors are 109 generated, <code class="constant">EGL_TRUE</code> is returned and the 110 value of the queried attribute is returned in 111 *<em class="parameter"><code>value</code></em>. 112 </p> 113 <div class="table" id="tab-syncattr"> 114 <div class="table-title">Table 1. 115 Attributes accepted by <code class="function">eglGetSyncAttrib</code> 116 </div> 117 <div class="table-contents"> 118 <table style="border-collapse: collapse; border-top: 2px solid ; border-bottom: 2px solid ; border-left: 2px solid ; border-right: 2px solid ; "> 119 <colgroup> 120 <col/> 121 <col/> 122 <col/> 123 </colgroup> 124 <thead> 125 <tr> 126 <th style="text-align: left; border-right: 2px solid ; border-bottom: 2px solid ; ">Attribute</th> 127 <th style="text-align: left; border-right: 2px solid ; border-bottom: 2px solid ; ">Description</th> 128 <th style="text-align: left; border-bottom: 2px solid ; ">Supported Sync Objects</th> 129 </tr> 130 </thead> 131 <tbody> 132 <tr> 133 <td style="text-align: left; border-right: 2px solid ; border-bottom: 2px solid ; ">Attribute</td> 134 <td style="text-align: left; border-right: 2px solid ; border-bottom: 2px solid ; ">Description</td> 135 <td style="text-align: left; border-bottom: 2px solid ; ">Supported Sync Objects</td> 136 </tr> 137 <tr> 138 <td style="text-align: left; border-right: 2px solid ; border-bottom: 2px solid ; "> 139 <code class="constant">EGL_SYNC_TYPE</code> 140 </td> 141 <td style="text-align: left; border-right: 2px solid ; border-bottom: 2px solid ; ">Type of the sync object</td> 142 <td style="text-align: left; border-bottom: 2px solid ; ">All</td> 143 </tr> 144 <tr> 145 <td style="text-align: left; border-right: 2px solid ; border-bottom: 2px solid ; "> 146 <code class="constant">EGL_SYNC_STATUS</code> 147 </td> 148 <td style="text-align: left; border-right: 2px solid ; border-bottom: 2px solid ; ">Status of the sync object</td> 149 <td style="text-align: left; border-bottom: 2px solid ; ">All</td> 150 </tr> 151 <tr> 152 <td style="text-align: left; border-right: 2px solid ; "> 153 <code class="constant">EGL_SYNC_CONDITION</code> 154 </td> 155 <td style="text-align: left; border-right: 2px solid ; ">Signaling condition</td> 156 <td style="text-align: left; "> 157 <code class="constant">EGL_SYNC_FENCE</code> or 158 <code class="constant">EGL_SYNC_CL_EVENT</code> 159 </td> 160 </tr> 161 </tbody> 162 </table> 163 </div> 164 </div> 165 <br class="table-break"/> 166 </div> 167 <div class="refsect1" id="errors"> 168 <h2>Errors</h2> 169 <p> 170 On failure, <code class="function">eglGetSyncAttrib</code> returns 171 <code class="constant">EGL_FALSE</code> and *<em class="parameter"><code>value</code></em> 172 is not modified. 173 </p> 174 <p> 175 If <em class="parameter"><code>sync</code></em> is not a valid sync object for 176 <em class="parameter"><code>display</code></em>, an 177 <code class="constant">EGL_BAD_PARAMETER</code> error is generated. 178 </p> 179 <p> 180 If <em class="parameter"><code>attribute</code></em> is not one of the attributes 181 in table <a class="xref" href="#tab-syncattr" title="Table 1. Attributes accepted by eglGetSyncAttrib">Table 1, “ 182 Attributes accepted by <code class="function">eglGetSyncAttrib</code> 183 ”</a>, an 184 <code class="constant">EGL_BAD_ATTRIBUTE</code> error is generated. 185 </p> 186 <p> 187 If <em class="parameter"><code>attribute</code></em> is not supported for the 188 type of sync object passed in <em class="parameter"><code>sync</code></em>, an 189 <code class="constant">EGL_BAD_MATCH</code> error is generated. 190 </p> 191 <p> 192 If <em class="parameter"><code>display</code></em> does not match the display 193 passed to <code class="function">eglCreateSync</code> when 194 <em class="parameter"><code>sync</code></em> was created, behaviour is undefined. 195 </p> 196 </div> 197 <div class="refsect1" id="notes"> 198 <h2>Notes</h2> 199 <p> 200 <code class="function">eglGetSyncAttrib</code> is available only if the 201 EGL version is 1.5 or greater. 202 </p> 203 </div> 204 <div class="refsect1" id="seealso"> 205 <h2>See Also</h2> 206 <p> 207 <a class="citerefentry" href="eglCreateSync.xhtml"><span class="citerefentry"><span class="refentrytitle">eglCreateSync</span></span></a> 208 </p> 209 </div> 210 <p> 211 </p> 212 <div class="refsect3" id="copyright"> 213 <img src="KhronosLogo.jpg"/> 214 <p> 215 Copyright © 2003-2014 The Khronos Group Inc. 216 Permission is hereby granted, free of charge, to any person obtaining a 217 copy of this software and/or associated documentation files (the 218 "Materials"), to deal in the Materials without restriction, including 219 without limitation the rights to use, copy, modify, merge, publish, 220 distribute, sublicense, and/or sell copies of the Materials, and to 221 permit persons to whom the Materials are furnished to do so, subject to 222 the condition that this copyright notice and permission notice shall be included 223 in all copies or substantial portions of the Materials. 224 </p> 225 </div> 226 <p> 227</p> 228 </div> 229 <footer/> 230 </body> 231</html> 232
