upstream-man-pages/man4/glValidateProgramPipeline.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="glValidateProgramPipeline">
   5     <refmeta>
   6         <refmetainfo>
   7             <copyright>
   8                 <year>2010</year>
   9                 <holder>Khronos Group</holder>
  10             </copyright>
  11         </refmetainfo>
  12         <refentrytitle>glValidateProgramPipeline</refentrytitle>
  13         <manvolnum>3G</manvolnum>
  14     </refmeta>
  15     <refnamediv>
  16         <refname>glValidateProgramPipeline</refname>
  17         <refpurpose>validate a program pipeline object against current GL state</refpurpose>
  18     </refnamediv>
  19     <refsynopsisdiv><title>C Specification</title>
  20         <funcsynopsis>
  21             <funcprototype>
  22                 <funcdef>void <function>glValidateProgramPipeline</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 the name of a program pipeline object to validate.
  34             </para>
  35             </listitem>
  36         </varlistentry>
  37         </variablelist>
  38     </refsect1>
  39     <refsect1 id="description"><title>Description</title>
  40         <para>
  41             <function>glValidateProgramPipeline</function> instructs the implementation to validate the
  42             shader executables contained in <parameter>pipeline</parameter> against the current GL state.
  43             The implementation may use this as an opportunity to perform any internal shader modifications
  44             that may be required to ensure correct operation of the installed shaders given the
  45             current GL state.
  46         </para>
  47         <para>
  48             After a program pipeline has been validated, its validation status is set to <constant>GL_TRUE</constant>.
  49             The validation status of a program pipeline object may be queried by calling
  50             <citerefentry><refentrytitle>glGetProgramPipeline</refentrytitle></citerefentry> with
  51             parameter <constant>GL_VALIDATE_STATUS</constant>.
  52         </para>
  53         <para>
  54             If <parameter>pipeline</parameter> is a name previously returned from a call to
  55             <citerefentry><refentrytitle>glGenProgramPipelines</refentrytitle></citerefentry> but
  56             that has not yet been bound by a call to <citerefentry><refentrytitle>glBindProgramPipeline</refentrytitle></citerefentry>,
  57             a new program pipeline object is created with name <parameter>pipeline</parameter> and
  58             the default state vector.
  59         </para>
  60     </refsect1>
  61     <refsect1 id="errors"><title>Errors</title>
  62         <para>
  63             <constant>GL_INVALID_OPERATION</constant> is generated if <parameter>pipeline</parameter> is not
  64             a name previously returned from a call to <citerefentry><refentrytitle>glGenProgramPipelines</refentrytitle></citerefentry>
  65             or if such a name has been deleted by a call to
  66             <citerefentry><refentrytitle>glDeleteProgramPipelines</refentrytitle></citerefentry>.
  67         </para>
  68     </refsect1>
  69     <refsect1 id="associatedgets"><title>Associated Gets</title>
  70         <para>
  71             <citerefentry><refentrytitle>glGetProgramPipeline</refentrytitle></citerefentry>
  72             with parameter <constant>GL_VALIDATE_STATUS</constant>.
  73         </para>
  74     </refsect1>
  75
  76     <refsect1 id="seealso"><title>See Also</title>
  77         <para>
  78             <citerefentry><refentrytitle>glGenProgramPipelines</refentrytitle></citerefentry>,
  79             <citerefentry><refentrytitle>glBindProgramPipeline</refentrytitle></citerefentry>,
  80             <citerefentry><refentrytitle>glDeleteProgramPipelines</refentrytitle></citerefentry>
  81         </para>
  82     </refsect1>
  83     <refsect1 id="Copyright"><title>Copyright</title>
  84         <para>
  85             Copyright <trademark class="copyright"></trademark> 2010 Khronos Group.
  86             This material may be distributed subject to the terms and conditions set forth in
  87             the Open Publication License, v 1.0, 8 June 1999.
  88             <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.
  89         </para>
  90     </refsect1>
  91 </refentry>