upstream-man-pages/man4/glIsProgramPipeline.xml

   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="glIsProgramPipeline">
   5     <refmeta>
   6         <refmetainfo>
   7             <copyright>
   8                 <year>2010</year>
   9                 <holder>Khronos Group</holder>
  10             </copyright>
  11         </refmetainfo>
  12         <refentrytitle>glIsProgramPipeline</refentrytitle>
  13         <manvolnum>3G</manvolnum>
  14     </refmeta>
  15     <refnamediv>
  16         <refname>glIsProgramPipeline</refname>
  17         <refpurpose>determine if a name corresponds to a program pipeline object</refpurpose>
  18     </refnamediv>
  19     <refsynopsisdiv><title>C Specification</title>
  20         <funcsynopsis>
  21             <funcprototype>
  22                 <funcdef>GLboolean <function>glIsProgramPipeline</function></funcdef>
  23                 <paramdef>GLuint <parameter>pipeline</parameter></paramdef>
  24             </funcprototype>
  25         </funcsynopsis>
  26     </refsynopsisdiv>
  27     <refsect1 id="parameters"><title>Parameters</title>
  28         <variablelist>
  29         <varlistentry>
  30             <term><parameter>pipeline</parameter></term>
  31             <listitem>
  32                 <para>
  33                     Specifies a value that may be the name of a program pipeline object.
  34                 </para>
  35             </listitem>
  36         </varlistentry>
  37         </variablelist>
  38     </refsect1>
  39     <refsect1 id="description"><title>Description</title>
  40         <para>
  41             <function>glIsProgramPipeline</function> returns <constant>GL_TRUE</constant> if
  42             <parameter>pipeline</parameter> is currently the name of a program pipeline object.
  43             If <parameter>pipeline</parameter> is zero, or if <constant>pipeline</constant> is not the
  44             name of a program pipeline object, or if an error occurs, <function>glIsProgramPipeline</function>
  45             returns <constant>GL_FALSE</constant>. If <parameter>pipeline</parameter> is a name returned by
  46             <citerefentry><refentrytitle>glGenProgramPipelines</refentrytitle></citerefentry>, but that
  47             has not yet been bound through a call to <citerefentry><refentrytitle>glBindProgramPipeline</refentrytitle></citerefentry>,
  48             then the name is not a program pipeline object and <function>glIsProgramPipeline</function>
  49             returns <constant>GL_FALSE</constant>.
  50         </para>
  51     </refsect1>
  52     <refsect1 id="seealso"><title>See Also</title>
  53         <para>
  54             <citerefentry><refentrytitle>glGenProgramPipelines</refentrytitle></citerefentry>,
  55             <citerefentry><refentrytitle>glBindProgramPipeline</refentrytitle></citerefentry>,
  56             <citerefentry><refentrytitle>glDeleteProgramPipeline</refentrytitle></citerefentry>
  57         </para>
  58     </refsect1>
  59     <refsect1 id="Copyright"><title>Copyright</title>
  60         <para>
  61             Copyright <trademark class="copyright"></trademark> 2010 Khronos Group.
  62             This material may be distributed subject to the terms and conditions set forth in
  63             the Open Publication License, v 1.0, 8 June 1999.
  64             <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.
  65         </para>
  66     </refsect1>
  67 </refentry>