upstream-doc/man4/glGenProgramPipelines.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="glGenProgramPipelines">
   5     <refmeta>
   6         <refmetainfo>
   7             <copyright>
   8                 <year>2010</year>
   9                 <holder>Khronos Group.</holder>
  10             </copyright>
  11         </refmetainfo>
  12         <refentrytitle>glGenProgramPipelines</refentrytitle>
  13         <manvolnum>3G</manvolnum>
  14     </refmeta>
  15     <refnamediv>
  16         <refname>glGenProgramPipelines</refname>
  17         <refpurpose>reserve program pipeline object names</refpurpose>
  18     </refnamediv>
  19     <refsynopsisdiv><title>C Specification</title>
  20         <funcsynopsis>
  21             <funcprototype>
  22                 <funcdef>void <function>glGenProgramPipelines</function></funcdef>
  23                 <paramdef>GLsizei <parameter>n</parameter></paramdef>
  24                 <paramdef>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 object names to reserve.
  36                 </para>
  37             </listitem>
  38         </varlistentry>
  39         <varlistentry>
  40             <term><parameter>pipelines</parameter></term>
  41             <listitem>
  42                 <para>
  43                     Specifies an array of into which the reserved names will be written.
  44                 </para>
  45             </listitem>
  46         </varlistentry>
  47         </variablelist>
  48     </refsect1>
  49     <refsect1 id="description"><title>Description</title>
  50         <para>
  51             <function>glGenProgramPipelines</function> returns <parameter>n</parameter> previously unused
  52             program pipeline object names in <parameter>pipelines</parameter>. These names are marked as used,
  53             for the purposes of <function>glGenProgramPipelines</function> only, but they
  54             acquire program pipeline state only when they are first bound.
  55         </para>
  56     </refsect1>
  57     <refsect1 id="associatedgets"><title>Associated Gets</title>
  58         <para>
  59             <citerefentry><refentrytitle>glGet</refentrytitle></citerefentry> with argument <constant>GL_PROGRAM_PIPELINE_BINDING</constant>
  60         </para>
  61         <para>
  62             <citerefentry><refentrytitle>glIsProgramPipeline</refentrytitle></citerefentry>
  63         </para>
  64     </refsect1>
  65     <refsect1 id="seealso"><title>See Also</title>
  66         <para>
  67             <citerefentry><refentrytitle>glDeleteProgramPipelines</refentrytitle></citerefentry>,
  68             <citerefentry><refentrytitle>glBindProgramPipeline</refentrytitle></citerefentry>,
  69             <citerefentry><refentrytitle>glIsProgramPipeline</refentrytitle></citerefentry>,
  70             <citerefentry><refentrytitle>glUseShaderPrograms</refentrytitle></citerefentry>,
  71             <citerefentry><refentrytitle>glUseProgram</refentrytitle></citerefentry>
  72         </para>
  73     </refsect1>
  74     <refsect1 id="Copyright"><title>Copyright</title>
  75         <para>
  76             Copyright <trademark class="copyright"></trademark> 2010 Khronos Group.
  77             This material may be distributed subject to the terms and conditions set forth in
  78             the Open Publication License, v 1.0, 8 June 1999.
  79             <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.
  80         </para>
  81     </refsect1>
  82 </refentry>