1 <?xml version=
"1.0" encoding=
"UTF-8"?>
2 <!DOCTYPE book PUBLIC
"-//OASIS//DTD DocBook MathML Module V1.1b1//EN"
3 "http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd">
4 <refentry id=
"glBindFramebuffer">
9 <holder>Khronos Group
</holder>
12 <refentrytitle>glBindFramebuffer
</refentrytitle>
13 <manvolnum>3G
</manvolnum>
16 <refname>glBindFramebuffer
</refname>
17 <refpurpose>bind a framebuffer to a framebuffer target
</refpurpose>
19 <refsynopsisdiv><title>C Specification
</title>
22 <funcdef>void
<function>glBindFramebuffer
</function></funcdef>
23 <paramdef>GLenum
<parameter>target
</parameter></paramdef>
24 <paramdef>GLuint
<parameter>framebuffer
</parameter></paramdef>
28 <refsect1 id=
"parameters"><title>Parameters
</title>
31 <term><parameter>target
</parameter></term>
34 Specifies the framebuffer target of the binding operation.
39 <term><parameter>framebuffer
</parameter></term>
42 Specifies the name of the framebuffer object to bind.
48 <refsect1 id=
"description"><title>Description
</title>
50 <function>glBindFramebuffer
</function> binds the framebuffer object with name
<parameter>framebuffer
</parameter> to the framebuffer target specified
51 by
<parameter>target
</parameter>.
<parameter>target
</parameter> must be either
<constant>GL_DRAW_FRAMEBUFFER
</constant>,
52 <constant>GL_READ_FRAMEBUFFER
</constant> or
<constant>GL_FRAMEBUFFER
</constant>. If a framebuffer object is bound to
53 <constant>GL_DRAW_FRAMEBUFFER
</constant> or
<constant>GL_READ_FRAMEBUFFER
</constant>, it becomes the target for
54 rendering or readback operations, respectively, until it is deleted or another framebuffer is bound to the corresponding bind point.
55 Calling
<function>glBindFramebuffer
</function> with
<parameter>target
</parameter> set to
<constant>GL_FRAMEBUFFER
</constant> binds
56 <parameter>framebuffer
</parameter> to both the read and draw framebuffer targets.
<parameter>framebuffer
</parameter> is the name of a framebuffer
57 object previously returned from a call to
<citerefentry><refentrytitle>glGenFramebuffers
</refentrytitle></citerefentry>, or zero to break the existing
58 binding of a framebuffer object to
<parameter>target
</parameter>.
61 <refsect1 id=
"errors"><title>Errors
</title>
63 <constant>GL_INVALID_ENUM
</constant> is generated if
<parameter>target
</parameter> is not
<constant>GL_DRAW_FRAMEBUFFER
</constant>,
64 <constant>GL_READ_FRAMEBUFFER
</constant> or
<constant>GL_FRAMEBUFFER
</constant>.
67 <constant>GL_INVALID_OPERATION
</constant> is generated if
<parameter>framebuffer
</parameter> is not zero or the name of a framebuffer
68 previously returned from a call to
<citerefentry><refentrytitle>glGenFramebuffers
</refentrytitle></citerefentry>.
71 <refsect1 id=
"seealso"><title>See Also
</title>
73 <citerefentry><refentrytitle>glGenFramebuffers
</refentrytitle></citerefentry>,
74 <citerefentry><refentrytitle>glDeleteFramebuffers
</refentrytitle></citerefentry>,
75 <citerefentry><refentrytitle>glFramebufferRenderbuffer
</refentrytitle></citerefentry>,
76 <citerefentry><refentrytitle>glFramebufferTexture
</refentrytitle></citerefentry>,
77 <citerefentry><refentrytitle>glFramebufferTexture1D
</refentrytitle></citerefentry>,
78 <citerefentry><refentrytitle>glFramebufferTexture2D
</refentrytitle></citerefentry>,
79 <citerefentry><refentrytitle>glFramebufferTexture3D
</refentrytitle></citerefentry>,
80 <citerefentry><refentrytitle>glFramebufferTextureFace
</refentrytitle></citerefentry>,
81 <citerefentry><refentrytitle>glFramebufferTextureLayer
</refentrytitle></citerefentry>,
82 <citerefentry><refentrytitle>glIsFramebuffer
</refentrytitle></citerefentry>
85 <refsect1 id=
"Copyright"><title>Copyright
</title>
87 Copyright
<trademark class=
"copyright"></trademark> 2010 Khronos Group.
88 This material may be distributed subject to the terms and conditions set forth in
89 the Open Publication License, v
1.0,
8 June
1999.
90 <ulink url=
"http://opencontent.org/openpub/">http://opencontent.org/openpub/
</ulink>.