upstream-man-pages/man3/glDeleteRenderbuffers.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>glDeleteRenderbuffers</refentrytitle>
  13         <manvolnum>3G</manvolnum>
  14     </refmeta>
  15     <refnamediv>
  16         <refname>glDeleteRenderbuffers</refname>
  17         <refpurpose>delete renderbuffer objects</refpurpose>
  18     </refnamediv>
  19     <refsynopsisdiv><title>C Specification</title>
  20         <funcsynopsis>
  21             <funcprototype>
  22                 <funcdef>void <function>glDeleteRenderbuffers</function></funcdef>
  23                 <paramdef>GLsizei <parameter>n</parameter></paramdef>
  24                 <paramdef>GLuint *<parameter>renderbuffers</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 renderbuffer objects to be deleted.
  36                 </para>
  37             </listitem>
  38         </varlistentry>
  39         <varlistentry>
  40             <term><parameter>renderbuffers</parameter></term>
  41             <listitem>
  42                 <para>
  43                     A pointer to an array containing <parameter>n</parameter> renderbuffer 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>glDeleteRenderbuffers</function> deletes the <parameter>n</parameter> renderbuffer objects whose names are stored in
  52             the array addressed by <parameter>renderbuffers</parameter>. The name zero is reserved by the GL and is silently ignored, should it
  53             occur in <parameter>renderbuffers</parameter>, as are other unused names. Once a renderbuffer object is deleted, its name is again
  54             unused and it has no contents. If a renderbuffer that is currently bound to the target <constant>GL_RENDERBUFFER</constant>
  55             is deleted, it is as though <citerefentry><refentrytitle>glBindRenderbuffer</refentrytitle></citerefentry>
  56             had been executed with a <parameter>target</parameter> of <constant>GL_RENDERBUFFER</constant> and a <parameter>name</parameter> of zero.
  57         </para>
  58         <para>
  59             If a renderbuffer object is attached to one or more attachment points in the currently bound framebuffer, then it as if
  60             <citerefentry><refentrytitle>glFramebufferRenderbuffer</refentrytitle></citerefentry> had been called, with a <parameter>renderbuffer</parameter>
  61             of zero for each attachment point to which this image was attached in the currently bound framebuffer. In other words,
  62             this renderbuffer object is first detached from all attachment ponits in the currently bound framebuffer. Note that the renderbuffer
  63             image is specifically <emphasis>not</emphasis> detached from any non-bound framebuffers.
  64         </para>
  65     </refsect1>
  66     <refsect1 id="errors"><title>Errors</title>
  67         <para>
  68             <constant>GL_INVALID_VALUE</constant> is generated if <parameter>n</parameter> is negative.
  69         </para>
  70     </refsect1>
  71     <refsect1 id="seealso"><title>See Also</title>
  72         <para>
  73             <citerefentry><refentrytitle>glGenRenderbuffers</refentrytitle></citerefentry>,
  74             <citerefentry><refentrytitle>glFramebufferRenderbuffer</refentrytitle></citerefentry>,
  75             <citerefentry><refentrytitle>glRenderbufferStorage</refentrytitle></citerefentry>,
  76             <citerefentry><refentrytitle>glRenderbufferStorageMultisample</refentrytitle></citerefentry>
  77         </para>
  78     </refsect1>
  79     <refsect1 id="Copyright"><title>Copyright</title>
  80         <para>
  81             Copyright <trademark class="copyright"></trademark> 2010 Khronos Group.
  82             This material may be distributed subject to the terms and conditions set forth in
  83             the Open Publication License, v 1.0, 8 June 1999.
  84             <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.
  85         </para>
  86     </refsect1>
  87 </refentry>