1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
|
<!DOCTYPE refentry [ <!ENTITY % mathent SYSTEM "math.ent"> %mathent; ]>
<!-- Converted by db4-upgrade version 1.1 -->
<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="glRenderbufferStorageMultisample">
<info>
<copyright>
<year>2010-2014</year>
<holder>Khronos Group</holder>
</copyright>
</info>
<refmeta>
<refentrytitle>glRenderbufferStorageMultisample</refentrytitle>
<manvolnum>3G</manvolnum>
</refmeta>
<refnamediv>
<refname>glRenderbufferStorageMultisample</refname>
<refname>glNamedRenderbufferStorageMultisample</refname>
<refpurpose>establish data storage, format, dimensions and sample count of
a renderbuffer object's image</refpurpose>
</refnamediv>
<refsynopsisdiv>
<title>C Specification</title>
<funcsynopsis>
<funcprototype>
<funcdef>void <function>glRenderbufferStorageMultisample</function></funcdef>
<paramdef>GLenum <parameter>target</parameter></paramdef>
<paramdef>GLsizei <parameter>samples</parameter></paramdef>
<paramdef>GLenum <parameter>internalformat</parameter></paramdef>
<paramdef>GLsizei <parameter>width</parameter></paramdef>
<paramdef>GLsizei <parameter>height</parameter></paramdef>
</funcprototype>
<funcprototype>
<funcdef>void <function>glNamedRenderbufferStorageMultisample</function></funcdef>
<paramdef>GLuint <parameter>renderbuffer</parameter></paramdef>
<paramdef>GLsizei <parameter>samples</parameter></paramdef>
<paramdef>GLenum <parameter>internalformat</parameter></paramdef>
<paramdef>GLsizei <parameter>width</parameter></paramdef>
<paramdef>GLsizei <parameter>height</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 xml:id="parameters">
<title>Parameters</title>
<variablelist>
<varlistentry>
<term><parameter>target</parameter></term>
<listitem>
<para>Specifies a binding target of the allocation for
<function>glRenderbufferStorageMultisample</function> function. Must
be <constant>GL_RENDERBUFFER</constant>.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>renderbuffer</parameter></term>
<listitem>
<para>Specifies the name of the renderbuffer object for
<function>glNamedRenderbufferStorageMultisample</function>
function.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>samples</parameter></term>
<listitem>
<para>Specifies the number of samples to be used for the
renderbuffer object's storage.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>internalformat</parameter></term>
<listitem>
<para>Specifies the internal format to use for the renderbuffer
object's image.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>width</parameter></term>
<listitem>
<para>Specifies the width of the renderbuffer, in pixels.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>height</parameter></term>
<listitem>
<para>Specifies the height of the renderbuffer, in pixels.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 xml:id="description">
<title>Description</title>
<para><function>glRenderbufferStorageMultisample</function> and
<function>glNamedRenderbufferStorageMultisample</function> establish the
data storage, format, dimensions and number of samples of a renderbuffer
object's image.</para>
<para>For <function>glRenderbufferStorageMultisample</function>, the
target of the operation, specified by <parameter>target</parameter> must
be <constant>GL_RENDERBUFFER</constant>. For
<function>glNamedRenderbufferStorageMultisample</function>,
<parameter>renderbuffer</parameter> must be an ID of an existing
renderbuffer object. <parameter>internalformat</parameter> specifies the
internal format to be used for the renderbuffer object's storage and must
be a color-renderable, depth-renderable, or stencil-renderable format.
<parameter>width</parameter> and <parameter>height</parameter> are the
dimensions, in pixels, of the renderbuffer. Both
<parameter>width</parameter> and <parameter>height</parameter> must be
less than or equal to the value of
<constant>GL_MAX_RENDERBUFFER_SIZE</constant>.
<parameter>samples</parameter> specifies the number of samples to be used
for the renderbuffer object's image, and must be less than or equal to the
value of <constant>GL_MAX_SAMPLES</constant>. If
<parameter>internalformat</parameter> is a signed or unsigned integer
format then <parameter>samples</parameter> must be less than or equal to
the value of <constant>GL_MAX_INTEGER_SAMPLES</constant>.</para>
<para>Upon success, <function>glRenderbufferStorageMultisample</function>
and <function>glNamedRenderbufferStorageMultisample</function> delete any
existing data store for the renderbuffer image and the contents of the
data store after calling either of the functions are undefined.</para>
</refsect1>
<refsect1 xml:id="errors">
<title>Errors</title>
<para><constant>GL_INVALID_ENUM</constant> is generated by
<function>glRenderbufferStorageMultisample</function> function if
<parameter>target</parameter> is not
<constant>GL_RENDERBUFFER</constant>.</para>
<para><constant>GL_INVALID_OPERATION</constant> is generated by
<function>glNamedRenderbufferStorageMultisample</function> function if
<parameter>renderbuffer</parameter> is not the name of an existing
renderbuffer object.</para>
<para><constant>GL_INVALID_VALUE</constant> is generated if
<parameter>samples</parameter> is greater than
<constant>GL_MAX_SAMPLES</constant>.</para>
<para><constant>GL_INVALID_ENUM</constant> is generated if
<parameter>internalformat</parameter> is not a color-renderable,
depth-renderable, or stencil-renderable format.</para>
<para><constant>GL_INVALID_OPERATION</constant> is generated if
<parameter>internalformat</parameter> is a signed or unsigned integer
format and <parameter>samples</parameter> is greater than the value of
<constant>GL_MAX_INTEGER_SAMPLES</constant></para>
<para><constant>GL_INVALID_VALUE</constant> is generated if either of
<parameter>width</parameter> or <parameter>height</parameter> is negative,
or greater than the value of
<constant>GL_MAX_RENDERBUFFER_SIZE</constant>.</para>
<para><constant>GL_OUT_OF_MEMORY</constant> is generated if the GL is
unable to create a data store of the requested size.</para>
</refsect1>
<refsect1 xml:id="versions"><title>Version Support</title>
<informaltable>
<tgroup cols="13" align="left">
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="apifunchead.xml" xpointer="xpointer(/*/*)"/>
<tbody>
<row>
<entry><function>glNamedRenderbufferStorageMultisample</function></entry>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="apiversion.xml" xpointer="xpointer(/*/*[@role='45']/*)"/>
</row>
<row>
<entry><function>glRenderbufferStorageMultisample</function></entry>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="apiversion.xml" xpointer="xpointer(/*/*[@role='30']/*)"/>
</row>
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 xml:id="seealso">
<title>See Also</title>
<para><citerefentry>
<refentrytitle>glGenRenderbuffers</refentrytitle>
</citerefentry>, <citerefentry>
<refentrytitle>glBindRenderbuffer</refentrytitle>
</citerefentry>, <citerefentry>
<refentrytitle>glNamedRenderbufferStorage</refentrytitle>
</citerefentry>, <citerefentry>
<refentrytitle>glRenderbufferStorage</refentrytitle>
</citerefentry>, <citerefentry>
<refentrytitle>glFramebufferRenderbuffer</refentrytitle>
</citerefentry>, <citerefentry>
<refentrytitle>glDeleteRenderbuffers</refentrytitle>
</citerefentry></para>
</refsect1>
<refsect1 xml:id="Copyright"><title>Copyright</title>
<para>
Copyright <trademark class="copyright"/> 2010-2014 Khronos Group.
This material may be distributed subject to the terms and conditions set forth in
the Open Publication License, v 1.0, 8 June 1999.
<link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://opencontent.org/openpub/">http://opencontent.org/openpub/</link>.
</para>
</refsect1>
</refentry>
|
