Opentk/Source/Bind/Specifications/Docs/ES31/glIsProgramPipeline.xml
2014-03-28 20:06:55 +01:00

84 lines
3.9 KiB
XML

<!DOCTYPE refentry [ <!ENTITY % mathent SYSTEM "math.ent"> %mathent; ]>
<!-- Converted by db4-upgrade version 1.1 -->
<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="glIsProgramPipeline">
<info>
<copyright>
<year>2010-2014</year>
<holder>Khronos Group</holder>
</copyright>
</info>
<refmeta>
<refentrytitle>glIsProgramPipeline</refentrytitle>
<manvolnum>3G</manvolnum>
</refmeta>
<refnamediv>
<refname>glIsProgramPipeline</refname>
<refpurpose>determine if a name corresponds to a program pipeline object</refpurpose>
</refnamediv>
<refsynopsisdiv>
<title>C Specification</title>
<funcsynopsis>
<funcprototype>
<funcdef>GLboolean <function>glIsProgramPipeline</function></funcdef>
<paramdef>GLuint <parameter>pipeline</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 xml:id="parameters"><title>Parameters</title>
<variablelist>
<varlistentry>
<term><parameter>pipeline</parameter></term>
<listitem>
<para>
Specifies a value that may be the name of a program pipeline object.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 xml:id="description"><title>Description</title>
<para>
<function>glIsProgramPipeline</function> returns <constant>GL_TRUE</constant> if
<parameter>pipeline</parameter> is currently the name of a program pipeline object.
If <parameter>pipeline</parameter> is zero, or if <constant>pipeline</constant> is not the
name of a program pipeline object, or if an error occurs, <function>glIsProgramPipeline</function>
returns <constant>GL_FALSE</constant>. If <parameter>pipeline</parameter> is a name returned by
<citerefentry><refentrytitle>glGenProgramPipelines</refentrytitle></citerefentry>, but that
has not yet been bound through a call to <citerefentry><refentrytitle>glBindProgramPipeline</refentrytitle></citerefentry>,
then the name is not a program pipeline object and <function>glIsProgramPipeline</function>
returns <constant>GL_FALSE</constant>.
</para>
</refsect1>
<refsect1 xml:id="versions">
<title>API Version Support</title>
<informaltable>
<tgroup cols="4" align="left">
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="apifunchead.xml" xpointer="xpointer(/*/*)"/>
<tbody>
<row>
<entry><function>glIsProgramPipeline</function></entry>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="apiversion.xml" xpointer="xpointer(/*/*[@role='es31']/*)"/>
</row>
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 xml:id="seealso"><title>See Also</title>
<para>
<citerefentry><refentrytitle>glGenProgramPipelines</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>glBindProgramPipeline</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>glDeleteProgramPipeline</refentrytitle></citerefentry>
</para>
</refsect1>
<refsect1 xml:id="Copyright"><title>Copyright</title>
<para>
Copyright <trademark class="copyright"/> 2010-2014 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.
<link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://opencontent.org/openpub/">http://opencontent.org/openpub/</link>.
</para>
</refsect1>
</refentry>