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 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413
|
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE html><html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>glFramebufferParameteri - OpenGL 4 Reference Pages</title>
<link rel="stylesheet" type="text/css" href="opengl-man.css"/>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1"/>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
MathML: {
extensions: ["content-mathml.js"]
},
tex2jax: {
inlineMath: [['$','$'], ['\\(','\\)']]
}
});
</script>
<script type="text/javascript" src="https://c328740.ssl.cf1.rackcdn.com/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"/>
</head>
<body>
<header/>
<div class="refentry" id="glFramebufferParameteri">
<div class="titlepage"/>
<div class="refnamediv">
<h2>Name</h2>
<p>glFramebufferParameteri, glNamedFramebufferParameteri — set a named parameter of a framebuffer object</p>
</div>
<div class="refsynopsisdiv">
<h2>C Specification</h2>
<div class="funcsynopsis">
<table style="border: 0; cellspacing: 0; cellpadding: 0;" class="funcprototype-table">
<tr>
<td>
<code class="funcdef">void <strong class="fsfunc">glFramebufferParameteri</strong>(</code>
</td>
<td>GLenum <var class="pdparam">target</var>, </td>
</tr>
<tr>
<td> </td>
<td>GLenum <var class="pdparam">pname</var>, </td>
</tr>
<tr>
<td> </td>
<td>GLint <var class="pdparam">param</var><code>)</code>;</td>
</tr>
</table>
<div class="funcprototype-spacer"> </div>
<table style="border: 0; cellspacing: 0; cellpadding: 0;" class="funcprototype-table">
<tr>
<td>
<code class="funcdef">void <strong class="fsfunc">glNamedFramebufferParameteri</strong>(</code>
</td>
<td>GLuint <var class="pdparam">framebuffer</var>, </td>
</tr>
<tr>
<td> </td>
<td>GLenum <var class="pdparam">pname</var>, </td>
</tr>
<tr>
<td> </td>
<td>GLint <var class="pdparam">param</var><code>)</code>;</td>
</tr>
</table>
<div class="funcprototype-spacer"> </div>
</div>
</div>
<div class="refsect1" id="parameters">
<h2>Parameters</h2>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<em class="parameter">
<code>target</code>
</em>
</span>
</dt>
<dd>
<p>
Specifies the target to which the framebuffer is bound
for <code class="function">glFramebufferParameteri</code>.
</p>
</dd>
<dt>
<span class="term">
<em class="parameter">
<code>framebuffer</code>
</em>
</span>
</dt>
<dd>
<p>
Specifies the name of the framebuffer object for
<code class="function">glNamedFramebufferParameteri</code>.
</p>
</dd>
<dt>
<span class="term">
<em class="parameter">
<code>pname</code>
</em>
</span>
</dt>
<dd>
<p>
Specifies the framebuffer parameter to be modified.
</p>
</dd>
<dt>
<span class="term">
<em class="parameter">
<code>param</code>
</em>
</span>
</dt>
<dd>
<p>
The new value for the parameter named
<em class="parameter"><code>pname</code></em>.
</p>
</dd>
</dl>
</div>
</div>
<div class="refsect1" id="description">
<h2>Description</h2>
<p>
<code class="function">glFramebufferParameteri</code> and
<code class="function">glNamedFramebufferParameteri</code> modify the
value of the parameter named <em class="parameter"><code>pname</code></em> in the
specified framebuffer object. There are no modifiable parameters
of the default draw and read framebuffer, so they are not valid
targets of these commands.
</p>
<p>
For <code class="function">glFramebufferParameteri</code>,
the framebuffer object is that bound to
<em class="parameter"><code>target</code></em>, which must be
<code class="constant">GL_DRAW_FRAMEBUFFER</code>,
<code class="constant">GL_READ_FRAMEBUFFER</code> or
<code class="constant">GL_FRAMEBUFFER</code>.
<code class="constant">GL_FRAMEBUFFER</code> is equivalent to
<code class="constant">GL_DRAW_FRAMEBUFFER</code>.
</p>
<p>
For <code class="function">glNamedFramebufferParameteri</code>,
<em class="parameter"><code>framebuffer</code></em> is the name of the
framebuffer object.
</p>
<p>
<em class="parameter"><code>pname</code></em> specifies the parameter to be
modified. The following values are accepted:
</p>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="constant">GL_FRAMEBUFFER_DEFAULT_WIDTH</code>
</span>
</dt>
<dd>
<p>
<em class="parameter"><code>param</code></em> specifies the assumed with for a framebuffer object with no attachments. If a
framebuffer has attachments then the width of those attachments is used, otherwise
the value of <code class="constant">GL_FRAMEBUFFER_DEFAULT_WIDTH</code> is used for the
framebuffer. <em class="parameter"><code>param</code></em> must be greater than or equal to zero and less than
or equal to the value of <code class="constant">GL_MAX_FRAMEBUFFER_WIDTH</code>.
</p>
</dd>
<dt>
<span class="term">
<code class="constant">GL_FRAMEBUFFER_DEFAULT_HEIGHT</code>
</span>
</dt>
<dd>
<p>
<em class="parameter"><code>param</code></em> specifies the assumed height for a framebuffer object with no attachments. If a
framebuffer has attachments then the height of those attachments is used, otherwise
the value of <code class="constant">GL_FRAMEBUFFER_DEFAULT_HEIGHT</code> is used for the
framebuffer. <em class="parameter"><code>param</code></em> must be greater than or equal to zero and less than
or equal to the value of <code class="constant">GL_MAX_FRAMEBUFFER_HEIGHT</code>.
</p>
</dd>
<dt>
<span class="term">
<code class="constant">GL_FRAMEBUFFER_DEFAULT_LAYERS</code>
</span>
</dt>
<dd>
<p>
<em class="parameter"><code>param</code></em> specifies the assumed number of layers for a framebuffer object with no attachments. If a
framebuffer has attachments then the layer count of those attachments is used, otherwise
the value of <code class="constant">GL_FRAMEBUFFER_DEFAULT_LAYERS</code> is used for the
framebuffer. <em class="parameter"><code>param</code></em> must be greater than or equal to zero and less than
or equal to the value of <code class="constant">GL_MAX_FRAMEBUFFER_LAYERS</code>.
</p>
</dd>
<dt>
<span class="term">
<code class="constant">GL_FRAMEBUFFER_DEFAULT_SAMPLES</code>
</span>
</dt>
<dd>
<p>
<em class="parameter"><code>param</code></em> specifies the assumed number of samples in a framebuffer object with no attachments. If a
framebuffer has attachments then the sample count of those attachments is used, otherwise
the value of <code class="constant">GL_FRAMEBUFFER_DEFAULT_SAMPLES</code> is used for the
framebuffer. <em class="parameter"><code>param</code></em> must be greater than or equal to zero and less than
or equal to the value of <code class="constant">GL_MAX_FRAMEBUFFER_SAMPLE</code>.
</p>
</dd>
<dt>
<span class="term">
<code class="constant">GL_FRAMEBUFFER_DEFAULT_FIXED_SAMPLE_LOCATIONS</code>
</span>
</dt>
<dd>
<p>
<em class="parameter"><code>param</code></em> specifies whether the framebuffer should assume identical sample locations and
the same number of samples for all texels in the virtual image. If <em class="parameter"><code>param</code></em> is zero,
then the implementation may vary the position or the count of samples within the virtual image from
pixel to pixel, otherwise it will use the same sample position and count for all pixels in the virtual image.
</p>
</dd>
</dl>
</div>
</div>
<div class="refsect1" id="errors">
<h2>Errors</h2>
<p>
<code class="constant">GL_INVALID_ENUM</code> is generated by
<code class="function">glFramebufferParameteri</code> if
<em class="parameter"><code>target</code></em> is not one of the accepted
framebuffer targets.
</p>
<p>
<code class="constant">GL_INVALID_OPERATION</code> is generated by
<code class="function">glFramebufferParameteri</code> if the default
framebuffer is bound to <em class="parameter"><code>target</code></em>.
</p>
<p>
<code class="constant">GL_INVALID_OPERATION</code> is generated by
<code class="function">glNamedFramebufferParameteri</code> if
<em class="parameter"><code>framebuffer</code></em> is not the name of an
existing framebuffer object.
</p>
<p>
<code class="constant">GL_INVALID_VALUE</code> is generated if
<em class="parameter"><code>pname</code></em> is
<code class="constant">GL_FRAMEBUFFER_DEFAULT_WIDTH</code> and
<em class="parameter"><code>param</code></em> is less than zero or greater than
the value of <code class="constant">GL_MAX_FRAMEBUFFER_WIDTH</code>.
</p>
<p>
<code class="constant">GL_INVALID_VALUE</code> is generated if
<em class="parameter"><code>pname</code></em> is
<code class="constant">GL_FRAMEBUFFER_DEFAULT_HEIGHT</code> and
<em class="parameter"><code>param</code></em> is less than zero or greater than
the value of <code class="constant">GL_MAX_FRAMEBUFFER_HEIGHT</code>.
</p>
<p>
<code class="constant">GL_INVALID_VALUE</code> is generated if
<em class="parameter"><code>pname</code></em> is
<code class="constant">GL_FRAMEBUFFER_DEFAULT_LAYERS</code> and
<em class="parameter"><code>param</code></em> is less than zero or greater than
the value of <code class="constant">GL_MAX_FRAMEBUFFER_LAYERS</code>.
</p>
<p>
<code class="constant">GL_INVALID_VALUE</code> is generated if
<em class="parameter"><code>pname</code></em> is
<code class="constant">GL_FRAMEBUFFER_DEFAULT_SAMPLES</code> and
<em class="parameter"><code>param</code></em> is less than zero or greater than
the value of <code class="constant">GL_MAX_FRAMEBUFFER_SAMPLES</code>.
</p>
</div>
<div class="refsect1" id="associatedgets">
<h2>Associated Gets</h2>
<p>
<a class="citerefentry" href="glGetFramebufferParameteriv.xhtml"><span class="citerefentry"><span class="refentrytitle">glGetFramebufferParameteriv</span></span></a>.
</p>
</div>
<div class="refsect1" id="versions">
<h2>Version Support</h2>
<div class="informaltable">
<table style="border-collapse: collapse; border-top: 2px solid ; border-bottom: 2px solid ; border-left: 2px solid ; border-right: 2px solid ; ">
<colgroup>
<col style="text-align: left; "/>
<col style="text-align: center; " class="firstvers"/>
<col style="text-align: center; "/>
<col style="text-align: center; "/>
<col style="text-align: center; "/>
<col style="text-align: center; "/>
<col style="text-align: center; "/>
<col style="text-align: center; "/>
<col style="text-align: center; "/>
<col style="text-align: center; "/>
<col style="text-align: center; "/>
<col style="text-align: center; "/>
<col style="text-align: center; " class="lastvers"/>
</colgroup>
<thead>
<tr>
<th style="text-align: left; border-right: 2px solid ; ">
</th>
<th style="text-align: center; border-bottom: 2px solid ; " colspan="12">
<span class="bold"><strong>OpenGL Version</strong></span>
</th>
</tr>
<tr>
<th style="text-align: left; border-right: 2px solid ; border-bottom: 2px solid ; ">
<span class="bold"><strong>Function / Feature Name</strong></span>
</th>
<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
<span class="bold"><strong>2.0</strong></span>
</th>
<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
<span class="bold"><strong>2.1</strong></span>
</th>
<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
<span class="bold"><strong>3.0</strong></span>
</th>
<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
<span class="bold"><strong>3.1</strong></span>
</th>
<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
<span class="bold"><strong>3.2</strong></span>
</th>
<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
<span class="bold"><strong>3.3</strong></span>
</th>
<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
<span class="bold"><strong>4.0</strong></span>
</th>
<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
<span class="bold"><strong>4.1</strong></span>
</th>
<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
<span class="bold"><strong>4.2</strong></span>
</th>
<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
<span class="bold"><strong>4.3</strong></span>
</th>
<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
<span class="bold"><strong>4.4</strong></span>
</th>
<th style="text-align: center; border-bottom: 2px solid ; ">
<span class="bold"><strong>4.5</strong></span>
</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left; border-right: 2px solid ; border-bottom: 2px solid ; ">
<code class="function">glFramebufferParameteri</code>
</td>
<td style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">-</td>
<td style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">-</td>
<td style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">-</td>
<td style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">-</td>
<td style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">-</td>
<td style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">-</td>
<td style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">-</td>
<td style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">-</td>
<td style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">-</td>
<td style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">✔</td>
<td style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">✔</td>
<td style="text-align: center; border-bottom: 2px solid ; ">✔</td>
</tr>
<tr>
<td style="text-align: left; border-right: 2px solid ; ">
<code class="function">glNamedFramebufferParameteri</code>
</td>
<td style="text-align: center; border-right: 2px solid ; ">-</td>
<td style="text-align: center; border-right: 2px solid ; ">-</td>
<td style="text-align: center; border-right: 2px solid ; ">-</td>
<td style="text-align: center; border-right: 2px solid ; ">-</td>
<td style="text-align: center; border-right: 2px solid ; ">-</td>
<td style="text-align: center; border-right: 2px solid ; ">-</td>
<td style="text-align: center; border-right: 2px solid ; ">-</td>
<td style="text-align: center; border-right: 2px solid ; ">-</td>
<td style="text-align: center; border-right: 2px solid ; ">-</td>
<td style="text-align: center; border-right: 2px solid ; ">-</td>
<td style="text-align: center; border-right: 2px solid ; ">-</td>
<td style="text-align: center; ">✔</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="refsect1" id="seealso">
<h2>See Also</h2>
<p>
<a class="citerefentry" href="glBindFramebuffer.xhtml"><span class="citerefentry"><span class="refentrytitle">glBindFramebuffer</span></span></a>,
<a class="citerefentry" href="glCreateFramebuffers.xhtml"><span class="citerefentry"><span class="refentrytitle">glCreateFramebuffers</span></span></a>,
<a class="citerefentry" href="glFramebufferRenderbuffer.xhtml"><span class="citerefentry"><span class="refentrytitle">glFramebufferRenderbuffer</span></span></a>,
<a class="citerefentry" href="glFramebufferTexture.xhtml"><span class="citerefentry"><span class="refentrytitle">glFramebufferTexture</span></span></a>,
<a class="citerefentry" href="glGenFramebuffers.xhtml"><span class="citerefentry"><span class="refentrytitle">glGenFramebuffers</span></span></a>,
<a class="citerefentry" href="glGetFramebufferParameter.xhtml"><span class="citerefentry"><span class="refentrytitle">glGetFramebufferParameter</span></span></a>
</p>
</div>
<div class="refsect1" id="Copyright">
<h2>Copyright</h2>
<p>
Copyright <span class="trademark"/>© 2013-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.
<a class="link" href="http://opencontent.org/openpub/" target="_top">http://opencontent.org/openpub/</a>.
</p>
</div>
</div>
<footer/>
</body>
</html>
|