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=
"glFramebufferRenderbuffer">
9 <holder>Khronos Group
</holder>
12 <refentrytitle>glFramebufferRenderbuffer
</refentrytitle>
13 <manvolnum>3G
</manvolnum>
16 <refname>glFramebufferRenderbuffer
</refname>
17 <refpurpose>attach a renderbuffer as a logical buffer to the currently bound framebuffer object
</refpurpose>
19 <refsynopsisdiv><title>C Specification
</title>
22 <funcdef>void
<function>glFramebufferRenderbuffer
</function></funcdef>
23 <paramdef>GLenum
<parameter>target
</parameter></paramdef>
24 <paramdef>GLenum
<parameter>attachment
</parameter></paramdef>
25 <paramdef>GLenum
<parameter>renderbuffertarget
</parameter></paramdef>
26 <paramdef>GLuint
<parameter>renderbuffer
</parameter></paramdef>
30 <!-- eqn: ignoring delim $$ -->
31 <refsect1 id=
"parameters"><title>Parameters
</title>
34 <term><parameter>target
</parameter></term>
37 Specifies the framebuffer target.
<parameter>target
</parameter> must be
<constant>GL_DRAW_FRAMEBUFFER
</constant>,
38 <constant>GL_READ_FRAMEBUFFER
</constant>, or
<constant>GL_FRAMEBUFFER
</constant>.
<constant>GL_FRAMEBUFFER
</constant>
39 is equivalent to
<constant>GL_DRAW_FRAMEBUFFER
</constant>.
44 <term><parameter>attachment
</parameter></term>
47 Specifies the attachment point of the framebuffer.
52 <term><parameter>renderbuffertarget
</parameter></term>
55 Specifies the renderbuffer target and must be
<constant>GL_RENDERBUFFER
</constant>.
60 <term><parameter>renderbuffer
</parameter></term>
63 Specifies the name of an existing renderbuffer object of type
<parameter>renderbuffertarget
</parameter> to attach.
69 <refsect1 id=
"description"><title>Description
</title>
71 <function>glFramebufferRenderbuffer
</function> attaches a renderbuffer as one of the logical buffers of the
72 currently bound framebuffer object.
<parameter>renderbuffer
</parameter> is the name of the renderbuffer object
73 to attach and must be either zero, or the name of an existing renderbuffer object of type
<parameter>renderbuffertarget
</parameter>.
74 If
<parameter>renderbuffer
</parameter> is not zero and if
<function>glFramebufferRenderbuffer
</function> is
75 successful, then the renderbuffer name
<parameter>renderbuffer
</parameter> will be used as the logical buffer
76 identified by
<parameter>attachment
</parameter> of the framebuffer currently bound to
<parameter>target
</parameter>.
79 The value of
<constant>GL_FRAMEBUFFER_ATTACHMENT_OBJECT_TYPE
</constant> for the specified attachment point is
80 set to
<constant>GL_RENDERBUFFER
</constant> and the value of
<constant>GL_FRAMEBUFFER_ATTACHMENT_OBJECT_NAME
</constant>
81 is set to
<parameter>renderbuffer
</parameter>. All other state values of the attachment point specified by
82 <parameter>attachment
</parameter> are set to their default values. No change is made to the state of the renderbuuffer
83 object and any previous attachment to the
<parameter>attachment
</parameter> logical buffer of the framebuffer
84 <parameter>target
</parameter> is broken.
87 Calling
<function>glFramebufferRenderbuffer
</function> with the renderbuffer name zero will detach the image, if any,
88 identified by
<parameter>attachment
</parameter>, in the framebuffer currently bound to
<parameter>target
</parameter>.
89 All state values of the attachment point specified by attachment in the object bound to target are set to their default values.
92 Setting
<parameter>attachment
</parameter> to the value
<constant>GL_DEPTH_STENCIL_ATTACHMENT
</constant> is a special
93 case causing both the depth and stencil attachments of the framebuffer object to be set to
<parameter>renderbuffer
</parameter>,
94 which should have the base internal format
<constant>GL_DEPTH_STENCIL
</constant>.
97 <refsect1 id=
"errors"><title>Errors
</title>
99 <constant>GL_INVALID_ENUM
</constant> is generated if
<parameter>target
</parameter> is not one of the accepted tokens.
102 <constant>GL_INVALID_ENUM
</constant> is generated if
<parameter>renderbuffertarget
</parameter> is not
<constant>GL_RENDERBUFFER
</constant>.
105 <constant>GL_INVALID_OPERATION
</constant> is generated if zero is bound to
<parameter>target
</parameter>.
108 <refsect1 id=
"seealso"><title>See Also
</title>
110 <citerefentry><refentrytitle>glGenFramebuffers
</refentrytitle></citerefentry>,
111 <citerefentry><refentrytitle>glBindFramebuffer
</refentrytitle></citerefentry>,
112 <citerefentry><refentrytitle>glGenRenderbuffers
</refentrytitle></citerefentry>,
113 <citerefentry><refentrytitle>glFramebufferTexture
</refentrytitle></citerefentry>,
114 <citerefentry><refentrytitle>glFramebufferTexture1D
</refentrytitle></citerefentry>,
115 <citerefentry><refentrytitle>glFramebufferTexture2D
</refentrytitle></citerefentry>,
116 <citerefentry><refentrytitle>glFramebufferTexture3D
</refentrytitle></citerefentry>
119 <refsect1 id=
"Copyright"><title>Copyright
</title>
121 Copyright
<trademark class=
"copyright"></trademark> 2010 Khronos Group.
122 This material may be distributed subject to the terms and conditions set forth in
123 the Open Publication License, v
1.0,
8 June
1999.
124 <ulink url=
"http://opencontent.org/openpub/">http://opencontent.org/openpub/
</ulink>.