upstream-doc/man3/xhtml/glDeleteRenderbuffers.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "xhtml1-transitional.dtd">
   3 <!-- saved from url=(0013)about:internet -->
   4 <?xml-stylesheet type="text/xsl" href="mathml.xsl"?><html xmlns="http://www.w3.org/1999/xhtml" xmlns:pref="http://www.w3.org/2002/Math/preference" pref:renderer="mathplayer-dl"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><link rel="stylesheet" type="text/css" href="opengl-man.css" /><title>glDeleteRenderbuffers</title><meta name="generator" content="DocBook XSL Stylesheets V1.75.2" /></head><body><div class="refentry" title="glDeleteRenderbuffers"><a id="glDeleteFramebuffers"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>glDeleteRenderbuffers — delete renderbuffer objects</p></div><div class="refsynopsisdiv" title="C Specification"><h2>C Specification</h2><div class="funcsynopsis"><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table"><tr><td><code class="funcdef">void <b class="fsfunc">glDeleteRenderbuffers</b>(</code></td><td>GLsizei <var class="pdparam">n</var>, </td></tr><tr><td> </td><td>GLuint *<var class="pdparam">renderbuffers</var><code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div></div></div><div class="refsect1" title="Parameters"><a id="parameters"></a><h2>Parameters</h2><div class="variablelist"><dl><dt><span class="term"><em class="parameter"><code>n</code></em></span></dt><dd><p>
   5                     Specifies the number of renderbuffer objects to be deleted.
   6                 </p></dd><dt><span class="term"><em class="parameter"><code>renderbuffers</code></em></span></dt><dd><p>
   7                     A pointer to an array containing <em class="parameter"><code>n</code></em> renderbuffer objects to be deleted.
   8                 </p></dd></dl></div></div><div class="refsect1" title="Description"><a id="description"></a><h2>Description</h2><p>
   9             <code class="function">glDeleteRenderbuffers</code> deletes the <em class="parameter"><code>n</code></em> renderbuffer objects whose names are stored in
  10             the array addressed by <em class="parameter"><code>renderbuffers</code></em>. The name zero is reserved by the GL and is silently ignored, should it
  11             occur in <em class="parameter"><code>renderbuffers</code></em>, as are other unused names. Once a renderbuffer object is deleted, its name is again
  12             unused and it has no contents. If a renderbuffer that is currently bound to the target <code class="constant">GL_RENDERBUFFER</code>
  13             is deleted, it is as though <a class="citerefentry" href="glBindRenderbuffer.xml"><span class="citerefentry"><span class="refentrytitle">glBindRenderbuffer</span></span></a>
  14             had been executed with a <em class="parameter"><code>target</code></em> of <code class="constant">GL_RENDERBUFFER</code> and a <em class="parameter"><code>name</code></em> of zero.
  15         </p><p>
  16             If a renderbuffer object is attached to one or more attachment points in the currently bound framebuffer, then it as if
  17             <a class="citerefentry" href="glFramebufferRenderbuffer.xml"><span class="citerefentry"><span class="refentrytitle">glFramebufferRenderbuffer</span></span></a> had been called, with a <em class="parameter"><code>renderbuffer</code></em>
  18             of zero for each attachment point to which this image was attached in the currently bound framebuffer. In other words,
  19             this renderbuffer object is first detached from all attachment ponits in the currently bound framebuffer. Note that the renderbuffer
  20             image is specifically <span class="emphasis"><em>not</em></span> detached from any non-bound framebuffers.
  21         </p></div><div class="refsect1" title="Errors"><a id="errors"></a><h2>Errors</h2><p>
  22             <code class="constant">GL_INVALID_VALUE</code> is generated if <em class="parameter"><code>n</code></em> is negative.
  23         </p></div><div class="refsect1" title="See Also"><a id="seealso"></a><h2>See Also</h2><p>
  24             <a class="citerefentry" href="glGenRenderbuffers.xml"><span class="citerefentry"><span class="refentrytitle">glGenRenderbuffers</span></span></a>,
  25             <a class="citerefentry" href="glFramebufferRenderbuffer.xml"><span class="citerefentry"><span class="refentrytitle">glFramebufferRenderbuffer</span></span></a>,
  26             <a class="citerefentry" href="glRenderbufferStorage.xml"><span class="citerefentry"><span class="refentrytitle">glRenderbufferStorage</span></span></a>,
  27             <a class="citerefentry" href="glRenderbufferStorageMultisample.xml"><span class="citerefentry"><span class="refentrytitle">glRenderbufferStorageMultisample</span></span></a>
  28         </p></div><div class="refsect1" title="Copyright"><a id="Copyright"></a><h2>Copyright</h2><p>
  29             Copyright <span class="trademark"></span>© 2010 Khronos Group.
  30             This material may be distributed subject to the terms and conditions set forth in
  31             the Open Publication License, v 1.0, 8 June 1999.
  32             <a class="ulink" href="http://opencontent.org/openpub/" target="_top">http://opencontent.org/openpub/</a>.
  33         </p></div></div></body></html>