1 <?xml version=
"1.0" encoding=
"UTF-8"?>
2 <!DOCTYPE book PUBLIC
"-//OASIS//DTD DocBook MathML Module V1.1b1//EN"
3 "http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd">
4 <refentry id=
"glGetSync">
9 <holder>Khronos Group
</holder>
12 <refentrytitle>glGetSynciv
</refentrytitle>
13 <manvolnum>3G
</manvolnum>
16 <refname>glGetSynciv
</refname>
17 <refpurpose>query the properties of a sync object
</refpurpose>
19 <refsynopsisdiv><title>C Specification
</title>
22 <funcdef>void
<function>glGetSynciv
</function></funcdef>
23 <paramdef>GLsync
<parameter>sync
</parameter></paramdef>
24 <paramdef>GLenum
<parameter>pname
</parameter></paramdef>
25 <paramdef>GLsizei
<parameter>bufSize
</parameter></paramdef>
26 <paramdef>GLsizei *
<parameter>length
</parameter></paramdef>
27 <paramdef>GLint *
<parameter>values
</parameter></paramdef>
31 <!-- eqn: ignoring delim $$ -->
32 <refsect1 id=
"parameters"><title>Parameters
</title>
35 <term><parameter>sync
</parameter></term>
38 Specifies the sync object whose properties to query.
43 <term><parameter>pname
</parameter></term>
46 Specifies the parameter whose value to retrieve from the sync object specified in
<parameter>sync
</parameter>.
51 <term><parameter>bufSize
</parameter></term>
54 Specifies the size of the buffer whose address is given in
<parameter>values
</parameter>.
59 <term><parameter>length
</parameter></term>
62 Specifies the address of an variable to receive the number of integers placed in
<parameter>values
</parameter>.
67 <term><parameter>values
</parameter></term>
70 Specifies the address of an array to receive the values of the queried parameter.
76 <refsect1 id=
"description"><title>Description
</title>
78 <function>glGetSynciv
</function> retrieves properties of a sync object.
<parameter>sync
</parameter> specifies the name of the sync
79 object whose properties to retrieve.
82 On success,
<function>glGetSynciv
</function> replaces up to
<parameter>bufSize
</parameter> integers in
<parameter>values
</parameter> with the
83 corresponding property values of the object being queried. The actual number of integers replaced is returned in the variable whose address is
84 specified in
<parameter>length
</parameter>. If
<parameter>length
</parameter> is
<code>NULL
</code>, no length is returned.
87 If
<parameter>pname
</parameter> is
<constant>GL_OBJECT_TYPE
</constant>, a single value representing the specific type of the sync object is
88 placed in
<parameter>values
</parameter>. The only type supported is
<constant>GL_SYNC_FENCE
</constant>.
91 If
<parameter>pname
</parameter> is
<constant>GL_SYNC_STATUS
</constant>, a single value representing the status of the sync object
92 (
<constant>GL_SIGNALED
</constant> or
<constant>GL_UNSIGNALED
</constant>) is placed in
<parameter>values
</parameter>.
95 If
<parameter>pname
</parameter> is
<constant>GL_SYNC_CONDITION
</constant>, a single value representing the condition of the sync object
96 is placed in
<parameter>values
</parameter>. The only condition supported is
<constant>GL_SYNC_GPU_COMMANDS_COMPLETE
</constant>.
99 If
<parameter>pname
</parameter> is
<constant>GL_SYNC_FLAGS
</constant>, a single value representing the flags with which the sync object
100 was created is placed in
<parameter>values
</parameter>. No flags are currently supported
<footnote><para><parameter>flags
</parameter> is
101 expected to be used in future extensions to the sync objects.
</para></footnote>.
104 If an error occurs, nothing will be written to
<parameter>values
</parameter> or
<parameter>length
</parameter>.
107 <refsect1 id=
"errors"><title>Errors
</title>
109 <constant>GL_INVALID_VALUE
</constant> is generated if
<parameter>sync
</parameter> is not the name of a sync object.
112 <constant>GL_INVALID_ENUM
</constant> is generated if
<parameter>pname
</parameter> is not one of the accepted tokens.
115 <refsect1 id=
"seealso"><title>See Also
</title>
117 <citerefentry><refentrytitle>glFenceSync
</refentrytitle></citerefentry>,
118 <citerefentry><refentrytitle>glWaitSync
</refentrytitle></citerefentry>,
119 <citerefentry><refentrytitle>glClientWaitSync
</refentrytitle></citerefentry>
122 <refsect1 id=
"Copyright"><title>Copyright
</title>
124 Copyright
<trademark class=
"copyright"></trademark> 2010 Khronos Group.
125 This material may be distributed subject to the terms and conditions set forth in
126 the Open Publication License, v
1.0,
8 June
1999.
127 <ulink url=
"http://opencontent.org/openpub/">http://opencontent.org/openpub/
</ulink>.