Commit | Line | Data |
---|---|---|
7faf1d71 AW |
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>glRenderbufferStorageMultisample - 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="glRenderbufferStorageMultisample"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>glRenderbufferStorageMultisample — establish data storage, format, dimensions and sample count 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">glRenderbufferStorageMultisample</b>(</code></td><td>GLenum </td><td><var class="pdparam">target</var>, </td></tr><tr><td> </td><td>GLsizei </td><td><var class="pdparam">samples</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>samples</code></em></span></dt><dd><p> | |
7 | Specifies the number of samples to be used for the renderbuffer object's storage. | |
8 | </p></dd><dt><span class="term"><em class="parameter"><code>internalformat</code></em></span></dt><dd><p> | |
9 | Specifies the internal format to use for the renderbuffer object's image. | |
10 | </p></dd><dt><span class="term"><em class="parameter"><code>width</code></em></span></dt><dd><p> | |
11 | Specifies the width of the renderbuffer, in pixels. | |
12 | </p></dd><dt><span class="term"><em class="parameter"><code>height</code></em></span></dt><dd><p> | |
13 | Specifies the height of the renderbuffer, in pixels. | |
14 | </p></dd></dl></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="description"></a><h2>Description</h2><p> | |
15 | <code class="function">glRenderbufferStorageMultisample</code> establishes the data storage, format, dimensions and number of | |
16 | samples of a renderbuffer object's image. | |
17 | </p><p> | |
18 | The target of the operation, specified by <em class="parameter"><code>target</code></em> must be <code class="constant">GL_RENDERBUFFER</code>. | |
19 | <em class="parameter"><code>internalformat</code></em> specifies the internal format to be used for the renderbuffer object's storage and | |
20 | must be a color-renderable, depth-renderable, or stencil-renderable format. | |
21 | <em class="parameter"><code>width</code></em> and <em class="parameter"><code>height</code></em> are the dimensions, in pixels, of the renderbuffer. | |
22 | 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 | |
23 | <code class="constant">GL_MAX_RENDERBUFFER_SIZE</code>. <em class="parameter"><code>samples</code></em> specifies the number of samples to be used | |
24 | for the renderbuffer object's image, and must be less than or equal to the value of <code class="constant">GL_MAX_SAMPLES</code>. | |
25 | If <em class="parameter"><code>internalformat</code></em> is a signed or unsigned integer format then <em class="parameter"><code>samples</code></em> must be | |
26 | less than or equal to the value of <code class="constant">GL_MAX_INTEGER_SAMPLES</code>. | |
27 | </p><p> | |
28 | Upon success, <code class="function">glRenderbufferStorageMultisample</code> deletes any existing data store for the renderbuffer | |
29 | image and the contents of the data store after calling <code class="function">glRenderbufferStorageMultisample</code> are undefined. | |
30 | </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="errors"></a><h2>Errors</h2><p> | |
31 | <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>. | |
32 | </p><p> | |
33 | <code class="constant">GL_INVALID_VALUE</code> is generated if <em class="parameter"><code>samples</code></em> is greater than <code class="constant">GL_MAX_SAMPLES</code>. | |
34 | </p><p> | |
35 | <code class="constant">GL_INVALID_ENUM</code> is generated if <em class="parameter"><code>internalformat</code></em> is not a color-renderable, depth-renderable, | |
36 | or stencil-renderable format. | |
37 | </p><p> | |
38 | <code class="constant">GL_INVALID_OPERATION</code> is generated if <em class="parameter"><code>internalformat</code></em> is a signed or unsigned integer format | |
39 | and <em class="parameter"><code>samples</code></em> is greater than the value of <code class="constant">GL_MAX_INTEGER_SAMPLES</code> | |
40 | </p><p> | |
41 | <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, | |
42 | or greater than the value of <code class="constant">GL_MAX_RENDERBUFFER_SIZE</code>. | |
43 | </p><p> | |
44 | <code class="constant">GL_OUT_OF_MEMORY</code> is generated if the GL is unable to create a data store of the requested size. | |
45 | </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="seealso"></a><h2>See Also</h2><p> | |
46 | <a href="glGenRenderbuffers.xml"><span class="citerefentry"><span class="refentrytitle">glGenRenderbuffers</span></span></a>, | |
47 | <a href="glBindRenderbuffer.xml"><span class="citerefentry"><span class="refentrytitle">glBindRenderbuffer</span></span></a>, | |
48 | <a href="glRenderbufferStorage.xml"><span class="citerefentry"><span class="refentrytitle">glRenderbufferStorage</span></span></a>, | |
49 | <a href="glFramebufferRenderbuffer.xml"><span class="citerefentry"><span class="refentrytitle">glFramebufferRenderbuffer</span></span></a>, | |
50 | <a href="glDeleteRenderbuffers.xml"><span class="citerefentry"><span class="refentrytitle">glDeleteRenderbuffers</span></span></a> | |
51 | </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="Copyright"></a><h2>Copyright</h2><p> | |
52 | Copyright <span class="trademark"></span>© 2010 Khronos Group. | |
53 | This material may be distributed subject to the terms and conditions set forth in | |
54 | the Open Publication License, v 1.0, 8 June 1999. | |
55 | <a href="http://opencontent.org/openpub/" target="_top">http://opencontent.org/openpub/</a>. | |
56 | </p></div></div></body></html> |