Commit | Line | Data |
---|---|---|
7faf1d71 AW |
1 | <?xml version="1.0" encoding="UTF-8"?>\r |
2 | <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN"\r | |
3 | "http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd">\r | |
4 | <refentry id="glGetSync">\r | |
5 | <refmeta>\r | |
6 | <refmetainfo>\r | |
7 | <copyright>\r | |
8 | <year>2010</year>\r | |
9 | <holder>Khronos Group</holder>\r | |
10 | </copyright>\r | |
11 | </refmetainfo>\r | |
12 | <refentrytitle>glGetSynciv</refentrytitle>\r | |
13 | <manvolnum>3G</manvolnum>\r | |
14 | </refmeta>\r | |
15 | <refnamediv>\r | |
16 | <refname>glGetSynciv</refname>\r | |
17 | <refpurpose>query the properties of a sync object</refpurpose>\r | |
18 | </refnamediv>\r | |
19 | <refsynopsisdiv><title>C Specification</title>\r | |
20 | <funcsynopsis>\r | |
21 | <funcprototype>\r | |
22 | <funcdef>void <function>glGetSynciv</function></funcdef>\r | |
23 | <paramdef>GLsync <parameter>sync</parameter></paramdef>\r | |
24 | <paramdef>GLenum <parameter>pname</parameter></paramdef>\r | |
25 | <paramdef>GLsizei <parameter>bufSize</parameter></paramdef>\r | |
26 | <paramdef>GLsizei *<parameter>length</parameter></paramdef>\r | |
27 | <paramdef>GLint *<parameter>values</parameter></paramdef>\r | |
28 | </funcprototype>\r | |
29 | </funcsynopsis>\r | |
30 | </refsynopsisdiv>\r | |
31 | <!-- eqn: ignoring delim $$ -->\r | |
32 | <refsect1 id="parameters"><title>Parameters</title>\r | |
33 | <variablelist>\r | |
34 | <varlistentry>\r | |
35 | <term><parameter>sync</parameter></term>\r | |
36 | <listitem>\r | |
37 | <para>\r | |
38 | Specifies the sync object whose properties to query.\r | |
39 | </para>\r | |
40 | </listitem>\r | |
41 | </varlistentry>\r | |
42 | <varlistentry>\r | |
43 | <term><parameter>pname</parameter></term>\r | |
44 | <listitem>\r | |
45 | <para>\r | |
46 | Specifies the parameter whose value to retrieve from the sync object specified in <parameter>sync</parameter>.\r | |
47 | </para>\r | |
48 | </listitem>\r | |
49 | </varlistentry>\r | |
50 | <varlistentry>\r | |
51 | <term><parameter>bufSize</parameter></term>\r | |
52 | <listitem>\r | |
53 | <para>\r | |
54 | Specifies the size of the buffer whose address is given in <parameter>values</parameter>.\r | |
55 | </para>\r | |
56 | </listitem>\r | |
57 | </varlistentry>\r | |
58 | <varlistentry>\r | |
59 | <term><parameter>length</parameter></term>\r | |
60 | <listitem>\r | |
61 | <para>\r | |
62 | Specifies the address of an variable to receive the number of integers placed in <parameter>values</parameter>.\r | |
63 | </para>\r | |
64 | </listitem>\r | |
65 | </varlistentry>\r | |
66 | <varlistentry>\r | |
67 | <term><parameter>values</parameter></term>\r | |
68 | <listitem>\r | |
69 | <para>\r | |
70 | Specifies the address of an array to receive the values of the queried parameter.\r | |
71 | </para>\r | |
72 | </listitem>\r | |
73 | </varlistentry>\r | |
74 | </variablelist>\r | |
75 | </refsect1>\r | |
76 | <refsect1 id="description"><title>Description</title>\r | |
77 | <para>\r | |
78 | <function>glGetSynciv</function> retrieves properties of a sync object. <parameter>sync</parameter> specifies the name of the sync\r | |
79 | object whose properties to retrieve.\r | |
80 | </para>\r | |
81 | <para>\r | |
82 | On success, <function>glGetSynciv</function> replaces up to <parameter>bufSize</parameter> integers in <parameter>values</parameter> with the\r | |
83 | corresponding property values of the object being queried. The actual number of integers replaced is returned in the variable whose address is\r | |
84 | specified in <parameter>length</parameter>. If <parameter>length</parameter> is <code>NULL</code>, no length is returned.\r | |
85 | </para>\r | |
86 | <para>\r | |
87 | If <parameter>pname</parameter> is <constant>GL_OBJECT_TYPE</constant>, a single value representing the specific type of the sync object is\r | |
88 | placed in <parameter>values</parameter>. The only type supported is <constant>GL_SYNC_FENCE</constant>.\r | |
89 | </para>\r | |
90 | <para>\r | |
91 | If <parameter>pname</parameter> is <constant>GL_SYNC_STATUS</constant>, a single value representing the status of the sync object\r | |
92 | (<constant>GL_SIGNALED</constant> or <constant>GL_UNSIGNALED</constant>) is placed in <parameter>values</parameter>.\r | |
93 | </para>\r | |
94 | <para>\r | |
95 | If <parameter>pname</parameter> is <constant>GL_SYNC_CONDITION</constant>, a single value representing the condition of the sync object\r | |
96 | is placed in <parameter>values</parameter>. The only condition supported is <constant>GL_SYNC_GPU_COMMANDS_COMPLETE</constant>.\r | |
97 | </para>\r | |
98 | <para>\r | |
99 | If <parameter>pname</parameter> is <constant>GL_SYNC_FLAGS</constant>, a single value representing the flags with which the sync object\r | |
100 | was created is placed in <parameter>values</parameter>. No flags are currently supported<footnote><para><parameter>flags</parameter> is\r | |
101 | expected to be used in future extensions to the sync objects.</para></footnote>.\r | |
102 | </para>\r | |
103 | <para>\r | |
104 | If an error occurs, nothing will be written to <parameter>values</parameter> or <parameter>length</parameter>.\r | |
105 | </para>\r | |
106 | </refsect1>\r | |
107 | <refsect1 id="errors"><title>Errors</title>\r | |
108 | <para>\r | |
109 | <constant>GL_INVALID_VALUE</constant> is generated if <parameter>sync</parameter> is not the name of a sync object.\r | |
110 | </para>\r | |
111 | <para>\r | |
112 | <constant>GL_INVALID_ENUM</constant> is generated if <parameter>pname</parameter> is not one of the accepted tokens.\r | |
113 | </para>\r | |
114 | </refsect1>\r | |
115 | <refsect1 id="seealso"><title>See Also</title>\r | |
116 | <para>\r | |
117 | <citerefentry><refentrytitle>glFenceSync</refentrytitle></citerefentry>,\r | |
118 | <citerefentry><refentrytitle>glWaitSync</refentrytitle></citerefentry>,\r | |
119 | <citerefentry><refentrytitle>glClientWaitSync</refentrytitle></citerefentry>\r | |
120 | </para>\r | |
121 | </refsect1>\r | |
122 | <refsect1 id="Copyright"><title>Copyright</title>\r | |
123 | <para>\r | |
124 | Copyright <trademark class="copyright"></trademark> 2010 Khronos Group. \r | |
125 | This material may be distributed subject to the terms and conditions set forth in \r | |
126 | the Open Publication License, v 1.0, 8 June 1999.\r | |
127 | <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.\r | |
128 | </para>\r | |
129 | </refsect1>\r | |
130 | </refentry>\r |