rename upstream-man-pages to upstream-doc
[clinton/guile-figl.git] / upstream-doc / man4 / xhtml / glBindFramebuffer.xml
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>glBindFramebuffer - 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="glBindFramebuffer"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>glBindFramebuffer — bind a framebuffer to a framebuffer target</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">glBindFramebuffer</b>(</code></td><td>GLenum  </td><td><var class="pdparam">target</var>, </td></tr><tr><td> </td><td>GLuint  </td><td><var class="pdparam">framebuffer</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 of the binding operation.
6 </p></dd><dt><span class="term"><em class="parameter"><code>framebuffer</code></em></span></dt><dd><p>
7 Specifies the name of the framebuffer object to bind.
8 </p></dd></dl></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="description"></a><h2>Description</h2><p>
9 <code class="function">glBindFramebuffer</code> binds the framebuffer object with name <em class="parameter"><code>framebuffer</code></em> to the framebuffer target specified
10 by <em class="parameter"><code>target</code></em>. <em class="parameter"><code>target</code></em> must be either <code class="constant">GL_DRAW_FRAMEBUFFER</code>,
11 <code class="constant">GL_READ_FRAMEBUFFER</code> or <code class="constant">GL_FRAMEBUFFER</code>. If a framebuffer object is bound to
12 <code class="constant">GL_DRAW_FRAMEBUFFER</code> or <code class="constant">GL_READ_FRAMEBUFFER</code>, it becomes the target for
13 rendering or readback operations, respectively, until it is deleted or another framebuffer is bound to the corresponding bind point.
14 Calling <code class="function">glBindFramebuffer</code> with <em class="parameter"><code>target</code></em> set to <code class="constant">GL_FRAMEBUFFER</code> binds
15 <em class="parameter"><code>framebuffer</code></em> to both the read and draw framebuffer targets. <em class="parameter"><code>framebuffer</code></em> is the name of a framebuffer
16 object previously returned from a call to <a href="glGenFramebuffers.xml"><span class="citerefentry"><span class="refentrytitle">glGenFramebuffers</span></span></a>, or zero to break the existing
17 binding of a framebuffer object to <em class="parameter"><code>target</code></em>.
18 </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="errors"></a><h2>Errors</h2><p>
19 <code class="constant">GL_INVALID_ENUM</code> is generated if <em class="parameter"><code>target</code></em> is not <code class="constant">GL_DRAW_FRAMEBUFFER</code>,
20 <code class="constant">GL_READ_FRAMEBUFFER</code> or <code class="constant">GL_FRAMEBUFFER</code>.
21 </p><p>
22 <code class="constant">GL_INVALID_OPERATION</code> is generated if <em class="parameter"><code>framebuffer</code></em> is not zero or the name of a framebuffer
23 previously returned from a call to <a href="glGenFramebuffers.xml"><span class="citerefentry"><span class="refentrytitle">glGenFramebuffers</span></span></a>.
24 </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="seealso"></a><h2>See Also</h2><p>
25 <a href="glGenFramebuffers.xml"><span class="citerefentry"><span class="refentrytitle">glGenFramebuffers</span></span></a>,
26 <a href="glDeleteFramebuffers.xml"><span class="citerefentry"><span class="refentrytitle">glDeleteFramebuffers</span></span></a>,
27 <a href="glFramebufferRenderbuffer.xml"><span class="citerefentry"><span class="refentrytitle">glFramebufferRenderbuffer</span></span></a>,
28 <a href="glFramebufferTexture.xml"><span class="citerefentry"><span class="refentrytitle">glFramebufferTexture</span></span></a>,
29 <a href="glFramebufferTexture1D.xml"><span class="citerefentry"><span class="refentrytitle">glFramebufferTexture1D</span></span></a>,
30 <a href="glFramebufferTexture2D.xml"><span class="citerefentry"><span class="refentrytitle">glFramebufferTexture2D</span></span></a>,
31 <a href="glFramebufferTexture3D.xml"><span class="citerefentry"><span class="refentrytitle">glFramebufferTexture3D</span></span></a>,
32 <a href="glFramebufferTextureFace.xml"><span class="citerefentry"><span class="refentrytitle">glFramebufferTextureFace</span></span></a>,
33 <a href="glFramebufferTextureLayer.xml"><span class="citerefentry"><span class="refentrytitle">glFramebufferTextureLayer</span></span></a>,
34 <a href="glIsFramebuffer.xml"><span class="citerefentry"><span class="refentrytitle">glIsFramebuffer</span></span></a>
35 </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="Copyright"></a><h2>Copyright</h2><p>
36 Copyright <span class="trademark"></span>© 2010 Khronos Group.
37 This material may be distributed subject to the terms and conditions set forth in
38 the Open Publication License, v 1.0, 8 June 1999.
39 <a href="http://opencontent.org/openpub/" target="_top">http://opencontent.org/openpub/</a>.
40 </p></div></div></body></html>