Commit | Line | Data |
---|---|---|
7faf1d71 AW |
1 | <?xml version="1.0" encoding="UTF-8"?> |
2 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "xhtml1-transitional.dtd"> | |
3 | <!-- saved from url=(0013)about:internet --> | |
4 | <?xml-stylesheet type="text/xsl" href="mathml.xsl"?><html xmlns="http://www.w3.org/1999/xhtml" xmlns:pref="http://www.w3.org/2002/Math/preference" pref:renderer="mathplayer-dl"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><link rel="stylesheet" type="text/css" href="opengl-man.css" /><title>glGetSynciv - OpenGL 4 Reference Pages</title><meta name="generator" content="DocBook XSL Stylesheets V1.69.1" /></head><body><div class="refentry" lang="en" xml:lang="en"><a id="glGetSync"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>glGetSynciv — query the properties of a sync object</p></div><div class="refsynopsisdiv"><h2>C Specification</h2><div class="funcsynopsis"><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0"><tr><td><code class="funcdef">void <b class="fsfunc">glGetSynciv</b>(</code></td><td>GLsync </td><td><var class="pdparam">sync</var>, </td></tr><tr><td> </td><td>GLenum </td><td><var class="pdparam">pname</var>, </td></tr><tr><td> </td><td>GLsizei </td><td><var class="pdparam">bufSize</var>, </td></tr><tr><td> </td><td>GLsizei * </td><td><var class="pdparam">length</var>, </td></tr><tr><td> </td><td>GLint * </td><td><var class="pdparam">values</var><code>)</code>;</td></tr></table></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="parameters"></a><h2>Parameters</h2><div class="variablelist"><dl><dt><span class="term"><em class="parameter"><code>sync</code></em></span></dt><dd><p> | |
5 | Specifies the sync object whose properties to query. | |
6 | </p></dd><dt><span class="term"><em class="parameter"><code>pname</code></em></span></dt><dd><p> | |
7 | Specifies the parameter whose value to retrieve from the sync object specified in <em class="parameter"><code>sync</code></em>. | |
8 | </p></dd><dt><span class="term"><em class="parameter"><code>bufSize</code></em></span></dt><dd><p> | |
9 | Specifies the size of the buffer whose address is given in <em class="parameter"><code>values</code></em>. | |
10 | </p></dd><dt><span class="term"><em class="parameter"><code>length</code></em></span></dt><dd><p> | |
11 | Specifies the address of an variable to receive the number of integers placed in <em class="parameter"><code>values</code></em>. | |
12 | </p></dd><dt><span class="term"><em class="parameter"><code>values</code></em></span></dt><dd><p> | |
13 | Specifies the address of an array to receive the values of the queried parameter. | |
14 | </p></dd></dl></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="description"></a><h2>Description</h2><p> | |
15 | <code class="function">glGetSynciv</code> retrieves properties of a sync object. <em class="parameter"><code>sync</code></em> specifies the name of the sync | |
16 | object whose properties to retrieve. | |
17 | </p><p> | |
18 | On success, <code class="function">glGetSynciv</code> replaces up to <em class="parameter"><code>bufSize</code></em> integers in <em class="parameter"><code>values</code></em> with the | |
19 | corresponding property values of the object being queried. The actual number of integers replaced is returned in the variable whose address is | |
20 | specified in <em class="parameter"><code>length</code></em>. If <em class="parameter"><code>length</code></em> is <code class="code">NULL</code>, no length is returned. | |
21 | </p><p> | |
22 | If <em class="parameter"><code>pname</code></em> is <code class="constant">GL_OBJECT_TYPE</code>, a single value representing the specific type of the sync object is | |
23 | placed in <em class="parameter"><code>values</code></em>. The only type supported is <code class="constant">GL_SYNC_FENCE</code>. | |
24 | </p><p> | |
25 | If <em class="parameter"><code>pname</code></em> is <code class="constant">GL_SYNC_STATUS</code>, a single value representing the status of the sync object | |
26 | (<code class="constant">GL_SIGNALED</code> or <code class="constant">GL_UNSIGNALED</code>) is placed in <em class="parameter"><code>values</code></em>. | |
27 | </p><p> | |
28 | If <em class="parameter"><code>pname</code></em> is <code class="constant">GL_SYNC_CONDITION</code>, a single value representing the condition of the sync object | |
29 | is placed in <em class="parameter"><code>values</code></em>. The only condition supported is <code class="constant">GL_SYNC_GPU_COMMANDS_COMPLETE</code>. | |
30 | </p><p> | |
31 | If <em class="parameter"><code>pname</code></em> is <code class="constant">GL_SYNC_FLAGS</code>, a single value representing the flags with which the sync object | |
32 | was created is placed in <em class="parameter"><code>values</code></em>. No flags are currently supported<sup>[<a id="id4816958" href="#ftn.id4816958">1</a>]</sup>. | |
33 | </p><p> | |
34 | If an error occurs, nothing will be written to <em class="parameter"><code>values</code></em> or <em class="parameter"><code>length</code></em>. | |
35 | </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="errors"></a><h2>Errors</h2><p> | |
36 | <code class="constant">GL_INVALID_VALUE</code> is generated if <em class="parameter"><code>sync</code></em> is not the name of a sync object. | |
37 | </p><p> | |
38 | <code class="constant">GL_INVALID_ENUM</code> is generated if <em class="parameter"><code>pname</code></em> is not one of the accepted tokens. | |
39 | </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="seealso"></a><h2>See Also</h2><p> | |
40 | <a href="glFenceSync.xml"><span class="citerefentry"><span class="refentrytitle">glFenceSync</span></span></a>, | |
41 | <a href="glWaitSync.xml"><span class="citerefentry"><span class="refentrytitle">glWaitSync</span></span></a>, | |
42 | <a href="glClientWaitSync.xml"><span class="citerefentry"><span class="refentrytitle">glClientWaitSync</span></span></a> | |
43 | </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="Copyright"></a><h2>Copyright</h2><p> | |
44 | Copyright <span class="trademark"></span>© 2010 Khronos Group. | |
45 | This material may be distributed subject to the terms and conditions set forth in | |
46 | the Open Publication License, v 1.0, 8 June 1999. | |
47 | <a href="http://opencontent.org/openpub/" target="_top">http://opencontent.org/openpub/</a>. | |
48 | </p></div><div class="footnotes"><br /><hr width="100" align="left" /><div class="footnote"><p><sup>[<a id="ftn.id4816958" href="#id4816958">1</a>] </sup><em class="parameter"><code>flags</code></em> is | |
49 | expected to be used in future extensions to the sync objects.</p></div></div></div></body></html> |