forked from BSVino/docs.gl
-
Notifications
You must be signed in to change notification settings - Fork 0
/
glBindFramebuffer.xhtml
39 lines (39 loc) · 5.51 KB
/
glBindFramebuffer.xhtml
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
<div class="refentry"><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 class="funcprototype-table" style="cellspacing: 0; cellpadding: 0;"><tr><td><code class="funcdef">void <strong class="fsfunc">glBindFramebuffer</strong>(</code></td><td>GLenum <var class="pdparam">target</var>, </td></tr><tr><td> </td><td>GLuint <var class="pdparam">framebuffer</var><code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div></div></div><div class="refsect1"><a id="parameters"></a><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 framebuffer target of the binding operation.
</p></dd><dt><span class="term"><em class="parameter"><code>framebuffer</code></em></span></dt><dd><p>
Specifies the name of the framebuffer object to bind.
</p></dd></dl></div></div><div class="refsect1"><a id="description"></a><h2>Description</h2><p>
<code class="function">glBindFramebuffer</code> binds the framebuffer object with name <em class="parameter"><code>framebuffer</code></em> to the framebuffer target specified
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>,
<code class="constant">GL_READ_FRAMEBUFFER</code> or <code class="constant">GL_FRAMEBUFFER</code>. If a framebuffer object is bound to
<code class="constant">GL_DRAW_FRAMEBUFFER</code> or <code class="constant">GL_READ_FRAMEBUFFER</code>, it becomes the target for
rendering or readback operations, respectively, until it is deleted or another framebuffer is bound to the corresponding bind point.
Calling <code class="function">glBindFramebuffer</code> with <em class="parameter"><code>target</code></em> set to <code class="constant">GL_FRAMEBUFFER</code> binds
<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
object previously returned from a call to <a class="citerefentry" href="glGenFramebuffers"><span class="citerefentry"><span class="refentrytitle">glGenFramebuffers</span></span></a>, or zero to break the existing
binding of a framebuffer object to <em class="parameter"><code>target</code></em>.
</p></div><div class="refsect1"><a id="errors"></a><h2>Errors</h2><p>
<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>,
<code class="constant">GL_READ_FRAMEBUFFER</code> or <code class="constant">GL_FRAMEBUFFER</code>.
</p><p>
<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
previously returned from a call to <a class="citerefentry" href="glGenFramebuffers"><span class="citerefentry"><span class="refentrytitle">glGenFramebuffers</span></span></a>.
</p></div>
{$pipelinestall}{$examples}
<div class="refsect1"><a id="seealso"></a><h2>See Also</h2><p>
<a class="citerefentry" href="glGenFramebuffers"><span class="citerefentry"><span class="refentrytitle">glGenFramebuffers</span></span></a>,
<a class="citerefentry" href="glDeleteFramebuffers"><span class="citerefentry"><span class="refentrytitle">glDeleteFramebuffers</span></span></a>,
<a class="citerefentry" href="glFramebufferRenderbuffer"><span class="citerefentry"><span class="refentrytitle">glFramebufferRenderbuffer</span></span></a>,
<a class="citerefentry" href="glFramebufferTexture"><span class="citerefentry"><span class="refentrytitle">glFramebufferTexture</span></span></a>,
<a class="citerefentry" href="glFramebufferTexture1D"><span class="citerefentry"><span class="refentrytitle">glFramebufferTexture1D</span></span></a>,
<a class="citerefentry" href="glFramebufferTexture2D"><span class="citerefentry"><span class="refentrytitle">glFramebufferTexture2D</span></span></a>,
<a class="citerefentry" href="glFramebufferTexture3D"><span class="citerefentry"><span class="refentrytitle">glFramebufferTexture3D</span></span></a>,
<a class="citerefentry" href="glFramebufferTextureFace"><span class="citerefentry"><span class="refentrytitle">glFramebufferTextureFace</span></span></a>,
<a class="citerefentry" href="glFramebufferTextureLayer"><span class="citerefentry"><span class="refentrytitle">glFramebufferTextureLayer</span></span></a>,
<a class="citerefentry" href="glIsFramebuffer"><span class="citerefentry"><span class="refentrytitle">glIsFramebuffer</span></span></a>
</p></div><div class="refsect1"><div id="Copyright"><h2>Copyright</h2><p>
Copyright © 2010 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="ulink" href="https://opencontent.org/openpub/" target="_top">https://opencontent.org/openpub/</a>.
</p></div></div></div>