47b968266fa635de3a1007df9bf3737b04022ab4
[clinton/guile-figl.git] / upstream-man-pages / man4 / xhtml / glRenderbufferStorage.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>glRenderbufferStorage - OpenGL 4 Reference Pages</title><meta name="generator" content="DocBook XSL Stylesheets V1.69.1" /></head><body><div class="refentry" lang="en" xml:lang="en"><a id="glRenderbufferStorage"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>glRenderbufferStorage — establish data storage, format and dimensions of a renderbuffer object's image</p></div><div class="refsynopsisdiv"><h2>C Specification</h2><div class="funcsynopsis"><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0"><tr><td><code class="funcdef">void <b class="fsfunc">glRenderbufferStorage</b>(</code></td><td>GLenum  </td><td><var class="pdparam">target</var>, </td></tr><tr><td> </td><td>GLenum  </td><td><var class="pdparam">internalformat</var>, </td></tr><tr><td> </td><td>GLsizei  </td><td><var class="pdparam">width</var>, </td></tr><tr><td> </td><td>GLsizei  </td><td><var class="pdparam">height</var><code>)</code>;</td></tr></table></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="parameters"></a><h2>Parameters</h2><div class="variablelist"><dl><dt><span class="term"><em class="parameter"><code>target</code></em></span></dt><dd><p>
5 Specifies a binding to which the target of the allocation and must be <code class="constant">GL_RENDERBUFFER</code>.
6 </p></dd><dt><span class="term"><em class="parameter"><code>internalformat</code></em></span></dt><dd><p>
7 Specifies the internal format to use for the renderbuffer object's image.
8 </p></dd><dt><span class="term"><em class="parameter"><code>width</code></em></span></dt><dd><p>
9 Specifies the width of the renderbuffer, in pixels.
10 </p></dd><dt><span class="term"><em class="parameter"><code>height</code></em></span></dt><dd><p>
11 Specifies the height of the renderbuffer, in pixels.
12 </p></dd></dl></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="description"></a><h2>Description</h2><p>
13 <code class="function">glRenderbufferStorage</code> is equivalent to calling
14 <a href="glRenderbufferStorageMultisample.xml"><span class="citerefentry"><span class="refentrytitle">glRenderbufferStorageMultisample</span></span></a> with the
15 <em class="parameter"><code>samples</code></em> set to zero.
16 </p><p>
17 The target of the operation, specified by <em class="parameter"><code>target</code></em> must be <code class="constant">GL_RENDERBUFFER</code>.
18 <em class="parameter"><code>internalformat</code></em> specifies the internal format to be used for the renderbuffer object's storage and
19 must be a color-renderable, depth-renderable, or stencil-renderable format.
20 <em class="parameter"><code>width</code></em> and <em class="parameter"><code>height</code></em> are the dimensions, in pixels, of the renderbuffer.
21 Both <em class="parameter"><code>width</code></em> and <em class="parameter"><code>height</code></em> must be less than or equal to the value of
22 <code class="constant">GL_MAX_RENDERBUFFER_SIZE</code>.
23 </p><p>
24 Upon success, <code class="function">glRenderbufferStorage</code> deletes any existing data store for the renderbuffer
25 image and the contents of the data store after calling <code class="function">glRenderbufferStorage</code> are undefined.
26 </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="errors"></a><h2>Errors</h2><p>
27 <code class="constant">GL_INVALID_ENUM</code> is generated if <em class="parameter"><code>target</code></em> is not <code class="constant">GL_RENDERBUFFER</code>.
28 </p><p>
29 <code class="constant">GL_INVALID_VALUE</code> is generated if either of <em class="parameter"><code>width</code></em> or <em class="parameter"><code>height</code></em> is negative,
30 or greater than the value of <code class="constant">GL_MAX_RENDERBUFFER_SIZE</code>.
31 </p><p>
32 <code class="constant">GL_INVALID_ENUM</code> is generated if <em class="parameter"><code>internalformat</code></em> is not a color-renderable, depth-renderable,
33 or stencil-renderable format.
34 </p><p>
35 <code class="constant">GL_OUT_OF_MEMORY</code> is generated if the GL is unable to create a data store of the requested size.
36 </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="seealso"></a><h2>See Also</h2><p>
37 <a href="glGenRenderbuffers.xml"><span class="citerefentry"><span class="refentrytitle">glGenRenderbuffers</span></span></a>,
38 <a href="glBindRenderbuffer.xml"><span class="citerefentry"><span class="refentrytitle">glBindRenderbuffer</span></span></a>,
39 <a href="glRenderbufferStorageMultisample.xml"><span class="citerefentry"><span class="refentrytitle">glRenderbufferStorageMultisample</span></span></a>,
40 <a href="glFramebufferRenderbuffer.xml"><span class="citerefentry"><span class="refentrytitle">glFramebufferRenderbuffer</span></span></a>,
41 <a href="glDeleteRenderbuffers.xml"><span class="citerefentry"><span class="refentrytitle">glDeleteRenderbuffers</span></span></a>
42 </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="Copyright"></a><h2>Copyright</h2><p>
43 Copyright <span class="trademark"></span>© 2010 Khronos Group.
44 This material may be distributed subject to the terms and conditions set forth in
45 the Open Publication License, v 1.0, 8 June 1999.
46 <a href="http://opencontent.org/openpub/" target="_top">http://opencontent.org/openpub/</a>.
47 </p></div></div></body></html>