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
|
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE html><html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>glFramebufferRenderbuffer - 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="glFramebufferRenderbuffer">
<div class="titlepage"/>
<div class="refnamediv">
<h2>Name</h2>
<p>glFramebufferRenderbuffer, glNamedFramebufferRenderbuffer — attach a renderbuffer as a logical buffer 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">glFramebufferRenderbuffer</strong>(</code>
</td>
<td>GLenum <var class="pdparam">target</var>, </td>
</tr>
<tr>
<td> </td>
<td>GLenum <var class="pdparam">attachment</var>, </td>
</tr>
<tr>
<td> </td>
<td>GLenum <var class="pdparam">renderbuffertarget</var>, </td>
</tr>
<tr>
<td> </td>
<td>GLuint <var class="pdparam">renderbuffer</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">glNamedFramebufferRenderbuffer</strong>(</code>
</td>
<td>GLuint <var class="pdparam">framebuffer</var>, </td>
</tr>
<tr>
<td> </td>
<td>GLenum <var class="pdparam">attachment</var>, </td>
</tr>
<tr>
<td> </td>
<td>GLenum <var class="pdparam">renderbuffertarget</var>, </td>
</tr>
<tr>
<td> </td>
<td>GLuint <var class="pdparam">renderbuffer</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">glFramebufferRenderbuffer</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">glNamedFramebufferRenderbuffer</code>.
</p>
</dd>
<dt>
<span class="term">
<em class="parameter">
<code>attachment</code>
</em>
</span>
</dt>
<dd>
<p>
Specifies the attachment point of the framebuffer.
</p>
</dd>
<dt>
<span class="term">
<em class="parameter">
<code>renderbuffertarget</code>
</em>
</span>
</dt>
<dd>
<p>
Specifies the renderbuffer target. Must be
<code class="constant">GL_RENDERBUFFER</code>.
</p>
</dd>
<dt>
<span class="term">
<em class="parameter">
<code>renderbuffer</code>
</em>
</span>
</dt>
<dd>
<p>
Specifies the name of an existing renderbuffer object of
type <em class="parameter"><code>renderbuffertarget</code></em> to
attach.
</p>
</dd>
</dl>
</div>
</div>
<div class="refsect1" id="description">
<h2>Description</h2>
<p>
<code class="function">glFramebufferRenderbuffer</code> and
<code class="function">glNamedFramebufferRenderbuffer</code> attaches a
renderbuffer as one of the logical buffers of the specified
framebuffer object. Renderbuffers cannot be attached to the
default draw and read framebuffer, so they are not valid targets
of these commands.
</p>
<p>
For <code class="function">glFramebufferRenderbuffer</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">glNamedFramebufferRenderbuffer</code>,
<em class="parameter"><code>framebuffer</code></em> is the name of the
framebuffer object.
</p>
<p>
<em class="parameter"><code>renderbuffertarget</code></em> must be
<code class="constant">GL_RENDERBUFFER</code>.
</p>
<p>
<em class="parameter"><code>renderbuffer</code></em> must be zero or the name of
an existing renderbuffer object of type
<em class="parameter"><code>renderbuffertarget</code></em>. If
<em class="parameter"><code>renderbuffer</code></em> is not zero, then the
specified renderbuffer will be used as the logical buffer
identified by <em class="parameter"><code>attachment</code></em> of the specified
framebuffer object. If <em class="parameter"><code>renderbuffer</code></em> is
zero, then the value of
<em class="parameter"><code>renderbuffertarget</code></em> is ignored.
</p>
<p>
<em class="parameter"><code>attachment</code></em> specifies the logical
attachment of the framebuffer and must be
<code class="constant">GL_COLOR_ATTACHMENT</code><span class="emphasis"><em>i</em></span>,
<code class="constant">GL_DEPTH_ATTACHMENT</code>,
<code class="constant">GL_STENCIL_ATTACHMENT</code> or
<code class="constant">GL_DEPTH_STENCIL_ATTACHMENT</code>.
<span class="emphasis"><em>i</em></span> in may range from zero to the value of
<code class="constant">GL_MAX_COLOR_ATTACHMENTS</code> minus one.
Setting <em class="parameter"><code>attachment</code></em> to the value
<code class="constant">GL_DEPTH_STENCIL_ATTACHMENT</code> is a special
case causing both the depth and stencil attachments of the
specified framebuffer object to be set to
<em class="parameter"><code>renderbuffer</code></em>, which should have the base
internal format <code class="constant">GL_DEPTH_STENCIL</code>.
</p>
<p>
The value of
<code class="constant">GL_FRAMEBUFFER_ATTACHMENT_OBJECT_TYPE</code> for
the specified attachment point is set to
<code class="constant">GL_RENDERBUFFER</code> and the value of
<code class="constant">GL_FRAMEBUFFER_ATTACHMENT_OBJECT_NAME</code> is
set to <em class="parameter"><code>renderbuffer</code></em>. All other state
values of specified attachment point are set to their default
values. No change is made to the state of the renderbuuffer
object and any previous attachment to the
<em class="parameter"><code>attachment</code></em> logical buffer of the
specified framebuffer object is broken.
</p>
<p>
If <em class="parameter"><code>renderbuffer</code></em> is zero, these commands
will detach the image, if any, identified by the specified
attachment point of the specified framebuffer object. All state
values of the attachment point are set to their default values.
</p>
</div>
<div class="refsect1" id="errors">
<h2>Errors</h2>
<p>
<code class="constant">GL_INVALID_ENUM</code> is generated by
<code class="function">glFramebufferRenderbuffer</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">glFramebufferRenderbuffer</code> if zero 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">glNamedFramebufferRenderbuffer</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_ENUM</code> is generated if
<em class="parameter"><code>attachment</code></em> is not one of the accepted
attachment points.
</p>
<p>
<code class="constant">GL_INVALID_ENUM</code> is generated if
<em class="parameter"><code>renderbuffertarget</code></em> is not
<code class="constant">GL_RENDERBUFFER</code>.
</p>
<p>
<code class="constant">GL_INVALID_OPERATION</code> is generated if
<em class="parameter"><code>renderbuffertarget</code></em> is not zero or the
name of an existing renderbuffer object of type
<code class="constant">GL_RENDERBUFFER</code>.
</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">glFramebufferRenderbuffer</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">glNamedFramebufferRenderbuffer</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="glGenFramebuffers.xhtml"><span class="citerefentry"><span class="refentrytitle">glGenFramebuffers</span></span></a>,
<a class="citerefentry" href="glBindFramebuffer.xhtml"><span class="citerefentry"><span class="refentrytitle">glBindFramebuffer</span></span></a>,
<a class="citerefentry" href="glGenRenderbuffers.xhtml"><span class="citerefentry"><span class="refentrytitle">glGenRenderbuffers</span></span></a>,
<a class="citerefentry" href="glFramebufferTexture.xhtml"><span class="citerefentry"><span class="refentrytitle">glFramebufferTexture</span></span></a>,
<a class="citerefentry" href="glFramebufferTexture1D.xhtml"><span class="citerefentry"><span class="refentrytitle">glFramebufferTexture1D</span></span></a>,
<a class="citerefentry" href="glFramebufferTexture2D.xhtml"><span class="citerefentry"><span class="refentrytitle">glFramebufferTexture2D</span></span></a>,
<a class="citerefentry" href="glFramebufferTexture3D.xhtml"><span class="citerefentry"><span class="refentrytitle">glFramebufferTexture3D</span></span></a>
</p>
</div>
<div class="refsect1" id="Copyright">
<h2>Copyright</h2>
<p>
Copyright <span class="trademark"/>© 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.
<a class="link" href="http://opencontent.org/openpub/" target="_top">http://opencontent.org/openpub/</a>.
</p>
</div>
</div>
<footer/>
</body>
</html>
|