Opentk/Source/Bind/Specifications/Docs/glIsSync.xml
2010-12-04 21:51:40 +00:00

68 lines
2.9 KiB
XML

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN"
"http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd">
<refentry id="glIsSync">
<refmeta>
<refmetainfo>
<copyright>
<year>2010</year>
<holder>Khronos Group</holder>
</copyright>
</refmetainfo>
<refentrytitle>glIsSync</refentrytitle>
<manvolnum>3G</manvolnum>
</refmeta>
<refnamediv>
<refname>glIsSync</refname>
<refpurpose>determine if a name corresponds to a sync object</refpurpose>
</refnamediv>
<refsynopsisdiv><title>C Specification</title>
<funcsynopsis>
<funcprototype>
<funcdef>GLboolean <function>glIsSync</function></funcdef>
<paramdef>GLsync <parameter>sync</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 id="parameters"><title>Parameters</title>
<variablelist>
<varlistentry>
<term><parameter>sync</parameter></term>
<listitem>
<para>
Specifies a value that may be the name of a sync object.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 id="description"><title>Description</title>
<para>
<function>glIsSync</function> returns <constant>GL_TRUE</constant> if <parameter>sync</parameter> is currently the name of a sync object.
If <parameter>sync</parameter> is not the name of a sync object, or if an error occurs, <function>glIsSync</function> returns
<constant>GL_FALSE</constant>. Note that zero is not the name of a sync object.
</para>
</refsect1>
<refsect1 id="notes"><title>Notes</title>
<para>
<function>glIsSync</function> is available only if the GL version is 3.2 or greater.
</para>
</refsect1>
<refsect1 id="seealso"><title>See Also</title>
<para>
<citerefentry><refentrytitle>glFenceSync</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>glWaitSync</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>glClientWaitSync</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>glDeleteSync</refentrytitle></citerefentry>
</para>
</refsect1>
<refsect1 id="Copyright"><title>Copyright</title>
<para>
Copyright <trademark class="copyright"></trademark> 2010 Khronos Group.
This material may be distributed subject to the terms and conditions set forth in
the Open Publication License, v 1.0, 8 June 1999.
<ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.
</para>
</refsect1>
</refentry>