upstream-man-pages/man4/glDeleteProgramPipelines.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="glDeleteProgramPipelines">
   5     <refmeta>
   6         <refmetainfo>
   7             <copyright>
   8                 <year>2010</year>
   9                 <holder>Khronos Group.</holder>
  10             </copyright>
  11         </refmetainfo>
  12         <refentrytitle>glDeleteProgramPipelines</refentrytitle>
  13         <manvolnum>3G</manvolnum>
  14     </refmeta>
  15     <refnamediv>
  16         <refname>glDeleteProgramPipelines</refname>
  17         <refpurpose>delete program pipeline objects</refpurpose>
  18     </refnamediv>
  19     <refsynopsisdiv><title>C Specification</title>
  20         <funcsynopsis>
  21             <funcprototype>
  22                 <funcdef>void <function>glDeleteProgramPipelines</function></funcdef>
  23                 <paramdef>GLsizei <parameter>n</parameter></paramdef>
  24                 <paramdef>const GLuint *<parameter>pipelines</parameter></paramdef>
  25             </funcprototype>
  26         </funcsynopsis>
  27     </refsynopsisdiv>
  28     <!-- eqn: ignoring delim $$ -->
  29     <refsect1 id="parameters"><title>Parameters</title>
  30         <variablelist>
  31         <varlistentry>
  32             <term><parameter>n</parameter></term>
  33             <listitem>
  34                 <para>
  35                     Specifies the number of program pipeline objects to delete.
  36                 </para>
  37             </listitem>
  38         </varlistentry>
  39         <varlistentry>
  40             <term><parameter>pipelines</parameter></term>
  41             <listitem>
  42                 <para>
  43                     Specifies an array of names of program pipeline objects to delete.
  44                 </para>
  45             </listitem>
  46         </varlistentry>
  47         </variablelist>
  48     </refsect1>
  49     <refsect1 id="description"><title>Description</title>
  50         <para>
  51             <function>glDeleteProgramPipelines</function> deletes the <parameter>n</parameter> program pipeline objects
  52             whose names are stored in the array <parameter>pipelines</parameter>. Unused names in <parameter>pipelines</parameter> are
  53             ignored, as is the name zero. After a program pipeline object is deleted, its name is again unused and it
  54             has no contents. If program pipeline object that is currently bound is deleted, the binding for that object reverts to
  55             zero and no program pipeline object becomes current.
  56         </para>
  57     </refsect1>
  58     <refsect1 id="associatedgets"><title>Associated Gets</title>
  59         <para>
  60             <citerefentry><refentrytitle>glGet</refentrytitle></citerefentry> with argument <constant>GL_PROGRAM_PIPELINE_BINDING</constant>
  61         </para>
  62     </refsect1>
  63     <refsect1 id="seealso"><title>See Also</title>
  64         <para>
  65             <citerefentry><refentrytitle>glGenProgramPipelines</refentrytitle></citerefentry>,
  66             <citerefentry><refentrytitle>glBindProgramPipeline</refentrytitle></citerefentry>,
  67             <citerefentry><refentrytitle>glIsProgramPipeline</refentrytitle></citerefentry>,
  68             <citerefentry><refentrytitle>glUseShaderPrograms</refentrytitle></citerefentry>,
  69             <citerefentry><refentrytitle>glUseProgram</refentrytitle></citerefentry>
  70         </para>
  71     </refsect1>
  72     <refsect1 id="Copyright"><title>Copyright</title>
  73         <para>
  74             Copyright <trademark class="copyright"></trademark> 2010 Khronos Group.
  75             This material may be distributed subject to the terms and conditions set forth in
  76             the Open Publication License, v 1.0, 8 June 1999.
  77             <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.
  78         </para>
  79     </refsect1>
  80 </refentry>