upstream-man-pages/man3/glDeleteFramebuffers.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="glDeleteFramebuffers">
   5     <refmeta>
   6         <refmetainfo>
   7             <copyright>
   8                 <year>2010</year>
   9                 <holder>Khronos Group</holder>
  10             </copyright>
  11         </refmetainfo>
  12         <refentrytitle>glDeleteFramebuffers</refentrytitle>
  13         <manvolnum>3G</manvolnum>
  14     </refmeta>
  15     <refnamediv>
  16         <refname>glDeleteFramebuffers</refname>
  17         <refpurpose>delete framebuffer objects</refpurpose>
  18     </refnamediv>
  19     <refsynopsisdiv><title>C Specification</title>
  20         <funcsynopsis>
  21             <funcprototype>
  22                 <funcdef>void <function>glDeleteFramebuffers</function></funcdef>
  23                 <paramdef>GLsizei <parameter>n</parameter></paramdef>
  24                 <paramdef>GLuint *<parameter>framebuffers</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 framebuffer objects to be deleted.
  36                 </para>
  37             </listitem>
  38         </varlistentry>
  39         <varlistentry>
  40             <term><parameter>framebuffers</parameter></term>
  41             <listitem>
  42                 <para>
  43                     A pointer to an array containing <parameter>n</parameter> framebuffer objects to be deleted.
  44                 </para>
  45             </listitem>
  46         </varlistentry>
  47         </variablelist>
  48     </refsect1>
  49     <refsect1 id="description"><title>Description</title>
  50         <para>
  51             <function>glDeleteFramebuffers</function> deletes the <parameter>n</parameter> framebuffer objects whose names are stored in
  52             the array addressed by <parameter>framebuffers</parameter>. The name zero is reserved by the GL and is silently ignored, should it
  53             occur in <parameter>framebuffers</parameter>, as are other unused names. Once a framebuffer object is deleted, its name is again
  54             unused and it has no attachments. If a framebuffer that is currently bound to one or more of the targets <constant>GL_DRAW_FRAMEBUFFER</constant>
  55             or <constant>GL_READ_FRAMEBUFFER</constant> is deleted, it is as though <citerefentry><refentrytitle>glBindFramebuffer</refentrytitle></citerefentry>
  56             had been executed with the corresponding <parameter>target</parameter> and <parameter>framebuffer</parameter> zero.
  57         </para>
  58     </refsect1>
  59     <refsect1 id="errors"><title>Errors</title>
  60         <para>
  61             <constant>GL_INVALID_VALUE</constant> is generated if <parameter>n</parameter> is negative.
  62         </para>
  63     </refsect1>
  64     <refsect1 id="seealso"><title>See Also</title>
  65         <para>
  66             <citerefentry><refentrytitle>glGenFramebuffers</refentrytitle></citerefentry>,
  67             <citerefentry><refentrytitle>glBindFramebuffer</refentrytitle></citerefentry>,
  68             <citerefentry><refentrytitle>glCheckFramebufferStatus</refentrytitle></citerefentry>
  69         </para>
  70     </refsect1>
  71     <refsect1 id="Copyright"><title>Copyright</title>
  72         <para>
  73             Copyright <trademark class="copyright"></trademark> 2010 Khronos Group.
  74             This material may be distributed subject to the terms and conditions set forth in
  75             the Open Publication License, v 1.0, 8 June 1999.
  76             <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.
  77         </para>
  78     </refsect1>
  79 </refentry>