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>glFramebufferRenderbuffer - 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="glFramebufferRenderbuffer"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>glFramebufferRenderbuffer — attach a renderbuffer as a logical buffer to the currently bound framebuffer object</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">glFramebufferRenderbuffer</b>(</code></td><td>GLenum </td><td><var class="pdparam">target</var>, </td></tr><tr><td> </td><td>GLenum </td><td><var class="pdparam">attachment</var>, </td></tr><tr><td> </td><td>GLenum </td><td><var class="pdparam">renderbuffertarget</var>, </td></tr><tr><td> </td><td>GLuint </td><td><var class="pdparam">renderbuffer</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 the framebuffer target. <em class="parameter"><code>target</code></em> must be <code class="constant">GL_DRAW_FRAMEBUFFER</code>, | |
6 | <code class="constant">GL_READ_FRAMEBUFFER</code>, or <code class="constant">GL_FRAMEBUFFER</code>. <code class="constant">GL_FRAMEBUFFER</code> | |
7 | is equivalent to <code class="constant">GL_DRAW_FRAMEBUFFER</code>. | |
8 | </p></dd><dt><span class="term"><em class="parameter"><code>attachment</code></em></span></dt><dd><p> | |
9 | Specifies the attachment point of the framebuffer. | |
10 | </p></dd><dt><span class="term"><em class="parameter"><code>renderbuffertarget</code></em></span></dt><dd><p> | |
11 | Specifies the renderbuffer target and must be <code class="constant">GL_RENDERBUFFER</code>. | |
12 | </p></dd><dt><span class="term"><em class="parameter"><code>renderbuffer</code></em></span></dt><dd><p> | |
13 | Specifies the name of an existing renderbuffer object of type <em class="parameter"><code>renderbuffertarget</code></em> to attach. | |
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">glFramebufferRenderbuffer</code> attaches a renderbuffer as one of the logical buffers of the | |
16 | currently bound framebuffer object. <em class="parameter"><code>renderbuffer</code></em> is the name of the renderbuffer object | |
17 | to attach and must be either zero, or the name of an existing renderbuffer object of type <em class="parameter"><code>renderbuffertarget</code></em>. | |
18 | If <em class="parameter"><code>renderbuffer</code></em> is not zero and if <code class="function">glFramebufferRenderbuffer</code> is | |
19 | successful, then the renderbuffer name <em class="parameter"><code>renderbuffer</code></em> will be used as the logical buffer | |
20 | identified by <em class="parameter"><code>attachment</code></em> of the framebuffer currently bound to <em class="parameter"><code>target</code></em>. | |
21 | </p><p> | |
22 | The value of <code class="constant">GL_FRAMEBUFFER_ATTACHMENT_OBJECT_TYPE</code> for the specified attachment point is | |
23 | set to <code class="constant">GL_RENDERBUFFER</code> and the value of <code class="constant">GL_FRAMEBUFFER_ATTACHMENT_OBJECT_NAME</code> | |
24 | is set to <em class="parameter"><code>renderbuffer</code></em>. All other state values of the attachment point specified by | |
25 | <em class="parameter"><code>attachment</code></em> are set to their default values. No change is made to the state of the renderbuuffer | |
26 | object and any previous attachment to the <em class="parameter"><code>attachment</code></em> logical buffer of the framebuffer | |
27 | <em class="parameter"><code>target</code></em> is broken. | |
28 | </p><p> | |
29 | Calling <code class="function">glFramebufferRenderbuffer</code> with the renderbuffer name zero will detach the image, if any, | |
30 | identified by <em class="parameter"><code>attachment</code></em>, in the framebuffer currently bound to <em class="parameter"><code>target</code></em>. | |
31 | All state values of the attachment point specified by attachment in the object bound to target are set to their default values. | |
32 | </p><p> | |
33 | Setting <em class="parameter"><code>attachment</code></em> to the value <code class="constant">GL_DEPTH_STENCIL_ATTACHMENT</code> is a special | |
34 | case causing both the depth and stencil attachments of the framebuffer object to be set to <em class="parameter"><code>renderbuffer</code></em>, | |
35 | which should have the base internal format <code class="constant">GL_DEPTH_STENCIL</code>. | |
36 | </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="errors"></a><h2>Errors</h2><p> | |
37 | <code class="constant">GL_INVALID_ENUM</code> is generated if <em class="parameter"><code>target</code></em> is not one of the accepted tokens. | |
38 | </p><p> | |
39 | <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>. | |
40 | </p><p> | |
41 | <code class="constant">GL_INVALID_OPERATION</code> is generated if zero is bound to <em class="parameter"><code>target</code></em>. | |
42 | </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="seealso"></a><h2>See Also</h2><p> | |
43 | <a href="glGenFramebuffers.xml"><span class="citerefentry"><span class="refentrytitle">glGenFramebuffers</span></span></a>, | |
44 | <a href="glBindFramebuffer.xml"><span class="citerefentry"><span class="refentrytitle">glBindFramebuffer</span></span></a>, | |
45 | <a href="glGenRenderbuffers.xml"><span class="citerefentry"><span class="refentrytitle">glGenRenderbuffers</span></span></a>, | |
46 | <a href="glFramebufferTexture.xml"><span class="citerefentry"><span class="refentrytitle">glFramebufferTexture</span></span></a>, | |
47 | <a href="glFramebufferTexture1D.xml"><span class="citerefentry"><span class="refentrytitle">glFramebufferTexture1D</span></span></a>, | |
48 | <a href="glFramebufferTexture2D.xml"><span class="citerefentry"><span class="refentrytitle">glFramebufferTexture2D</span></span></a>, | |
49 | <a href="glFramebufferTexture3D.xml"><span class="citerefentry"><span class="refentrytitle">glFramebufferTexture3D</span></span></a> | |
50 | </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="Copyright"></a><h2>Copyright</h2><p> | |
51 | Copyright <span class="trademark"></span>© 2010 Khronos Group. | |
52 | This material may be distributed subject to the terms and conditions set forth in | |
53 | the Open Publication License, v 1.0, 8 June 1999. | |
54 | <a href="http://opencontent.org/openpub/" target="_top">http://opencontent.org/openpub/</a>. | |
55 | </p></div></div></body></html> |