1<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:base="" xml:id="eglGetSyncAttrib"> 2 <info> 3 <copyright> 4 <year>2018</year> 5 <holder>The Khronos Group Inc.</holder> 6 </copyright> 7 </info> 8 <refmeta> 9 <refentrytitle>eglGetSyncAttrib</refentrytitle> 10 <manvolnum>3G</manvolnum> 11 </refmeta> 12 <refnamediv> 13 <refname>eglGetSyncAttrib</refname> 14 <refpurpose> 15 Return an attribute of a sync object 16 </refpurpose> 17 </refnamediv> 18 <refsynopsisdiv> 19 <title>C Specification</title> 20 <funcsynopsis> 21 <funcprototype> 22 <funcdef>EGLBoolean <function>eglGetSyncAttrib</function></funcdef> 23 <paramdef>(EGLDisplay <parameter>display</parameter></paramdef> 24 <paramdef>EGLSync <parameter>sync</parameter></paramdef> 25 <paramdef>EGLint <parameter>attribute</parameter></paramdef> 26 <paramdef>EGLAttrib *<parameter>value</parameter></paramdef> 27 </funcprototype> 28 </funcsynopsis> 29 </refsynopsisdiv> 30 <refsect1 xml:id="parameters"><title>Parameters</title> 31 <variablelist> 32 <varlistentry> 33 <term><parameter>display</parameter></term> 34 <listitem><para> 35 Specifies the <acronym>EGL</acronym> display connection. 36 </para></listitem> 37 </varlistentry> 38 <varlistentry> 39 <term><parameter>sync</parameter></term> 40 <listitem><para> 41 Specifies the sync object to query. 42 </para></listitem> 43 </varlistentry> 44 <varlistentry> 45 <term><parameter>attribute</parameter></term> 46 <listitem><para> 47 Specifies the EGL sync object attribute to query. 48 </para></listitem> 49 </varlistentry> 50 <varlistentry> 51 <term><parameter>value</parameter></term> 52 <listitem><para> 53 Returns the requested attribute value. 54 </para></listitem> 55 </varlistentry> 56 </variablelist> 57 </refsect1> 58 <refsect1 xml:id="description"><title>Description</title> 59 <para> 60 <function>eglGetSyncAttrib</function> is used to query 61 attributes of the sync object <parameter>sync</parameter>. Legal 62 values for <parameter>attribute</parameter> depend on the type 63 of sync object, as shown in table 64 <xref linkend="tab-syncattr"/>. Assuming no errors are 65 generated, <constant>EGL_TRUE</constant> is returned and the 66 value of the queried attribute is returned in 67 *<parameter>value</parameter>. 68 </para> 69 <table frame="all" xml:id="tab-syncattr"> 70 <title> 71 Attributes accepted by <function>eglGetSyncAttrib</function> 72 </title> 73 <tgroup cols="3" align="left" colsep="1" rowsep="1"> 74 <thead> 75 <row> 76 <entry>Attribute</entry> 77 <entry>Description</entry> 78 <entry>Supported Sync Objects</entry> 79 </row> 80 </thead> 81 <tbody> 82 <row> 83 <entry>Attribute</entry> 84 <entry>Description</entry> 85 <entry>Supported Sync Objects</entry> 86 </row> 87 <row> 88 <entry><constant>EGL_SYNC_TYPE</constant></entry> 89 <entry>Type of the sync object</entry> 90 <entry>All</entry> 91 </row> 92 <row> 93 <entry><constant>EGL_SYNC_STATUS</constant></entry> 94 <entry>Status of the sync object</entry> 95 <entry>All</entry> 96 </row> 97 <row> 98 <entry><constant>EGL_SYNC_CONDITION</constant></entry> 99 <entry>Signaling condition</entry> 100 <entry> 101 <constant>EGL_SYNC_FENCE</constant> or 102 <constant>EGL_SYNC_CL_EVENT</constant> 103 </entry> 104 </row> 105 </tbody> 106 </tgroup> 107 </table> 108 </refsect1> 109 <refsect1 xml:id="errors"><title>Errors</title> 110 <para> 111 On failure, <function>eglGetSyncAttrib</function> returns 112 <constant>EGL_FALSE</constant> and *<parameter>value</parameter> 113 is not modified. 114 </para> 115 <para> 116 If <parameter>sync</parameter> is not a valid sync object for 117 <parameter>display</parameter>, an 118 <constant>EGL_BAD_PARAMETER</constant> error is generated. 119 </para> 120 <para> 121 If <parameter>attribute</parameter> is not one of the attributes 122 in table <xref linkend="tab-syncattr"/>, an 123 <constant>EGL_BAD_ATTRIBUTE</constant> error is generated. 124 </para> 125 <para> 126 If <parameter>attribute</parameter> is not supported for the 127 type of sync object passed in <parameter>sync</parameter>, an 128 <constant>EGL_BAD_MATCH</constant> error is generated. 129 </para> 130 <para> 131 If <parameter>display</parameter> does not match the display 132 passed to <function>eglCreateSync</function> when 133 <parameter>sync</parameter> was created, behaviour is undefined. 134 </para> 135 </refsect1> 136 <refsect1 xml:id="notes"><title>Notes</title> 137 <para> 138 <function>eglGetSyncAttrib</function> is available only if the 139 EGL version is 1.5 or greater. 140 </para> 141 </refsect1> 142 <refsect1 xml:id="seealso"><title>See Also</title> 143 <para> 144 <citerefentry><refentrytitle>eglCreateSync</refentrytitle></citerefentry> 145 </para> 146 </refsect1> 147 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="copyright.xml"/> 148</refentry> 149