upstream-man-pages/man3/glDeleteProgram.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="glDeleteProgram">
   5     <refmeta>
   6     <refentrytitle>glDeleteProgram</refentrytitle>
   7     <manvolnum>3G</manvolnum>
   8     </refmeta>
   9     <refnamediv>
  10     <refname>glDeleteProgram</refname>
  11     <refpurpose>Deletes a program object</refpurpose>
  12     </refnamediv>
  13     <refsynopsisdiv><title>C Specification</title>
  14     <funcsynopsis>
  15         <funcprototype>
  16         <funcdef>void <function>glDeleteProgram</function></funcdef>
  17         <paramdef>GLuint <parameter>program</parameter></paramdef>
  18         </funcprototype>
  19     </funcsynopsis>
  20     </refsynopsisdiv>
  21     <refsect1 id="parameters"><title>Parameters</title>
  22     <variablelist>
  23         <varlistentry>
  24         <term><parameter>program</parameter></term>
  25         <listitem>
  26             <para>Specifies the program object to be
  27             deleted.</para>
  28         </listitem>
  29         </varlistentry>
  30     </variablelist>
  31     </refsect1>
  32     <refsect1 id="description"><title>Description</title>
  33     <para><function>glDeleteProgram</function> frees the memory and
  34     invalidates the name associated with the program object
  35     specified by <parameter>program.</parameter> This command
  36     effectively undoes the effects of a call to
  37     <citerefentry><refentrytitle>glCreateProgram</refentrytitle></citerefentry>.</para>
  38
  39     <para>If a program object is in use as part of current rendering
  40     state, it will be flagged for deletion, but it will not be
  41     deleted until it is no longer part of current state for any
  42     rendering context. If a program object to be deleted has shader
  43     objects attached to it, those shader objects will be
  44     automatically detached but not deleted unless they have already
  45     been flagged for deletion by a previous call to
  46     <citerefentry><refentrytitle>glDeleteShader</refentrytitle></citerefentry>.
  47     A value of 0 for <parameter>program</parameter> will be silently
  48     ignored.</para>
  49
  50     <para>To determine whether a program object has been flagged for
  51     deletion, call
  52     <citerefentry><refentrytitle>glGetProgram</refentrytitle></citerefentry>
  53     with arguments <parameter>program</parameter> and
  54     <constant>GL_DELETE_STATUS</constant>.</para>
  55     </refsect1>
  56     <refsect1 id="errors"><title>Errors</title>
  57     <para><constant>GL_INVALID_VALUE</constant> is generated if
  58     <parameter>program</parameter> is not a value generated by
  59     OpenGL.</para>
  60
  61     </refsect1>
  62     <refsect1 id="associatedgets"><title>Associated Gets</title>
  63     <para><citerefentry><refentrytitle>glGet</refentrytitle></citerefentry>
  64     with argument <constant>GL_CURRENT_PROGRAM</constant></para>
  65
  66     <para><citerefentry><refentrytitle>glGetProgram</refentrytitle></citerefentry>
  67     with arguments <parameter>program</parameter> and
  68     <constant>GL_DELETE_STATUS</constant></para>
  69
  70     <para><citerefentry><refentrytitle>glIsProgram</refentrytitle></citerefentry></para>
  71     </refsect1>
  72     <refsect1 id="seealso"><title>See Also</title>
  73     <para><citerefentry><refentrytitle>glCreateShader</refentrytitle></citerefentry>,
  74     <citerefentry><refentrytitle>glDetachShader</refentrytitle></citerefentry>,
  75     <citerefentry><refentrytitle>glUseProgram</refentrytitle></citerefentry>
  76     </para>
  77     </refsect1>
  78     <refsect1 id="Copyright"><title>Copyright</title>
  79         <para>
  80             Copyright <trademark class="copyright"></trademark> 2003-2005 3Dlabs Inc. Ltd.
  81             This material may be distributed subject to the terms and conditions set forth in
  82             the Open Publication License, v 1.0, 8 June 1999.
  83             <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.
  84         </para>
  85     </refsect1>
  86 </refentry>