upstream-man-pages/man4/glDeleteBuffers.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="glDeleteBuffers">
   5     <refmeta>
   6         <refmetainfo>
   7             <copyright>
   8                 <year>2005</year>
   9                 <holder>Sams Publishing</holder>
  10             </copyright>
  11         </refmetainfo>
  12         <refentrytitle>glDeleteBuffers</refentrytitle>
  13         <manvolnum>3G</manvolnum>
  14     </refmeta>
  15     <refnamediv>
  16         <refname>glDeleteBuffers</refname>
  17         <refpurpose>delete named buffer objects</refpurpose>
  18     </refnamediv>
  19     <refsynopsisdiv><title>C Specification</title>
  20         <funcsynopsis>
  21             <funcprototype>
  22                 <funcdef>void <function>glDeleteBuffers</function></funcdef>
  23                 <paramdef>GLsizei <parameter>n</parameter></paramdef>
  24                 <paramdef>const GLuint * <parameter>buffers</parameter></paramdef>
  25             </funcprototype>
  26         </funcsynopsis>
  27     </refsynopsisdiv>
  28     <refsect1 id="parameters"><title>Parameters</title>
  29         <variablelist>
  30         <varlistentry>
  31             <term><parameter>n</parameter></term>
  32             <listitem>
  33                 <para>
  34                     Specifies the number of buffer objects to be deleted.
  35                 </para>
  36             </listitem>
  37         </varlistentry>
  38         <varlistentry>
  39             <term><parameter>buffers</parameter></term>
  40             <listitem>
  41                 <para>
  42                     Specifies an array of buffer objects to be deleted.
  43                 </para>
  44             </listitem>
  45         </varlistentry>
  46         </variablelist>
  47     </refsect1>
  48     <refsect1 id="description"><title>Description</title>
  49         <para>
  50             <function>glDeleteBuffers</function> deletes <parameter>n</parameter> buffer objects named by the elements of the array <parameter>buffers</parameter>.
  51             After a buffer object is deleted, it has no contents,
  52             and its name is free for reuse (for example by <citerefentry><refentrytitle>glGenBuffers</refentrytitle></citerefentry>).
  53             If a buffer object that is currently bound is deleted, the binding reverts
  54             to 0 (the absence of any buffer object).
  55         </para>
  56         <para>
  57             <function>glDeleteBuffers</function> silently ignores 0's and names that do not correspond to
  58             existing buffer objects.
  59         </para>
  60     </refsect1>
  61     <refsect1 id="errors"><title>Errors</title>
  62         <para>
  63             <constant>GL_INVALID_VALUE</constant> is generated if <parameter>n</parameter> is negative.
  64         </para>
  65     </refsect1>
  66     <refsect1 id="associatedgets"><title>Associated Gets</title>
  67         <para>
  68             <citerefentry><refentrytitle>glIsBuffer</refentrytitle></citerefentry>
  69         </para>
  70     </refsect1>
  71     <refsect1 id="seealso"><title>See Also</title>
  72         <para>
  73             <citerefentry><refentrytitle>glBindBuffer</refentrytitle></citerefentry>,
  74             <citerefentry><refentrytitle>glGenBuffers</refentrytitle></citerefentry>,
  75             <citerefentry><refentrytitle>glGet</refentrytitle></citerefentry>
  76         </para>
  77     </refsect1>
  78     <refsect1 id="Copyright"><title>Copyright</title>
  79         <para>
  80             Copyright <trademark class="copyright"></trademark> 2005 Addison-Wesley.
  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>